Financial Document API version 1.11 document data.

Hierarchy

  • FinancialDocumentV1Document

Implements

Constructors

Properties

billingAddress: StringField

The customer's address used for billing.

The purchase category among predefined classes.

customerAddress: StringField

The address of the customer.

customerCompanyRegistrations: CompanyRegistrationField[] = []

List of company registrations associated to the customer.

customerId: StringField

The customer account number or identifier from the supplier.

customerName: StringField

The name of the customer.

date: DateField

The date the purchase was made.

documentNumber: StringField

The document number or identifier.

One of: 'INVOICE', 'CREDIT NOTE', 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.

dueDate: DateField

The date on which the payment is due.

invoiceNumber: StringField

The invoice number or identifier only if document is an invoice.

lineItems: FinancialDocumentV1LineItem[] = []

List of line item details.

locale: LocaleField

The locale detected on the document.

paymentDate: DateField

The date on which the payment is due / fullfilled.

poNumber: StringField

The purchase order number.

receiptNumber: StringField

The receipt number or identifier only if document is a receipt.

referenceNumbers: StringField[] = []

List of Reference numbers, including PO number.

shippingAddress: StringField

The customer's address used for shipping.

The purchase subcategory among predefined classes for transport and food.

supplierAddress: StringField

The address of the supplier or merchant.

supplierCompanyRegistrations: CompanyRegistrationField[] = []

List of company registrations associated to the supplier.

supplierEmail: StringField

The email of the supplier or merchant.

supplierName: StringField

The name of the supplier or merchant.

supplierPaymentDetails: PaymentDetailsField[] = []

List of payment details associated to the supplier.

supplierPhoneNumber: StringField

The phone number of the supplier or merchant.

supplierWebsite: StringField

The website URL of the supplier or merchant.

taxes: Taxes

List of tax lines information.

The time the purchase was made.

The total amount of tip and gratuity

totalAmount: AmountField

The total amount paid: includes taxes, tips, fees, and other charges.

totalNet: AmountField

The net amount paid: does not include taxes, fees, and discounts.

totalTax: AmountField

The total amount of taxes.

Methods

Generated using TypeDoc