Package software.amazon.spapi.models.vendor.invoices.v1

Class Invoice

java.lang.Object

software.amazon.spapi.models.vendor.invoices.v1.Invoice

public class Invoice
extends java.lang.Object

Represents an invoice or credit note document with details about the transaction, parties involved, and line items.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Invoice.InvoiceTypeEnum	Identifies the type of invoice.

Constructor Summary

Constructors

Constructor	Description
Invoice()

Method Summary

Modifier and Type	Method	Description
Invoice	addAdditionalDetailsItem(AdditionalDetails additionalDetailsItem)
Invoice	addAllowanceDetailsItem(AllowanceDetails allowanceDetailsItem)
Invoice	addChargeDetailsItem(ChargeDetails chargeDetailsItem)
Invoice	addItemsItem(InvoiceItem itemsItem)
Invoice	additionalDetails(java.util.List<AdditionalDetails> additionalDetails)
Invoice	addTaxDetailsItem(TaxDetails taxDetailsItem)
Invoice	allowanceDetails(java.util.List<AllowanceDetails> allowanceDetails)
Invoice	billToParty(PartyIdentification billToParty)
Invoice	chargeDetails(java.util.List<ChargeDetails> chargeDetails)
Invoice	date(org.threeten.bp.OffsetDateTime date)
boolean	equals(java.lang.Object o)
java.util.List<AdditionalDetails>	getAdditionalDetails()	Additional details provided by the selling party, for tax related or other purposes.
java.util.List<AllowanceDetails>	getAllowanceDetails()	Total allowance amount details for all line items.
PartyIdentification	getBillToParty()	Get billToParty
java.util.List<ChargeDetails>	getChargeDetails()	Total charge amount details for all line items.
org.threeten.bp.OffsetDateTime	getDate()	Get date
java.lang.String	getId()	Unique number relating to the charges defined in this document.
Money	getInvoiceTotal()	Get invoiceTotal
Invoice.InvoiceTypeEnum	getInvoiceType()	Identifies the type of invoice.
java.util.List<InvoiceItem>	getItems()	The list of invoice items.
PaymentTerms	getPaymentTerms()	Get paymentTerms
java.lang.String	getReferenceNumber()	An additional unique reference number used for regulatory or other purposes.
PartyIdentification	getRemitToParty()	Get remitToParty
PartyIdentification	getShipFromParty()	Get shipFromParty
PartyIdentification	getShipToParty()	Get shipToParty
java.util.List<TaxDetails>	getTaxDetails()	Total tax amount details for all line items.
int	hashCode()
Invoice	id(java.lang.String id)
Invoice	invoiceTotal(Money invoiceTotal)
Invoice	invoiceType(Invoice.InvoiceTypeEnum invoiceType)
Invoice	items(java.util.List<InvoiceItem> items)
Invoice	paymentTerms(PaymentTerms paymentTerms)
Invoice	referenceNumber(java.lang.String referenceNumber)
Invoice	remitToParty(PartyIdentification remitToParty)
void	setAdditionalDetails(java.util.List<AdditionalDetails> additionalDetails)
void	setAllowanceDetails(java.util.List<AllowanceDetails> allowanceDetails)
void	setBillToParty(PartyIdentification billToParty)
void	setChargeDetails(java.util.List<ChargeDetails> chargeDetails)
void	setDate(org.threeten.bp.OffsetDateTime date)
void	setId(java.lang.String id)
void	setInvoiceTotal(Money invoiceTotal)
void	setInvoiceType(Invoice.InvoiceTypeEnum invoiceType)
void	setItems(java.util.List<InvoiceItem> items)
void	setPaymentTerms(PaymentTerms paymentTerms)
void	setReferenceNumber(java.lang.String referenceNumber)
void	setRemitToParty(PartyIdentification remitToParty)
void	setShipFromParty(PartyIdentification shipFromParty)
void	setShipToParty(PartyIdentification shipToParty)
void	setTaxDetails(java.util.List<TaxDetails> taxDetails)
Invoice	shipFromParty(PartyIdentification shipFromParty)
Invoice	shipToParty(PartyIdentification shipToParty)
Invoice	taxDetails(java.util.List<TaxDetails> taxDetails)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Invoice

public Invoice()

Method Detail

invoiceType

public Invoice invoiceType(Invoice.InvoiceTypeEnum invoiceType)

getInvoiceType

public Invoice.InvoiceTypeEnum getInvoiceType()

Identifies the type of invoice.

Returns:

invoiceType

setInvoiceType

public void setInvoiceType(Invoice.InvoiceTypeEnum invoiceType)

id

public Invoice id(java.lang.String id)

getId

public java.lang.String getId()

Unique number relating to the charges defined in this document. This will be invoice number if the document type is Invoice or CreditNote number if the document type is Credit Note. Failure to provide this reference will result in a rejection.

Returns:

id

setId

public void setId(java.lang.String id)

referenceNumber

public Invoice referenceNumber(java.lang.String referenceNumber)

getReferenceNumber

public java.lang.String getReferenceNumber()

An additional unique reference number used for regulatory or other purposes.

Returns:

referenceNumber

setReferenceNumber

public void setReferenceNumber(java.lang.String referenceNumber)

date

public Invoice date(org.threeten.bp.OffsetDateTime date)

getDate

public org.threeten.bp.OffsetDateTime getDate()

Get date

Returns:

date

setDate

public void setDate(org.threeten.bp.OffsetDateTime date)

remitToParty

public Invoice remitToParty(PartyIdentification remitToParty)

getRemitToParty

public PartyIdentification getRemitToParty()

Get remitToParty

Returns:

remitToParty

setRemitToParty

public void setRemitToParty(PartyIdentification remitToParty)

shipToParty

public Invoice shipToParty(PartyIdentification shipToParty)

getShipToParty

public PartyIdentification getShipToParty()

Get shipToParty

Returns:

shipToParty

setShipToParty

public void setShipToParty(PartyIdentification shipToParty)

shipFromParty

public Invoice shipFromParty(PartyIdentification shipFromParty)

getShipFromParty

public PartyIdentification getShipFromParty()

Get shipFromParty

Returns:

shipFromParty

setShipFromParty

public void setShipFromParty(PartyIdentification shipFromParty)

billToParty

public Invoice billToParty(PartyIdentification billToParty)

getBillToParty

public PartyIdentification getBillToParty()

Get billToParty

Returns:

billToParty

setBillToParty

public void setBillToParty(PartyIdentification billToParty)

paymentTerms

public Invoice paymentTerms(PaymentTerms paymentTerms)

getPaymentTerms

public PaymentTerms getPaymentTerms()

Get paymentTerms

Returns:

paymentTerms

setPaymentTerms

public void setPaymentTerms(PaymentTerms paymentTerms)

invoiceTotal

public Invoice invoiceTotal(Money invoiceTotal)

getInvoiceTotal

public Money getInvoiceTotal()

Get invoiceTotal

Returns:

invoiceTotal

setInvoiceTotal

public void setInvoiceTotal(Money invoiceTotal)

taxDetails

public Invoice taxDetails(java.util.List<TaxDetails> taxDetails)

addTaxDetailsItem

public Invoice addTaxDetailsItem(TaxDetails taxDetailsItem)

getTaxDetails

public java.util.List<TaxDetails> getTaxDetails()

Total tax amount details for all line items.

Returns:

taxDetails

setTaxDetails

public void setTaxDetails(java.util.List<TaxDetails> taxDetails)

additionalDetails

public Invoice additionalDetails(java.util.List<AdditionalDetails> additionalDetails)

addAdditionalDetailsItem

public Invoice addAdditionalDetailsItem(AdditionalDetails additionalDetailsItem)

getAdditionalDetails

public java.util.List<AdditionalDetails> getAdditionalDetails()

Additional details provided by the selling party, for tax related or other purposes.

Returns:

additionalDetails

setAdditionalDetails

public void setAdditionalDetails(java.util.List<AdditionalDetails> additionalDetails)

chargeDetails

public Invoice chargeDetails(java.util.List<ChargeDetails> chargeDetails)

addChargeDetailsItem

public Invoice addChargeDetailsItem(ChargeDetails chargeDetailsItem)

getChargeDetails

public java.util.List<ChargeDetails> getChargeDetails()

Total charge amount details for all line items.

Returns:

chargeDetails

setChargeDetails

public void setChargeDetails(java.util.List<ChargeDetails> chargeDetails)

allowanceDetails

public Invoice allowanceDetails(java.util.List<AllowanceDetails> allowanceDetails)

addAllowanceDetailsItem

public Invoice addAllowanceDetailsItem(AllowanceDetails allowanceDetailsItem)

getAllowanceDetails

public java.util.List<AllowanceDetails> getAllowanceDetails()

Total allowance amount details for all line items.

Returns:

allowanceDetails

setAllowanceDetails

public void setAllowanceDetails(java.util.List<AllowanceDetails> allowanceDetails)

items

public Invoice items(java.util.List<InvoiceItem> items)

addItemsItem

public Invoice addItemsItem(InvoiceItem itemsItem)

getItems

public java.util.List<InvoiceItem> getItems()

The list of invoice items.

Returns:

items

setItems

public void setItems(java.util.List<InvoiceItem> items)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object