Skip to main content

Supplier Recon Invoice Create

POST 
/v1/supplier_reconciliation/invoice/create

Supplier Reconciliation Invoice Create

Creates a new invoice from a supplier that feeds to the reconciliation process. The invoice undergoes mapping application and automatic reconciliation to BOL before being inserted into the system.

Required Scopes (io.w)

Request​

The request is a SupplierInvoiceV1 object with the following properties:

invoice_number: str
Unique invoice number provided by the supplier.

source_name: str
Name of the source system or integration providing the invoice.

supplier: OnlyExternalObject
External object representing the supplier information.

terminal: OnlyExternalObject | None
Optional external object representing the terminal location.

due_date_utc: datetime | None
Optional due date for the invoice in UTC.

due_date_local: datetime | None
Optional due date for the invoice in local timezone.

invoice_date: datetime | None
Optional date the invoice is marked with in UTC. This will be used to match to the BOL if individual BOL times are not provided.

invoice_date_local: datetime | None
Optional date the invoice is marked with in local timezone of the terminal.

details: list[SupplierInvoiceV1Detail]
List of invoice detail line items containing:

  • bol_number: str | None - Optional bill of lading number
  • bol_date: datetime | None - Optional date of the bill of lading in UTC. Will be used to match the invoice to BOL if provided.
  • bol_date_local: datetime | None - Optional date of the bill of lading in local timezone of the terminal.
  • type: InvoiceDetailType - Required invoice detail type classification
  • product: OnlyExternalObject | None - Optional product information
  • rate: float | None - Optional unit rate
  • amount: float | None - Optional line amount before total calculation
  • total: float - Required total amount for the line item
  • uom: str | None - Optional unit of measure
  • gross_volume: float | None - Optional gross volume quantity
  • net_volume: float | None - Optional net volume quantity

ship_to_city: str | None = None
City the product was shipped to, as stated on the invoice.

ship_to_state: str | None = None
State the product was shipped to, as stated on the invoice.

ship_from_city: str | None = None
City the product was shipped from, as stated on the invoice.

ship_from_state: str | None = None
State the product was shipped from, as stated on the invoice.

invoice_carriers: list[str] = []
Carriers named on the invoice. Stored de-duplicated and sorted.

extra_data: dict = {}
Any additional data provided or managed by the client through integration endpoints.


Response​

The endpoint processes the invoice through mapping and reconciliation, then inserts it into the system. No explicit response body is returned on successful creation.

Responses​

Successful Response

Loading...