Invoice Master Input Model
Fields
| Field | Description | Type | |
|---|---|---|---|
docDate | Document date. Value must be within the date range of Fiscal Year. | date | required for new records |
debtorCode | Debtor code. Value must be an existing customer code in Cloud Accounting web application. | string | required for new records |
debtorName | Debtor name. | string, maxLength(100) | required for new records |
creditTerm | Credit term. Value must be an existing credit term in Cloud Accounting web application. | string | required for new records |
salesLocation | Sales location. Value must be an existing location in Cloud Accounting web application. | string | required for new records |
Optional Fields
| Field | Description | Type | |
|---|---|---|---|
docNo | Document number of record. More information can be found here. | string, maxLength(50) | |
docNoFormatName | Document numbering format. Value must be an existing numbering format name in Cloud Accounting web application. More information can be found here. | string | |
taxDate | Tax date. Value must be on or after docDate. | date | nullable |
email | Email address. | string, maxLength(255) | |
emailCC | Email address CC. | string, maxLength(255) | |
emailBCC | Email address BCC. | string, maxLength(255) | |
address | Address. | string, maxLength(200) | |
attention | Customer name (for billing). | string, maxLength(40) | |
phone1 | Phone number. | string, maxLength(25) | |
fax1 | Fax number. | string, maxLength(25) | |
deliverAddress | Delivery address. | string, maxLength(200) | |
deliverContact | Customer name (for delivery). | string, maxLength(40) | |
deliverPhone1 | Delivery phone number. | string, maxLength(25) | |
deliverFax1 | Delivery fax number. | string, maxLength(25) | |
ref | Document reference. | string, maxLength(40) | |
description | Invoice document description. | string, maxLength(80) | |
taxExemptionNo | Tax exemption number. | string, maxLength(60) | nullable |
taxExemptionExpiryDate | Tax exemption expiry date | date | nullable |
note | Document notes. (HTML) | string | |
remark1 | Document remarks. | string, maxLength(40) | |
remark2 | Document remarks. | string, maxLength(40) | |
remark3 | Document remarks. | string, maxLength(40) | |
remark4 | Document remarks. | string, maxLength(40) | |
salesAgent | Sales agent. Value must be an existing sales agent in Cloud Accounting web application. | string | |
currencyRate | Rate of document currency against local currency. | number | |
inclusiveTax | Inclusive tax flag. | boolean | |
isRoundAdj | Rounding adjustment flag. More information can be found here. | boolean | |
paymentMethod | Payment method. Value must be an existing payment method in Cloud Accounting web application. | string | |
toBankRate | Conversion rate from document currency to payment method's bank account currency. More information can be found here. | number | |
paymentAmt | Payment amount. | number | |
paymentRef | Payment reference. | string, maxLength(20) | |
ReferenceNumberOfCustomsFormNo1And9 | Reference Number of Customs Form No.1, 9, etc. | string, maxLength(20) | nullable |
Incoterms | Incoterms. | string, maxLength(3) | nullable |
FreeTradeAgreementInformation | Free Trade Agreement (FTA) Information. | string, maxLength(100) | nullable |
AuthorisationNumberForCertifiedExporter | Authorisation Number for Certified Exporter. | string, maxLength(100) | nullable |
ReferenceNumberOfCustomsFormNo2 | Reference Number of Customs Form No.2. | string, maxLength(12) | nullable |
ShippingRecipientTaxEntity | Shipping recipient's tax entity. | string, maxLength(100) | nullable |
FreightAllowanceCharge | Other charges amount. | number | nullable |
FreightAllowanceChargeReason | Reason of other charges. | string, maxLength(300) | nullable |
submitEInvoice | Submit e-Invoice. | boolean | |
submitConsolidatedEInvoice | Submit Consolidated e-Invoice. | boolean | |
eInvoiceIssueDateTime | e-Invoice issue datetime. | date | nullable |
eInvoiceUuid | e-Invoice UUID. | string | nullable |
info
The paymentMethod, paymentAmt and paymentRef fields are used for quick payment action.
When partial payments are made, the remaining amount will be forwarded and an outstanding transaction will be created.
Example scenario
A customer buys $200 worth of products which will be collected 10 days later. The customer pays $100 upfront and will pay $100 upon picking up the products.
In this case paymentMethod is "CASH" and paymentAmt is 100.
The remaining $100 will be forwarded and an outstanding transaction of $100 will be created.