Objects

DocInvoiceFields

Fields

• vendorDocInvoiceParty
• customerDocInvoiceParty
• numberstring
• issue_datestring

  ISO YYYY-MM-DD

• due_datestring
• currencystring

  ISO 4217

• subtotalstring
• taxarray of DocInvoiceTax
• totalstring
• paid_atstring (date)

  Payment date, if the document states it (YYYY-MM-DD).

• amount_paidstring

  Amount paid as printed in the document, as a decimal string.

• amount_duestring

  Amount due as printed in the document (“Amount due 0.00” on a paid invoice), as a decimal string.

• paidboolean

  The document is paid: it is a receipt, has a payment date, a paid stamp or note, an amount due of 0, an amount paid no less than the total, a matched payout in a bank statement or payment register, or a manual mark. An amount due greater than zero means it is not paid. In manual values (CardInvoicePatch.fields), this is the user's mark, which overrides the signals in the document; null clears it. Confirming the extracted values (confirmed without fields) does not fix the paid mark.

• paid_sourcestring

  Where the paid flag comes from (only in the extraction result; not accepted in manual values): a manual mark (manual), a receipt (receipt), a payment date (paid_at), a paid stamp or note (stamp), an amount due of 0 (amount_due_zero), an amount paid no less than the total (amount_paid), or a payout in a bank statement or payment register (payment). If absent, no payment was found.

  Allowed values: manualreceiptpaid_atstampamount_due_zeroamount_paidpayment

• payment_termsstring
• linesarray of DocInvoiceLine
• categoryCategoryRef

  Category of the whole invoice: the subcategory with the largest sum of line items. In manual values, the category for all line items that have no category of their own.

• vendor_activityCategoryRef

  Type of business of the invoice's counterparty (only in the extraction result; edit it in the counterparty directory).

Part of

DocInvoiceExtraction