Skip to main content

InvoiceDetailResponse

email objectnullable
email_tokenuuid
eml_fromstring
eml_tostring
eml_replytostringnullable
eml_subjectstringnullable
eml_bodystringnullable
eml_receiveddate-timenullable
invoice object

Invoice header data with mapped fields

idintegerrequired
statusintegerrequired
status_info object

Human-friendly metadata for the numeric invoice status

codeintegerrequired

Numeric status code (e.g., 90, 91, 92, 93, 95, 96, 97, 98, 100)

keystringrequired

Stable machine key (e.g., PENDING_INTEGRATION_FIRST)

labelstringrequired

Short label (human-readable)

descriptionstringnullable

Longer description, if available

email_tokenuuid
invoice_tokenuuidrequired
created_atdate-timenullable
updated_atdate-timenullable
fields object[]required

Captured header fields (non-null by default; includeNull=true to force nulls)

  • Array [
  • keystringrequired

    Stable machine key (field_name)

    labelstringrequired

    Human-readable label (ui_name)

    valuenullable

    Field value (string/number/date/etc.)

  • ]
  • lines object[]

    Invoice line items with mapped fields

  • Array [
  • idintegerrequired
    invoice_idintegerrequired
    invoice_line_number object
    oneOf
    integer
    created_atdate-timenullable
    updated_atdate-timenullable
    fields object[]required
  • Array [
  • keystringrequired

    Stable machine key (field_name)

    labelstringrequired

    Human-readable label (ui_name)

    valuenullable

    Field value (string/number/date/etc.)

  • ]
  • ]
  • addresses object[]
  • Array [
  • address_typestring
    address_namestringnullable
    streetstringnullable
    citystringnullable
    statestringnullable
    postal_codestringnullable
    countrystringnullable
  • ]
  • taxes object[]
  • Array [
  • tax_namestringnullable
    tax_rate objectnullable
    oneOf
    number
    tax_base_amount objectnullable
    oneOf
    number
    tax_amount objectnullable
    oneOf
    number
    tax_descriptionstringnullable
  • ]
  • charges object[]
  • Array [
  • charge_namestringnullable
    charge_amount objectnullable
    oneOf
    number
  • ]
  • discounts object[]
  • Array [
  • discount_descriptionstringnullable
    discount_rate objectnullable
    oneOf
    number
    discount_amount objectnullable
    oneOf
    number
    discount_due_datedate-timenullable
  • ]
  • attachments object[]
  • Array [
  • attachment_tokenuuidrequired
    file_namestringrequired
    content_typestringrequired

    MIME type

    typestringrequired

    Possible values: [INVOICE_IMAGE, EMAIL_ATTACHMENT, EMAIL]

    parent_tokenstringnullable

    Public token of the parent attachment if derived

  • ]
  • matchAI object[]
  • Array [
  • idintegerrequired
    invoice_idintegerrequired
    order_number_1stringnullable
    order_line_number_1integernullable
    product_code_1stringnullable
    receipt_numberstringnullable
    receipt_line_numberintegernullable
    quantity objectnullable
    oneOf
    number
    unit_price objectnullable
    oneOf
    number
    unit_of_measurestringnullable
    net_amount objectnullable
    oneOf
    number
    confidence_scorenumbernullable

    Confidence score (0.0 - 1.0)

    reasonstringnullable

    AI reasoning for the match suggestion

    created_atdate-timenullable
    updated_atdate-timenullable
  • ]
  • InvoiceDetailResponse
    {
    "email": {
    "email_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "eml_from": "string",
    "eml_to": "string",
    "eml_replyto": "string",
    "eml_subject": "string",
    "eml_body": "string",
    "eml_received": "2024-07-29T15:51:28.071Z"
    },
    "invoice": {
    "id": 0,
    "status": 0,
    "status_info": {
    "code": 0,
    "key": "string",
    "label": "string",
    "description": "string"
    },
    "email_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "invoice_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "fields": [
    {
    "key": "string",
    "label": "string"
    }
    ]
    },
    "lines": [
    {
    "id": 0,
    "invoice_id": 0,
    "invoice_line_number": 0,
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "fields": [
    {
    "key": "string",
    "label": "string"
    }
    ]
    }
    ],
    "addresses": [
    {
    "address_type": "string",
    "address_name": "string",
    "street": "string",
    "city": "string",
    "state": "string",
    "postal_code": "string",
    "country": "string"
    }
    ],
    "taxes": [
    {
    "tax_name": "string",
    "tax_rate": 0,
    "tax_base_amount": 0,
    "tax_amount": 0,
    "tax_description": "string"
    }
    ],
    "charges": [
    {
    "charge_name": "string",
    "charge_amount": 0
    }
    ],
    "discounts": [
    {
    "discount_description": "string",
    "discount_rate": 0,
    "discount_amount": 0,
    "discount_due_date": "2024-07-29T15:51:28.071Z"
    }
    ],
    "attachments": [
    {
    "attachment_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "file_name": "string",
    "content_type": "string",
    "type": "INVOICE_IMAGE",
    "parent_token": "string"
    }
    ],
    "matchAI": [
    {
    "id": 0,
    "invoice_id": 0,
    "order_number_1": "string",
    "order_line_number_1": 0,
    "product_code_1": "string",
    "receipt_number": "string",
    "receipt_line_number": 0,
    "quantity": 0,
    "unit_price": 0,
    "unit_of_measure": "string",
    "net_amount": 0,
    "confidence_score": 0,
    "reason": "string",
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z"
    }
    ]
    }