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.



5639
5640
5641
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5639

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

Instance Attribute Details

#budget_invoice_grouping_id ⇒ String

Output only. Budget invoice grouping ID associated with the budget segment in the insertion order. Corresponds to the JSON property budgetInvoiceGroupingId

Returns:

  • (String) 


5507
5508
5509
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5507

def budget_invoice_grouping_id
  @budget_invoice_grouping_id
end

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

Output only. The list of summarized budget information associated with this invoice. Corresponds to the JSON property budgetSummaries

Returns:



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

def budget_summaries
  @budget_summaries
end

#corrected_invoice_id ⇒ String

Output only. The originally issued invoice that is being adjusted by this invoice, if applicable. If there is a corrected invoice, the replaced_invoice_ids field will be empty. May appear on invoice PDF as Reference invoice number. Corresponds to the JSON property correctedInvoiceId

Returns:

  • (String) 


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

def corrected_invoice_id
  @corrected_invoice_id
end

#currency_code ⇒ String

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

Returns:

  • (String) 


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

def currency_code
  @currency_code
end

#display_name ⇒ String

Output only. Display name of the invoice. Corresponds to the JSON property displayName

Returns:

  • (String) 


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

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:



5543
5544
5545
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5543

def due_date
  @due_date
end

#invoice_id ⇒ String

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

Returns:

  • (String) 


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

def invoice_id
  @invoice_id
end

#invoice_type ⇒ String

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

Returns:

  • (String) 


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

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:



5565
5566
5567
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5565

def issue_date
  @issue_date
end

#name ⇒ String

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

Returns:

  • (String) 


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

def name
  @name
end

#non_budget_micros ⇒ Fixnum

Output only. 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 micros is one US dollar. Corresponds to the JSON property nonBudgetMicros

Returns:

  • (Fixnum) 


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

def non_budget_micros
  @non_budget_micros
end

#payments_account_id ⇒ String

Output only. 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) 


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

def 
  @payments_account_id
end

#payments_profile_id ⇒ String

Output only. 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) 


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

def payments_profile_id
  @payments_profile_id
end

#pdf_url ⇒ String

Output only. 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 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 only be usable for 7 days from when the api is called. Corresponds to the JSON property pdfUrl

Returns:

  • (String) 


5599
5600
5601
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5599

def pdf_url
  @pdf_url
end

#purchase_order_number ⇒ String

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

Returns:

  • (String) 


5604
5605
5606
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5604

def purchase_order_number
  @purchase_order_number
end

#replaced_invoice_ids ⇒ Array<String>

Output only. The originally issued invoice(s) that is being cancelled by this invoice, if applicable. If there are any replaced invoices, the corrected_invoice_id field will be empty. 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>) 


5613
5614
5615
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5613

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:



5618
5619
5620
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5618

def service_date_range
  @service_date_range
end

#subtotal_amount_micros ⇒ Fixnum

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

Returns:

  • (Fixnum) 


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

def subtotal_amount_micros
  @subtotal_amount_micros
end

#total_amount_micros ⇒ Fixnum

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

Returns:

  • (Fixnum) 


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

def total_amount_micros
  @total_amount_micros
end

#total_tax_amount_micros ⇒ Fixnum

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

Returns:

  • (Fixnum) 


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

def total_tax_amount_micros
  @total_tax_amount_micros
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5644

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