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. An inv_value of null means that the invoice does not show that cost. It is not a change, and the order keeps its cost.

A line of changed or unchanged compares on the price basis of the order item. Its changes hold the values that the import writes: the price of one case for an item priced per case, and the quantity in units. item_unit_cost and item_unit_count give the same values for a line with no change. basis tells if the line price is per unit or per case. basis_unknown is true when SA is not sure of the basis: neither the price nor the quantity tells it, the price is 10% to 25% off the item price, or the quantity tells the other basis. basis is the basis that the import writes. With no basis found, it is unit.

Until the document is applied, the diff compares the invoice with the order as it is now.

API Key

Add parameter in query

api_key

Example:

api_key: ********************

API Key

Add parameter in header

X-Api-Key

Example:

X-Api-Key: ********************

Responses

🟢200

application/json

What the parser read

Bodyapplication/json

Example

{
    "data": {
        "status": "uploaded",
        "document_id": 5,
        "items": [
            {}
        ]
    }
}

🟠403AccessDenied

🟠404NotFound

🟠422BusinessLogicError

🟠429TooManyRequests

🔴503ServiceUnavailable

Request

Request Code Samples

Responses