Class: Google::Apis::DisplayvideoV1::Invoice

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/displayvideo_v1/classes.rb,
lib/google/apis/displayvideo_v1/representations.rb,
lib/google/apis/displayvideo_v1/representations.rb

Overview

A single invoice.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Invoice

Returns a new instance of Invoice.



5645
5646
5647
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5645

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#budget_invoice_grouping_id ⇒ String

The budget grouping ID for this invoice. This field will only be set if the invoice level of the corresponding billing profile was set to "Budget invoice grouping ID". Corresponds to the JSON property budgetInvoiceGroupingId

Returns:

  • (String) 


5513
5514
5515
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5513

def budget_invoice_grouping_id
  @budget_invoice_grouping_id
end

#budget_summaries ⇒ Array<Google::Apis::DisplayvideoV1::BudgetSummary>

The list of summarized information for each budget associated with this invoice. This field will only be set if the invoice detail level of the corresponding billing profile was set to "Budget level PO". Corresponds to the JSON property budgetSummaries

Returns:



5520
5521
5522
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5520

def budget_summaries
  @budget_summaries
end

#corrected_invoice_id ⇒ String

The ID of the original invoice being adjusted by this invoice, if applicable. May appear on the invoice PDF as Reference invoice number. If replaced_invoice_ids is set, this field will be empty. Corresponds to the JSON property correctedInvoiceId

Returns:

  • (String) 


5527
5528
5529
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5527

def corrected_invoice_id
  @corrected_invoice_id
end

#currency_code ⇒ String

The currency used in the invoice in ISO 4217 format. Corresponds to the JSON property currencyCode

Returns:

  • (String) 


5532
5533
5534
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5532

def currency_code
  @currency_code
end

#display_name ⇒ String

The display name of the invoice. Corresponds to the JSON property displayName

Returns:

  • (String) 


5537
5538
5539
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5537

def display_name
  @display_name
end

#due_date ⇒ Google::Apis::DisplayvideoV1::Date

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and google.protobuf.Timestamp. Corresponds to the JSON property dueDate

Returns:



5549
5550
5551
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5549

def due_date
  @due_date
end

#invoice_id ⇒ String

The unique ID of the invoice. Corresponds to the JSON property invoiceId

Returns:

  • (String) 


5554
5555
5556
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5554

def invoice_id
  @invoice_id
end

#invoice_type ⇒ String

The type of invoice document. Corresponds to the JSON property invoiceType

Returns:

  • (String) 


5559
5560
5561
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5559

def invoice_type
  @invoice_type
end

#issue_date ⇒ Google::Apis::DisplayvideoV1::Date

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and google.protobuf.Timestamp. Corresponds to the JSON property issueDate

Returns:



5571
5572
5573
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5571

def issue_date
  @issue_date
end

#name ⇒ String

The resource name of the invoice. Corresponds to the JSON property name

Returns:

  • (String) 


5576
5577
5578
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5576

def name
  @name
end

#non_budget_micros ⇒ Fixnum

The total amount of costs or adjustments not tied to a particular budget, in micros of the invoice's currency. For example, if currency_code is USD, then 1000000 represents one US dollar. Corresponds to the JSON property nonBudgetMicros

Returns:

  • (Fixnum) 


5583
5584
5585
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5583

def non_budget_micros
  @non_budget_micros
end

#payments_account_id ⇒ String

The ID of the payments account the invoice belongs to. Appears on the invoice PDF as Billing Account Number. Corresponds to the JSON property paymentsAccountId

Returns:

  • (String) 


5589
5590
5591
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5589

def 
  @payments_account_id
end

#payments_profile_id ⇒ String

The ID of the payments profile the invoice belongs to. Appears on the invoice PDF as Billing ID. Corresponds to the JSON property paymentsProfileId

Returns:

  • (String) 


5595
5596
5597
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5595

def payments_profile_id
  @payments_profile_id
end

#pdf_url ⇒ String

The URL to download a PDF copy of the invoice. This URL is user specific and requires a valid OAuth 2.0 access token to access. The access token must be provided in an Authorization: Bearer HTTP header and be authorized for one of the following scopes: * https://www.googleapis.com/auth/display-video- mediaplanning * https://www.googleapis.com/auth/display-video The URL will be valid for 7 days after retrieval of this invoice object or until this invoice is retrieved again. Corresponds to the JSON property pdfUrl

Returns:

  • (String) 


5606
5607
5608
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5606

def pdf_url
  @pdf_url
end

#purchase_order_number ⇒ String

Purchase order number associated with the invoice. Corresponds to the JSON property purchaseOrderNumber

Returns:

  • (String) 


5611
5612
5613
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5611

def purchase_order_number
  @purchase_order_number
end

#replaced_invoice_ids ⇒ Array<String>

The ID(s) of any originally issued invoice that is being cancelled by this invoice, if applicable. Multiple invoices may be listed if those invoices are being consolidated into a single invoice. May appear on invoice PDF as Replaced invoice numbers. If corrected_invoice_id is set, this field will be empty. Corresponds to the JSON property replacedInvoiceIds

Returns:

  • (Array<String>) 


5620
5621
5622
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5620

def replaced_invoice_ids
  @replaced_invoice_ids
end

#service_date_range ⇒ Google::Apis::DisplayvideoV1::DateRange

A date range. Corresponds to the JSON property serviceDateRange

Returns:



5625
5626
5627
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5625

def service_date_range
  @service_date_range
end

#subtotal_amount_micros ⇒ Fixnum

The pre-tax subtotal amount, in micros of the invoice's currency. For example, if currency_code is USD, then 1000000 represents one US dollar. Corresponds to the JSON property subtotalAmountMicros

Returns:

  • (Fixnum) 


5631
5632
5633
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5631

def subtotal_amount_micros
  @subtotal_amount_micros
end

#total_amount_micros ⇒ Fixnum

The invoice total amount, in micros of the invoice's currency. For example, if currency_code is USD, then 1000000 represents one US dollar. Corresponds to the JSON property totalAmountMicros

Returns:

  • (Fixnum) 


5637
5638
5639
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5637

def total_amount_micros
  @total_amount_micros
end

#total_tax_amount_micros ⇒ Fixnum

The sum of all taxes in invoice, in micros of the invoice's currency. For example, if currency_code is USD, then 1000000 represents one US dollar. Corresponds to the JSON property totalTaxAmountMicros

Returns:

  • (Fixnum) 


5643
5644
5645
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5643

def total_tax_amount_micros
  @total_tax_amount_micros
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5650

def update!(**args)
  @budget_invoice_grouping_id = args[:budget_invoice_grouping_id] if args.key?(:budget_invoice_grouping_id)
  @budget_summaries = args[:budget_summaries] if args.key?(:budget_summaries)
  @corrected_invoice_id = args[:corrected_invoice_id] if args.key?(:corrected_invoice_id)
  @currency_code = args[:currency_code] if args.key?(:currency_code)
  @display_name = args[:display_name] if args.key?(:display_name)
  @due_date = args[:due_date] if args.key?(:due_date)
  @invoice_id = args[:invoice_id] if args.key?(:invoice_id)
  @invoice_type = args[:invoice_type] if args.key?(:invoice_type)
  @issue_date = args[:issue_date] if args.key?(:issue_date)
  @name = args[:name] if args.key?(:name)
  @non_budget_micros = args[:non_budget_micros] if args.key?(:non_budget_micros)
  @payments_account_id = args[:payments_account_id] if args.key?(:payments_account_id)
  @payments_profile_id = args[:payments_profile_id] if args.key?(:payments_profile_id)
  @pdf_url = args[:pdf_url] if args.key?(:pdf_url)
  @purchase_order_number = args[:purchase_order_number] if args.key?(:purchase_order_number)
  @replaced_invoice_ids = args[:replaced_invoice_ids] if args.key?(:replaced_invoice_ids)
  @service_date_range = args[:service_date_range] if args.key?(:service_date_range)
  @subtotal_amount_micros = args[:subtotal_amount_micros] if args.key?(:subtotal_amount_micros)
  @total_amount_micros = args[:total_amount_micros] if args.key?(:total_amount_micros)
  @total_tax_amount_micros = args[:total_tax_amount_micros] if args.key?(:total_tax_amount_micros)
end