Class: Google::Apis::DisplayvideoV4::Invoice

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



9606
9607
9608
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9606

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) 


9474
9475
9476
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9474

def budget_invoice_grouping_id
  @budget_invoice_grouping_id
end

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



9481
9482
9483
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9481

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) 


9488
9489
9490
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9488

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) 


9493
9494
9495
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9493

def currency_code
  @currency_code
end

#display_name ⇒ String

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

Returns:

  • (String) 


9498
9499
9500
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9498

def display_name
  @display_name
end

#due_date ⇒ Google::Apis::DisplayvideoV4::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:



9510
9511
9512
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9510

def due_date
  @due_date
end

#invoice_id ⇒ String

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

Returns:

  • (String) 


9515
9516
9517
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9515

def invoice_id
  @invoice_id
end

#invoice_type ⇒ String

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

Returns:

  • (String) 


9520
9521
9522
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9520

def invoice_type
  @invoice_type
end

#issue_date ⇒ Google::Apis::DisplayvideoV4::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:



9532
9533
9534
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9532

def issue_date
  @issue_date
end

#name ⇒ String

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

Returns:

  • (String) 


9537
9538
9539
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9537

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) 


9544
9545
9546
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9544

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) 


9550
9551
9552
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9550

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) 


9556
9557
9558
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9556

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) 


9567
9568
9569
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9567

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) 


9572
9573
9574
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9572

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


9581
9582
9583
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9581

def replaced_invoice_ids
  @replaced_invoice_ids
end

#service_date_range ⇒ Google::Apis::DisplayvideoV4::DateRange

A date range. Corresponds to the JSON property serviceDateRange

Returns:



9586
9587
9588
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9586

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) 


9592
9593
9594
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9592

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) 


9598
9599
9600
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9598

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) 


9604
9605
9606
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9604

def total_tax_amount_micros
  @total_tax_amount_micros
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9611

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