Invoice (Campaign Manager 360 API v5-rev20251009-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.dfareporting.model.Invoice

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Invoice
extends com.google.api.client.json.GenericJson
```
Contains information about 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 Campaign Manager 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()`
`List<CampaignSummary>`	`getCampaignSummaries()` The list of summarized campaign information associated with this invoice.
`String`	`getCorrectedInvoiceId()` The originally issued invoice that is being adjusted by this invoice, if applicable.
`String`	`getCurrencyCode()` Invoice currency code in ISO 4217 format.
`String`	`getDueDate()` The invoice due date.
`String`	`getId()` ID of this invoice.
`String`	`getInvoiceType()` The type of invoice document.
`String`	`getIssueDate()` The date when the invoice was issued.
`String`	`getKind()` Identifies what kind of resource this is.
`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 originally issued invoice(s) that is being cancelled by this invoice, if applicable.
`String`	`getServiceEndDate()` The invoice service end date.
`String`	`getServiceStartDate()` The invoice service start date.
`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`	`setCampaignSummaries(List<CampaignSummary> campaignSummaries)` The list of summarized campaign information associated with this invoice.
`Invoice`	`setCorrectedInvoiceId(String correctedInvoiceId)` The originally issued invoice that is being adjusted by this invoice, if applicable.
`Invoice`	`setCurrencyCode(String currencyCode)` Invoice currency code in ISO 4217 format.
`Invoice`	`setDueDate(String dueDate)` The invoice due date.
`Invoice`	`setId(String id)` ID of this invoice.
`Invoice`	`setInvoiceType(String invoiceType)` The type of invoice document.
`Invoice`	`setIssueDate(String issueDate)` The date when the invoice was issued.
`Invoice`	`setKind(String kind)` Identifies what kind of resource this is.
`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 originally issued invoice(s) that is being cancelled by this invoice, if applicable.
`Invoice`	`setServiceEndDate(String serviceEndDate)` The invoice service end date.
`Invoice`	`setServiceStartDate(String serviceStartDate)` The invoice service start date.
`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
  - getCampaignSummaries
```
public List<CampaignSummary> getCampaignSummaries()
```
    The list of summarized campaign information associated with this invoice.
    
    Returns:
    
    value or null for none
  - setCampaignSummaries
```
public Invoice setCampaignSummaries(List<CampaignSummary> campaignSummaries)
```
    The list of summarized campaign information associated with this invoice.
    
    Parameters:
    
    campaignSummaries - campaignSummaries or null for none
  - getCorrectedInvoiceId
```
public String getCorrectedInvoiceId()
```
    The originally issued invoice that is being adjusted by this invoice, if applicable. May appear on invoice PDF as *Reference invoice number*.
    
    Returns:
    
    value or null for none
  - setCorrectedInvoiceId
```
public Invoice setCorrectedInvoiceId(String correctedInvoiceId)
```
    The originally issued invoice that is being adjusted by this invoice, if applicable. May appear on invoice PDF as *Reference invoice number*.
    
    Parameters:
    
    correctedInvoiceId - correctedInvoiceId or null for none
  - getCurrencyCode
```
public String getCurrencyCode()
```
    Invoice currency code in ISO 4217 format.
    
    Returns:
    
    value or null for none
  - setCurrencyCode
```
public Invoice setCurrencyCode(String currencyCode)
```
    Invoice currency code in ISO 4217 format.
    
    Parameters:
    
    currencyCode - currencyCode or null for none
  - getDueDate
```
public String getDueDate()
```
    The invoice due date.
    
    Returns:
    
    value or null for none
  - setDueDate
```
public Invoice setDueDate(String dueDate)
```
    The invoice due date.
    
    Parameters:
    
    dueDate - dueDate or null for none
  - getId
```
public String getId()
```
    ID of this invoice.
    
    Returns:
    
    value or null for none
  - setId
```
public Invoice setId(String id)
```
    ID of this invoice.
    
    Parameters:
    
    id - id 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 String getIssueDate()
```
    The date when the invoice was issued.
    
    Returns:
    
    value or null for none
  - setIssueDate
```
public Invoice setIssueDate(String issueDate)
```
    The date when the invoice was issued.
    
    Parameters:
    
    issueDate - issueDate or null for none
  - getKind
```
public String getKind()
```
    Identifies what kind of resource this is. Value: the fixed string "dfareporting#invoice".
    
    Returns:
    
    value or null for none
  - setKind
```
public Invoice setKind(String kind)
```
    Identifies what kind of resource this is. Value: the fixed string "dfareporting#invoice".
    
    Parameters:
    
    kind - kind 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. 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.
    
    Returns:
    
    value or null for none
  - setPdfUrl
```
public Invoice setPdfUrl(String pdfUrl)
```
    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.
    
    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 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.
    
    Returns:
    
    value or null for none
  - setReplacedInvoiceIds
```
public Invoice setReplacedInvoiceIds(List<String> replacedInvoiceIds)
```
    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.
    
    Parameters:
    
    replacedInvoiceIds - replacedInvoiceIds or null for none
  - getServiceEndDate
```
public String getServiceEndDate()
```
    The invoice service end date.
    
    Returns:
    
    value or null for none
  - setServiceEndDate
```
public Invoice setServiceEndDate(String serviceEndDate)
```
    The invoice service end date.
    
    Parameters:
    
    serviceEndDate - serviceEndDate or null for none
  - getServiceStartDate
```
public String getServiceStartDate()
```
    The invoice service start date.
    
    Returns:
    
    value or null for none
  - setServiceStartDate
```
public Invoice setServiceStartDate(String serviceStartDate)
```
    The invoice service start date.
    
    Parameters:
    
    serviceStartDate - serviceStartDate or null for none
  - getSubtotalAmountMicros
```
public Long getSubtotalAmountMicros()
```
    The pre-tax subtotal amount, in micros of the invoice's currency.
    
    Returns:
    
    value or null for none
  - setSubtotalAmountMicros
```
public Invoice setSubtotalAmountMicros(Long subtotalAmountMicros)
```
    The pre-tax subtotal amount, in micros of the invoice's currency.
    
    Parameters:
    
    subtotalAmountMicros - subtotalAmountMicros or null for none
  - getTotalAmountMicros
```
public Long getTotalAmountMicros()
```
    The invoice total amount, in micros of the invoice's currency.
    
    Returns:
    
    value or null for none
  - setTotalAmountMicros
```
public Invoice setTotalAmountMicros(Long totalAmountMicros)
```
    The invoice total amount, in micros of the invoice's currency.
    
    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.
    
    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.
    
    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

getCampaignSummaries

setCampaignSummaries

getCorrectedInvoiceId

setCorrectedInvoiceId

getCurrencyCode

setCurrencyCode

getDueDate

setDueDate

getId

setId

getInvoiceType

setInvoiceType

getIssueDate

setIssueDate

getKind

setKind

getPaymentsAccountId

setPaymentsAccountId

getPaymentsProfileId

setPaymentsProfileId

getPdfUrl

setPdfUrl

getPurchaseOrderNumber

setPurchaseOrderNumber

getReplacedInvoiceIds

setReplacedInvoiceIds

getServiceEndDate

setServiceEndDate

getServiceStartDate

setServiceStartDate

getSubtotalAmountMicros

setSubtotalAmountMicros

getTotalAmountMicros

setTotalAmountMicros

getTotalTaxAmountMicros

setTotalTaxAmountMicros

set

clone