Documents

Preview an invoice import

A document the parser is still reading answers its status and no items. A document the parser failed on answers 422 with the reason, and 503 when the fault is ours. The plan must carry the feature invoice_parsing.

The answer holds `resolved` and `unresolved` (what the parser read), `invoice_meta` (what the invoice itself says) and `diff` (how the invoice compares with the order). `diff` reads for a person: the import writes the lines of the body and removes nothing. Every list of the diff stops at 100 lines, and `diff.diff_summary` keeps the real counts.

`po_level_changes` compares the order with the lines the parser matched, so its `subtotal` counts `resolved` alone. The total of the invoice is `invoice_meta.subtotal`.
get/api/v1/documents/{id}/import-preview

Request

  • Base URL: https://app.sellerassistant.app (the document declares no server; this is the origin it was published from)
  • URL: https://app.sellerassistant.app/api/v1/documents/{id}/import-preview
  • Auth: one of:
    • API key in query parameter api_key
    • API key in header X-Api-Key

Path parameters

idinteger required
Example:5

Response

What the parser read

Example response

{
  "data": {
    "status": "parsed",
    "document_id": 5
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.