Class: Google::Apis::DfareportingV5::Invoice

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

Overview

Contains information about a single invoice

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Invoice

Returns a new instance of Invoice.



8151
8152
8153
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 8151

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

Instance Attribute Details

#campaign_summaries ⇒ Array<Google::Apis::DfareportingV5::CampaignSummary>

The list of summarized campaign information associated with this invoice. Corresponds to the JSON property campaign_summaries

Returns:



8054
8055
8056
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 8054

def campaign_summaries
  @campaign_summaries
end

#corrected_invoice_id ⇒ String

The originally issued invoice that is being adjusted by this invoice, if applicable. May appear on invoice PDF as Reference invoice number. Corresponds to the JSON property correctedInvoiceId

Returns:

  • (String) 


8060
8061
8062
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 8060

def corrected_invoice_id
  @corrected_invoice_id
end

#currency_code ⇒ String

Invoice currency code in ISO 4217 format. Corresponds to the JSON property currencyCode

Returns:

  • (String) 


8065
8066
8067
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 8065

def currency_code
  @currency_code
end

#due_date ⇒ String

The invoice due date. Corresponds to the JSON property dueDate

Returns:

  • (String) 


8070
8071
8072
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 8070

def due_date
  @due_date
end

#id ⇒ String

ID of this invoice. Corresponds to the JSON property id

Returns:

  • (String) 


8075
8076
8077
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 8075

def id
  @id
end

#invoice_type ⇒ String

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

Returns:

  • (String) 


8080
8081
8082
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 8080

def invoice_type
  @invoice_type
end

#issue_date ⇒ String

The date when the invoice was issued. Corresponds to the JSON property issueDate

Returns:

  • (String) 


8085
8086
8087
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 8085

def issue_date
  @issue_date
end

#kind ⇒ String

Identifies what kind of resource this is. Value: the fixed string " dfareporting#invoice". Corresponds to the JSON property kind

Returns:

  • (String) 


8091
8092
8093
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 8091

def kind
  @kind
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) 


8097
8098
8099
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 8097

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) 


8103
8104
8105
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 8103

def payments_profile_id
  @payments_profile_id
end

#pdf_url ⇒ String

The URL to download a PDF copy of the invoice. Note that 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. The URL will only be usable for 7 days from when the api is called. Corresponds to the JSON property pdfUrl

Returns:

  • (String) 


8111
8112
8113
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 8111

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) 


8116
8117
8118
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 8116

def purchase_order_number
  @purchase_order_number
end

#replaced_invoice_ids ⇒ Array<String>

The originally issued invoice(s) that is being cancelled by this invoice, if applicable. May appear on invoice PDF as Replaced invoice numbers. Note: There may be multiple replaced invoices due to consolidation of multiple invoices into a single invoice. Corresponds to the JSON property replacedInvoiceIds

Returns:

  • (Array<String>) 


8124
8125
8126
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 8124

def replaced_invoice_ids
  @replaced_invoice_ids
end

#service_end_date ⇒ String

The invoice service end date. Corresponds to the JSON property serviceEndDate

Returns:

  • (String) 


8129
8130
8131
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 8129

def service_end_date
  @service_end_date
end

#service_start_date ⇒ String

The invoice service start date. Corresponds to the JSON property serviceStartDate

Returns:

  • (String) 


8134
8135
8136
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 8134

def service_start_date
  @service_start_date
end

#subtotal_amount_micros ⇒ Fixnum

The pre-tax subtotal amount, in micros of the invoice's currency. Corresponds to the JSON property subtotalAmountMicros

Returns:

  • (Fixnum) 


8139
8140
8141
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 8139

def subtotal_amount_micros
  @subtotal_amount_micros
end

#total_amount_micros ⇒ Fixnum

The invoice total amount, in micros of the invoice's currency. Corresponds to the JSON property totalAmountMicros

Returns:

  • (Fixnum) 


8144
8145
8146
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 8144

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. Corresponds to the JSON property totalTaxAmountMicros

Returns:

  • (Fixnum) 


8149
8150
8151
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 8149

def total_tax_amount_micros
  @total_tax_amount_micros
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 8156

def update!(**args)
  @campaign_summaries = args[:campaign_summaries] if args.key?(:campaign_summaries)
  @corrected_invoice_id = args[:corrected_invoice_id] if args.key?(:corrected_invoice_id)
  @currency_code = args[:currency_code] if args.key?(:currency_code)
  @due_date = args[:due_date] if args.key?(:due_date)
  @id = args[:id] if args.key?(:id)
  @invoice_type = args[:invoice_type] if args.key?(:invoice_type)
  @issue_date = args[:issue_date] if args.key?(:issue_date)
  @kind = args[:kind] if args.key?(:kind)
  @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_end_date = args[:service_end_date] if args.key?(:service_end_date)
  @service_start_date = args[:service_start_date] if args.key?(:service_start_date)
  @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