PayableDocumentSuggestion (object)
| Field | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| amount_open_cents* | integer | Open amount on the document in cents | ||||||
| amount_total_cents* | integer | Total document amount in cents (e.g. sum gross or dunning fee) | ||||||
| contact_avatar | object |
| ||||||
| contact_company_name | string | — | ||||||
| contact_first_name | string | — | ||||||
| contact_id | integer | — | ||||||
| contact_last_name | string | — | ||||||
| contact_name | string | — | ||||||
| contact_number | integer | — | ||||||
| currency_code | string | — | ||||||
| document_date | string (date) | — | ||||||
| document_subject | string | Document subject or title when available (invoice, credit note, dunning) | ||||||
| match_reasons* | string[] | Why this document was suggested (amount exact match, counterparty name, and/or document number in reference/memo) array Elements string
| ||||||
| payable_id* | integer | — | ||||||
| payable_label* | string | — | ||||||
| payable_type* | string | string
| ||||||
| suggested_amount_cents* | integer | Suggested booking amount in cents (positive, capped by open amount and assignable remainder) |
Example (JSON)
{
"payable_type": "Invoice",
"payable_id": 0,
"payable_label": "string",
"contact_id": 0,
"contact_name": "string",
"contact_first_name": "string",
"amount_total_cents": 0,
"amount_open_cents": 0,
"match_reasons": [
"amount"
],
"suggested_amount_cents": 0
}