Description
The Invoice class holds the base data for each invoice.
Derived By
Extending resource
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|---|---|---|---|
billingEntityUUID |
string |
0..1 |
The UUID of the Billing Entity to which the resource belongs |
resourceCreateDate |
dateTime |
0..1 |
The creation date of the resource |
resourceKey |
0..* |
The keys attached to the resource |
|
resourceMetadata |
0..1 |
The metadata attached to the resource |
|
resourceName |
string |
0..1 |
The name of the resource |
resourceState |
0..1 |
The state of the resource |
|
resourceType |
0..1 |
The type of the resource |
|
resourceUUID |
string |
0..1 |
The UUID of the resource (read-only) |
invoiceTotalInc |
double |
1..1 |
The invoice total including tax |
invoiceDate |
dateTime |
0..1 |
The date of the invoice as printed on the invoice |
invoiceTaxAmt |
double |
1..1 |
The amount of tax associated with the invoice |
invoiceTotalExc |
double |
1..1 |
The invoice total excluding tax |
paidDate |
dateTime |
0..1 |
The date the invoice was paid |
invoiceNo |
long |
1..1 |
The invoice number |
invoiceItems |
0..* |
The invoice items |
|
customerName |
string |
0..1 |
The name associated with the invoice |
testMode |
boolean |
1..1 |
The test mode |
customerAddress |
0..1 |
The customer address field |
|
billingAddress |
0..1 |
The billing address of the invoice |
|
customerVatNo |
string |
0..1 |
The VAT number or tax reference of the customer / recipient of the invoice |
billingEntityName |
string |
0..1 |
The billing entity name of the invoice |
billingEntityVatNo |
string |
0..1 |
The VAT number or tax reference of the billing entity / invoicing party |
currencyId |
long |
1..1 |
The currency id of the invoice |
taxRate |
double |
1..1 |
The tax rate of the invoice |
pdfRef |
string |
0..1 |
The PDF reference of the invoice |
invoiceSource |
string |
0..1 |
The invoice source of the invoice |
paymentMethodUUID |
string |
0..1 |
The UUID of the payment method of the invoice |
paymentProvider |
0..1 |
The name of the payment provider of the invoice |
|
paymentProviderRef |
string |
0..1 |
The reference used by the payment provider for the invoice |
authCode |
string |
0..1 |
The authentication code of the invoice |
usingStoredCard |
boolean |
1..1 |
A flag indicating whether the invoice is issued agaist a using stored card |
cardUUID |
string |
0..1 |
The UUID of the card reference by the invoice |
customerUUID |
string |
0..1 |
The UUID of the customer |
status |
0..1 |
The invoice status |
|
dueDate |
dateTime |
0..1 |
The invoice due date |