Document field reference

Header fields

  • DocTypeId: required, the type of document (see Document Types)

  • Description: required; (max 200 characters)

  • ContactAccountId: required, the contact account (customer, supplier, etc.)

  • LegalEntityId: optional, if not specified it will default to the User or Environment default Legal entity setting.

  • TaxAuthorityId: optional, applicable only to legal entities with multiple tax registrations. If not specified it will default to the default Tax authority of the contact account.

  • ResponsibleResourceId: optional, not defaulted

  • DocDate: optional, defaults to today

  • DueDate: optional, calculates based on contact account's payment terms

  • TaxDate: optional, defaults based on legal entities tax point setup.

  • Currency: optional, defaults to contact account's default currency or legal entity base currency.

  • CurrencyRate: optional, defaults to document's date exchange rate using the document type configured rate type.

  • TheirDocNo: optional / required based on contact account setup. (Invoice no required on Suppliers)

  • TheirRef: optional, additional reference

  • LegacyRef: optional, additional reference

  • IntRef: optional, internal reference, details

  • Post: optional, JSON object

    Any additional posting fields configured as part of Chart of Account rules. This is a JSON object where the keys are the posting Attributes codes and the values are the attributes values. These might contain any standard or environment defined posting attributes (prefixed with X_).

    The API does not perform any validation of these values before accepting the request. Any posting fields validation will be done as part of the document authorisation and ledger posting.

    Examples:

    • { "CostCentre": "A1" }
    • { "Resource": "JD", "Activity": "IMPL", "X_Manager": "BM" }

  • Ext: optional, JSON object

  • TextHeader: text printed on documents before the liens

  • TextHeader: text printed on documents after the liens

  • NetCurrencyAmount / TaxCurrencyAmount / GrossCurrencyAmount: optional, net/tax/gross totals in document currency.

  • NetAmount / TaxAmount / GrossAmount: optional, net/tax/gross totals in legal entity base currency.

Detail fields

Document Details are specified as a JSON array. If no detail lines are required (e.g. on a Receipt or Payment transaction) this section can be omitted.

  • ProductId: optional

  • ProductSkuId: optional

  • AccountId: optional / required, defaulted from product account setup, required if the ProductId field is not specified

  • Description: optional, max length: 250, defaulted from product / account description.

  • TaxBandId: optional, defaulted from Product / Contact Account setup.

  • TaxCodeId: optional, defaulted based on the TaxBandId and the current Legal Entity / Tax Authority calculation.

  • Quantity: optional, defaulted to product default quantity or 1.

  • ProjectId: optional

  • IsNetEntry: optional, defaults to document type setup. Determines if the unit price is net (IsNetEntry=true) or gross (IsNetEntry=false)

  • CurrencyUnitPrice: optional, defaults to product

  • TextPre: optional text printed before the line

  • TextPost: optional text printed after the line

  • LegacyRef: optional, max length: 50

  • IntRef: optional, max length: 50

  • IsResale: optional, boolean: Is purchased for resale purposes, only applicable in certain tax authorities.

  • ProductType: optional, text(1): G for Goods, S for Services, leave blank when not known.

  • NetCurrencyAmount / TaxCurrencyAmount / GrossCurrencyAmount: optional, net/tax/gross totals in document currency.

  • NetAmount / TaxAmount / GrossAmount: optional, net/tax/gross totals in legal entity base currency.