FinancialDocumentV1Document
extends Prediction
in package
Financial Document API version 1.11 document data.
Table of Contents
Properties
- $billingAddress : StringField
- $category : ClassificationField
- $customerAddress : StringField
- $customerCompanyRegistrations : array<string|int, CompanyRegistrationField>
- $customerId : StringField
- $customerName : StringField
- $date : DateField
- $documentNumber : StringField
- $documentType : ClassificationField
- $dueDate : DateField
- $invoiceNumber : StringField
- $lineItems : FinancialDocumentV1LineItems
- $locale : LocaleField
- $paymentDate : DateField
- $poNumber : StringField
- $receiptNumber : StringField
- $referenceNumbers : array<string|int, StringField>
- $shippingAddress : StringField
- $subcategory : ClassificationField
- $supplierAddress : StringField
- $supplierCompanyRegistrations : array<string|int, CompanyRegistrationField>
- $supplierEmail : StringField
- $supplierName : StringField
- $supplierPaymentDetails : array<string|int, PaymentDetailsField>
- $supplierPhoneNumber : StringField
- $supplierWebsite : StringField
- $taxes : Taxes
- $time : StringField
- $tip : AmountField
- $totalAmount : AmountField
- $totalNet : AmountField
- $totalTax : AmountField
Methods
- __construct() : mixed
- __toString() : string
Properties
$billingAddress
public
StringField
$billingAddress
The customer's address used for billing.
$category
public
ClassificationField
$category
The purchase category among predefined classes.
$customerAddress
public
StringField
$customerAddress
The address of the customer.
$customerCompanyRegistrations
public
array<string|int, CompanyRegistrationField>
$customerCompanyRegistrations
List of company registrations associated to the customer.
$customerId
public
StringField
$customerId
The customer account number or identifier from the supplier.
$customerName
public
StringField
$customerName
The name of the customer.
$date
public
DateField
$date
The date the purchase was made.
$documentNumber
public
StringField
$documentNumber
The document number or identifier.
$documentType
public
ClassificationField
$documentType
One of: 'INVOICE', 'CREDIT NOTE', 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
$dueDate
public
DateField
$dueDate
The date on which the payment is due.
$invoiceNumber
public
StringField
$invoiceNumber
The invoice number or identifier only if document is an invoice.
$lineItems
public
FinancialDocumentV1LineItems
$lineItems
List of line item details.
$locale
public
LocaleField
$locale
The locale detected on the document.
$paymentDate
public
DateField
$paymentDate
The date on which the payment is due / fullfilled.
$poNumber
public
StringField
$poNumber
The purchase order number.
$receiptNumber
public
StringField
$receiptNumber
The receipt number or identifier only if document is a receipt.
$referenceNumbers
public
array<string|int, StringField>
$referenceNumbers
List of Reference numbers, including PO number.
$shippingAddress
public
StringField
$shippingAddress
The customer's address used for shipping.
$subcategory
public
ClassificationField
$subcategory
The purchase subcategory among predefined classes for transport and food.
$supplierAddress
public
StringField
$supplierAddress
The address of the supplier or merchant.
$supplierCompanyRegistrations
public
array<string|int, CompanyRegistrationField>
$supplierCompanyRegistrations
List of company registrations associated to the supplier.
$supplierEmail
public
StringField
$supplierEmail
The email of the supplier or merchant.
$supplierName
public
StringField
$supplierName
The name of the supplier or merchant.
$supplierPaymentDetails
public
array<string|int, PaymentDetailsField>
$supplierPaymentDetails
List of payment details associated to the supplier.
$supplierPhoneNumber
public
StringField
$supplierPhoneNumber
The phone number of the supplier or merchant.
$supplierWebsite
public
StringField
$supplierWebsite
The website URL of the supplier or merchant.
$taxes
public
Taxes
$taxes
List of tax lines information.
$time
public
StringField
$time
The time the purchase was made.
$tip
public
AmountField
$tip
The total amount of tip and gratuity
$totalAmount
public
AmountField
$totalAmount
The total amount paid: includes taxes, tips, fees, and other charges.
$totalNet
public
AmountField
$totalNet
The net amount paid: does not include taxes, fees, and discounts.
$totalTax
public
AmountField
$totalTax
The total amount of taxes.
Methods
__construct()
public
__construct(array<string|int, mixed> $rawPrediction[, int|null $pageId = null ]) : mixed
Parameters
- $rawPrediction : array<string|int, mixed>
-
Raw prediction from HTTP response.
- $pageId : int|null = null
-
Page number for multi pages document.
Tags
__toString()
public
__toString() : string
Return values
string —String representation.