Class: Google::Apis::DisplayvideoV3::Invoice

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/displayvideo_v3/classes.rb,
lib/google/apis/displayvideo_v3/representations.rb,
lib/google/apis/displayvideo_v3/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.



9111
9112
9113
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9111

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) 


8979
8980
8981
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 8979

def budget_invoice_grouping_id
  @budget_invoice_grouping_id
end

#budget_summaries ⇒ Array<Google::Apis::DisplayvideoV3::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:



8986
8987
8988
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 8986

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) 


8993
8994
8995
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 8993

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) 


8998
8999
9000
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 8998

def currency_code
  @currency_code
end

#display_name ⇒ String

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

Returns:

  • (String) 


9003
9004
9005
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9003

def display_name
  @display_name
end

#due_date ⇒ Google::Apis::DisplayvideoV3::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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type. TimeOfDay * google.type.DateTime * google.protobuf.Timestamp Corresponds to the JSON property dueDate

Returns:



9015
9016
9017
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9015

def due_date
  @due_date
end

#invoice_id ⇒ String

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

Returns:

  • (String) 


9020
9021
9022
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9020

def invoice_id
  @invoice_id
end

#invoice_type ⇒ String

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

Returns:

  • (String) 


9025
9026
9027
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9025

def invoice_type
  @invoice_type
end

#issue_date ⇒ Google::Apis::DisplayvideoV3::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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type. TimeOfDay * google.type.DateTime * google.protobuf.Timestamp Corresponds to the JSON property issueDate

Returns:



9037
9038
9039
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9037

def issue_date
  @issue_date
end

#name ⇒ String

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

Returns:

  • (String) 


9042
9043
9044
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9042

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) 


9049
9050
9051
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9049

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) 


9055
9056
9057
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9055

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) 


9061
9062
9063
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9061

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) 


9072
9073
9074
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9072

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) 


9077
9078
9079
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9077

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>) 


9086
9087
9088
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9086

def replaced_invoice_ids
  @replaced_invoice_ids
end

#service_date_range ⇒ Google::Apis::DisplayvideoV3::DateRange

A date range. Corresponds to the JSON property serviceDateRange

Returns:



9091
9092
9093
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9091

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) 


9097
9098
9099
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9097

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) 


9103
9104
9105
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9103

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) 


9109
9110
9111
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9109

def total_tax_amount_micros
  @total_tax_amount_micros
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 9116

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