Invoice (Display & Video 360 API v2-rev20260505-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.displayvideo.v2.model.Invoice

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Invoice
extends com.google.api.client.json.GenericJson
```
A single invoice.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Display & Video 360 API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Invoice()

Constructors
Constructor and Description
`Invoice()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Invoice`	`clone()`
`String`	`getBudgetInvoiceGroupingId()` The budget grouping ID for this invoice.
`List<BudgetSummary>`	`getBudgetSummaries()` The list of summarized information for each budget associated with this invoice.
`String`	`getCorrectedInvoiceId()` The ID of the original invoice being adjusted by this invoice, if applicable.
`String`	`getCurrencyCode()` The currency used in the invoice in ISO 4217 format.
`String`	`getDisplayName()` The display name of the invoice.
`Date`	`getDueDate()` The date when the invoice is due.
`String`	`getInvoiceId()` The unique ID of the invoice.
`String`	`getInvoiceType()` The type of invoice document.
`Date`	`getIssueDate()` The date when the invoice was issued.
`String`	`getName()` The resource name of the invoice.
`Long`	`getNonBudgetMicros()` The total amount of costs or adjustments not tied to a particular budget, in micros of the invoice's currency.
`String`	`getPaymentsAccountId()` The ID of the payments account the invoice belongs to.
`String`	`getPaymentsProfileId()` The ID of the payments profile the invoice belongs to.
`String`	`getPdfUrl()` The URL to download a PDF copy of the invoice.
`String`	`getPurchaseOrderNumber()` Purchase order number associated with the invoice.
`List<String>`	`getReplacedInvoiceIds()` The ID(s) of any originally issued invoice that is being cancelled by this invoice, if applicable.
`DateRange`	`getServiceDateRange()` The service start and end dates which are covered by this invoice.
`Long`	`getSubtotalAmountMicros()` The pre-tax subtotal amount, in micros of the invoice's currency.
`Long`	`getTotalAmountMicros()` The invoice total amount, in micros of the invoice's currency.
`Long`	`getTotalTaxAmountMicros()` The sum of all taxes in invoice, in micros of the invoice's currency.
`Invoice`	`set(String fieldName, Object value)`
`Invoice`	`setBudgetInvoiceGroupingId(String budgetInvoiceGroupingId)` The budget grouping ID for this invoice.
`Invoice`	`setBudgetSummaries(List<BudgetSummary> budgetSummaries)` The list of summarized information for each budget associated with this invoice.
`Invoice`	`setCorrectedInvoiceId(String correctedInvoiceId)` The ID of the original invoice being adjusted by this invoice, if applicable.
`Invoice`	`setCurrencyCode(String currencyCode)` The currency used in the invoice in ISO 4217 format.
`Invoice`	`setDisplayName(String displayName)` The display name of the invoice.
`Invoice`	`setDueDate(Date dueDate)` The date when the invoice is due.
`Invoice`	`setInvoiceId(String invoiceId)` The unique ID of the invoice.
`Invoice`	`setInvoiceType(String invoiceType)` The type of invoice document.
`Invoice`	`setIssueDate(Date issueDate)` The date when the invoice was issued.
`Invoice`	`setName(String name)` The resource name of the invoice.
`Invoice`	`setNonBudgetMicros(Long nonBudgetMicros)` The total amount of costs or adjustments not tied to a particular budget, in micros of the invoice's currency.
`Invoice`	`setPaymentsAccountId(String paymentsAccountId)` The ID of the payments account the invoice belongs to.
`Invoice`	`setPaymentsProfileId(String paymentsProfileId)` The ID of the payments profile the invoice belongs to.
`Invoice`	`setPdfUrl(String pdfUrl)` The URL to download a PDF copy of the invoice.
`Invoice`	`setPurchaseOrderNumber(String purchaseOrderNumber)` Purchase order number associated with the invoice.
`Invoice`	`setReplacedInvoiceIds(List<String> replacedInvoiceIds)` The ID(s) of any originally issued invoice that is being cancelled by this invoice, if applicable.
`Invoice`	`setServiceDateRange(DateRange serviceDateRange)` The service start and end dates which are covered by this invoice.
`Invoice`	`setSubtotalAmountMicros(Long subtotalAmountMicros)` The pre-tax subtotal amount, in micros of the invoice's currency.
`Invoice`	`setTotalAmountMicros(Long totalAmountMicros)` The invoice total amount, in micros of the invoice's currency.
`Invoice`	`setTotalTaxAmountMicros(Long totalTaxAmountMicros)` The sum of all taxes in invoice, in micros of the invoice's currency.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Invoice
```
public Invoice()
```
- Method Detail
  - getBudgetInvoiceGroupingId
```
public String getBudgetInvoiceGroupingId()
```
    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".
    
    Returns:
    
    value or null for none
  - setBudgetInvoiceGroupingId
```
public Invoice setBudgetInvoiceGroupingId(String budgetInvoiceGroupingId)
```
    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".
    
    Parameters:
    
    budgetInvoiceGroupingId - budgetInvoiceGroupingId or null for none
  - getBudgetSummaries
```
public List<BudgetSummary> getBudgetSummaries()
```
    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".
    
    Returns:
    
    value or null for none
  - setBudgetSummaries
```
public Invoice setBudgetSummaries(List<BudgetSummary> budgetSummaries)
```
    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".
    
    Parameters:
    
    budgetSummaries - budgetSummaries or null for none
  - getCorrectedInvoiceId
```
public String getCorrectedInvoiceId()
```
    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.
    
    Returns:
    
    value or null for none
  - setCorrectedInvoiceId
```
public Invoice setCorrectedInvoiceId(String correctedInvoiceId)
```
    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.
    
    Parameters:
    
    correctedInvoiceId - correctedInvoiceId or null for none
  - getCurrencyCode
```
public String getCurrencyCode()
```
    The currency used in the invoice in ISO 4217 format.
    
    Returns:
    
    value or null for none
  - setCurrencyCode
```
public Invoice setCurrencyCode(String currencyCode)
```
    The currency used in the invoice in ISO 4217 format.
    
    Parameters:
    
    currencyCode - currencyCode or null for none
  - getDisplayName
```
public String getDisplayName()
```
    The display name of the invoice.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public Invoice setDisplayName(String displayName)
```
    The display name of the invoice.
    
    Parameters:
    
    displayName - displayName or null for none
  - getDueDate
```
public Date getDueDate()
```
    The date when the invoice is due.
    
    Returns:
    
    value or null for none
  - setDueDate
```
public Invoice setDueDate(Date dueDate)
```
    The date when the invoice is due.
    
    Parameters:
    
    dueDate - dueDate or null for none
  - getInvoiceId
```
public String getInvoiceId()
```
    The unique ID of the invoice.
    
    Returns:
    
    value or null for none
  - setInvoiceId
```
public Invoice setInvoiceId(String invoiceId)
```
    The unique ID of the invoice.
    
    Parameters:
    
    invoiceId - invoiceId or null for none
  - getInvoiceType
```
public String getInvoiceType()
```
    The type of invoice document.
    
    Returns:
    
    value or null for none
  - setInvoiceType
```
public Invoice setInvoiceType(String invoiceType)
```
    The type of invoice document.
    
    Parameters:
    
    invoiceType - invoiceType or null for none
  - getIssueDate
```
public Date getIssueDate()
```
    The date when the invoice was issued.
    
    Returns:
    
    value or null for none
  - setIssueDate
```
public Invoice setIssueDate(Date issueDate)
```
    The date when the invoice was issued.
    
    Parameters:
    
    issueDate - issueDate or null for none
  - getName
```
public String getName()
```
    The resource name of the invoice.
    
    Returns:
    
    value or null for none
  - setName
```
public Invoice setName(String name)
```
    The resource name of the invoice.
    
    Parameters:
    
    name - name or null for none
  - getNonBudgetMicros
```
public Long getNonBudgetMicros()
```
    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.
    
    Returns:
    
    value or null for none
  - setNonBudgetMicros
```
public Invoice setNonBudgetMicros(Long nonBudgetMicros)
```
    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.
    
    Parameters:
    
    nonBudgetMicros - nonBudgetMicros or null for none
  - getPaymentsAccountId
```
public String getPaymentsAccountId()
```
    The ID of the payments account the invoice belongs to. Appears on the invoice PDF as `Billing Account Number`.
    
    Returns:
    
    value or null for none
  - setPaymentsAccountId
```
public Invoice setPaymentsAccountId(String paymentsAccountId)
```
    The ID of the payments account the invoice belongs to. Appears on the invoice PDF as `Billing Account Number`.
    
    Parameters:
    
    paymentsAccountId - paymentsAccountId or null for none
  - getPaymentsProfileId
```
public String getPaymentsProfileId()
```
    The ID of the payments profile the invoice belongs to. Appears on the invoice PDF as `Billing ID`.
    
    Returns:
    
    value or null for none
  - setPaymentsProfileId
```
public Invoice setPaymentsProfileId(String paymentsProfileId)
```
    The ID of the payments profile the invoice belongs to. Appears on the invoice PDF as `Billing ID`.
    
    Parameters:
    
    paymentsProfileId - paymentsProfileId or null for none
  - getPdfUrl
```
public String getPdfUrl()
```
    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.
    
    Returns:
    
    value or null for none
  - setPdfUrl
```
public Invoice setPdfUrl(String pdfUrl)
```
    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.
    
    Parameters:
    
    pdfUrl - pdfUrl or null for none
  - getPurchaseOrderNumber
```
public String getPurchaseOrderNumber()
```
    Purchase order number associated with the invoice.
    
    Returns:
    
    value or null for none
  - setPurchaseOrderNumber
```
public Invoice setPurchaseOrderNumber(String purchaseOrderNumber)
```
    Purchase order number associated with the invoice.
    
    Parameters:
    
    purchaseOrderNumber - purchaseOrderNumber or null for none
  - getReplacedInvoiceIds
```
public List<String> getReplacedInvoiceIds()
```
    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.
    
    Returns:
    
    value or null for none
  - setReplacedInvoiceIds
```
public Invoice setReplacedInvoiceIds(List<String> replacedInvoiceIds)
```
    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.
    
    Parameters:
    
    replacedInvoiceIds - replacedInvoiceIds or null for none
  - getServiceDateRange
```
public DateRange getServiceDateRange()
```
    The service start and end dates which are covered by this invoice.
    
    Returns:
    
    value or null for none
  - setServiceDateRange
```
public Invoice setServiceDateRange(DateRange serviceDateRange)
```
    The service start and end dates which are covered by this invoice.
    
    Parameters:
    
    serviceDateRange - serviceDateRange or null for none
  - getSubtotalAmountMicros
```
public Long getSubtotalAmountMicros()
```
    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.
    
    Returns:
    
    value or null for none
  - setSubtotalAmountMicros
```
public Invoice setSubtotalAmountMicros(Long subtotalAmountMicros)
```
    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.
    
    Parameters:
    
    subtotalAmountMicros - subtotalAmountMicros or null for none
  - getTotalAmountMicros
```
public Long getTotalAmountMicros()
```
    The invoice total amount, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.
    
    Returns:
    
    value or null for none
  - setTotalAmountMicros
```
public Invoice setTotalAmountMicros(Long totalAmountMicros)
```
    The invoice total amount, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.
    
    Parameters:
    
    totalAmountMicros - totalAmountMicros or null for none
  - getTotalTaxAmountMicros
```
public Long getTotalTaxAmountMicros()
```
    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.
    
    Returns:
    
    value or null for none
  - setTotalTaxAmountMicros
```
public Invoice setTotalTaxAmountMicros(Long totalTaxAmountMicros)
```
    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.
    
    Parameters:
    
    totalTaxAmountMicros - totalTaxAmountMicros or null for none
  - set
```
public Invoice set(String fieldName,
                   Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Invoice clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Invoice

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Invoice

Method Detail

getBudgetInvoiceGroupingId

setBudgetInvoiceGroupingId

getBudgetSummaries

setBudgetSummaries

getCorrectedInvoiceId

setCorrectedInvoiceId

getCurrencyCode

setCurrencyCode

getDisplayName

setDisplayName

getDueDate

setDueDate

getInvoiceId

setInvoiceId

getInvoiceType

setInvoiceType

getIssueDate

setIssueDate

getName

setName

getNonBudgetMicros

setNonBudgetMicros

getPaymentsAccountId

setPaymentsAccountId

getPaymentsProfileId

setPaymentsProfileId

getPdfUrl

setPdfUrl

getPurchaseOrderNumber

setPurchaseOrderNumber

getReplacedInvoiceIds

setReplacedInvoiceIds

getServiceDateRange

setServiceDateRange

getSubtotalAmountMicros

setSubtotalAmountMicros

getTotalAmountMicros

setTotalAmountMicros

getTotalTaxAmountMicros

setTotalTaxAmountMicros

set

clone