Invoice Properties Record

The identifiers node references print versions of the quote and/or invoice in Excel or PDF format. Contained in Invoice Document Record

1 PROPERTIES
2 EXAMPLES
3 INSERTING
4 UPDATING

PROPERTIES

`reference`	The invoice reference.	string
`quoteNo`	The quotation number. Null if not assigned.	string?
`quoteDate`	The quotation date without time: “yyyy-mm-dd”. Null if not assigned.	date?
`invoiceNo`	The invoice number. Null if not assigned.	string?
`invoiceDate`	The invoice date without time: “yyyy-mm-dd”. Null if not assigned.	date?
`effectiveDate`	The effective date of the invoice. For example, when aggregating or distributing invoices this is done based on the effective date. Format: “yyyy-mm-dd”. Null if not assigned.	date?
`status`	The invoice or quotation status, numeric value. See Invoice status	int
`onHold`	Currently not used.	bool
`updated`	Last time the invoice or quotation was updated.	datetime
`currency`	The currency code. See settings/currencies/codes	string
`decimals`	The number of decimals for rounding amounts. Typically 2.	int
`header`	The invoice header line. This is a one-line summary or title.. Null if not assigned.	string?
`contract`	Optional contract number. Null if not assigned.	string?
`commentsInternal`	Internal comments. Visible to internal managers only and hidden from clients or suppliers. Null if not assigned.	string?
`cfsinvoice`	The invoice custom fields. See Custom Field Collection Record	object
`additionalFee`	Additional applicable fee. This mechanism of adding fees is legacy. It is recommended to use the “fee”-mechanism in the invoice details lines.	decimal?

EXAMPLES

Example payload:

{
  "reference": "TST-2023-168/7",
  "quoteNo": null,
  "quoteDate": null,
  "invoiceNo": "IV2223",
  "invoiceDate": "2023-11-05",
  "effectiveDate": "2023-11-20",
  "status": 11,
  "currency": "EUR",
  "decimals": 2,
  "header": "Translation services",
  "contract": null,
  "commentsInternal": null,
  "cfsinvoice": {
      "fields": [
          {
              "title": "Client Cat",
              "value": "A221"
          }
      ]
  },
  "additionalFee": null
}

INSERTING

When inserting new invoices, you submit a record similar to the above. The fields you may specify are:

reference : Mandatory
currency : Mandatory. For example, use EUR or USD.
decimals : Mandatory. For example, use 2.
quoteNo : Optional. Set to “*” if you want to auto assign a quote number. However, auto-assignments are also done automatically if configured by the platform admin.
quoteDate : Optional
invoiceNo : Optional. Set to “*” if you want to auto assign a quote number. However, auto-assignments are also done automatically if configured by the platform admin.
invoiceDate : Optional
effectiveDate : Optional
status : Optional. Preset to 0 (Draft) if not specified. We strongly recommend to assign the wanted status.
header : Optional
contract : Optional
commentsInternal : Optional
cfsinvoice : Optional. Specify all custom fields to assign.
additionalFee : Optional

UPDATING

Please specify all the properties, including those which values you do not want to change. Updating individual fields is not possible.

See the section above for the list of fields that can be updated.