Skip to main content

Supplier Recon Invoice All

POST 
/v1/supplier_reconciliation/invoice/all

Get All Supplier Invoices

Retrieves a list of supplier invoices based on specified filter criteria. This endpoint is used to query invoices for reconciliation, tracking, and reporting purposes. Responses limited to 5,000 invoices.

Required Scopes (ia.r)

Request​

status: InvoiceStatus | None = None
Filters invoices by their reconciliation status.

Show Statuses

"approved"
The invoice has been approved.

"unapproved"
The invoice is unapproved.

"unmatched"
The invoice is unmatched.

"void"
The invoice has been voided.

"hold"
The invoice is on hold.

due_date_start: datetime | None = None
The start date for filtering invoices by their due date.

due_date_end: datetime | None = None
The end date for filtering invoices by their due date.

last_change_date: datetime | None = None
Filters invoices based on the last time they were changed.

suppliers: list[str] | None = None
A list of supplier names to filter invoices by.

invoice_numbers: list[str] | None = None
A list of invoice numbers to filter invoices by.

include_exported: bool = False
When set to False, excludes invoices that have been marked as exported from the results.


Response​

Returns a list of SupplierInvoiceResp objects, each containing the following fields:

id: PydanticObjectId
The unique identifier for the invoice.

invoice_number: str
The unique number for the invoice.

source_name: str
The name of the source system from which the invoice was received.

due_date_utc: datetime | None = None
The due date of the invoice in UTC.

invoice_date: datetime | None = None
The date of the invoice.

creation_date: datetime
The date and time when the invoice was created.

approved_match_id: str | None = None
The identifier of the approved match for this invoice.

supplier: ExternalObject
Object containing supplier details.

Show Child Attributes

source_name: str
The name of the source system.

internal_id: str | None = None
The internal identifier of the supplier.

internal_name: str | None = None
The internal name of the supplier.

alternate_matches: list[InternalObject] = []
List of alternate internal object matches.

terminal: ExternalObject | None = None
Object containing terminal details.

Show Child Attributes

source_name: str
The name of the source system.

internal_id: str | None = None
The internal identifier of the terminal.

internal_name: str | None = None
The internal name of the terminal.

alternate_matches: list[InternalObject] = []
List of alternate internal object matches.

details: list[SupplierInvoiceDetail]
A list of the invoice line item details.

Show Child Attributes

id: PydanticObjectId | None
The unique identifier for the detail line.

bol_number: str | None = None
The bill of lading number associated with the detail line.

type: InvoiceDetailType
The type of the invoice detail line.

product: ExternalObject | None = None
Product details for the line item.

tax_type: str | None = None
The tax type for the line item.

tax_authority: str | None = None
The tax authority for the line item.

tax_non_deferred: bool | None = None
Whether the tax is non-deferred.

state: str | None = None
The state for the line item.

rate: float | None = None
The rate for the line item.

amount: float | None = None
The billable amount for the line item.

total: float
The total cost for the line item.

uom: str | None = None
The unit of measure for the line item.

gross_volume: float | None = None
The gross volume for the line item.

net_volume: float | None = None
The net volume for the line item.

void: bool = False
Whether the invoice has been voided.

last_change_date: datetime | None = None
The date and time of the last change to the invoice reconciliation.

status: str | None = None
The current reconciliation status of the invoice. Possible values: approved, unapproved, unmatched, void, hold.

matched_bols: list[MatchedBol] | None = None
A list of BOLs that have been matched to this invoice.

Show Child Attributes

bol_number: str | None = None
The bill of lading number.

bol_id: str | None = None
The internal identifier of the bill of lading.

matched_orders: list[MatchedOrder] | None = None
A list of orders that have been matched to this invoice.

Show Child Attributes

order_number: str | None = None
The order number.

order_id: str | None = None
The internal identifier of the order.

po_number: str | None = None
The purchase order number for the order.

Responses​

Successful Response

[
  {
    "_id": "5eb7cf5a86d9755df3a6c593",
    "invoice_number": "string",
    "source_name": "string",
    "due_date_utc": "2025-12-17T21:49:50.713Z",
    "due_date_local": "2025-12-17T21:49:50.713Z",
    "invoice_date": "2025-12-17T21:49:50.713Z",
    "invoice_date_local": "2025-12-17T21:49:50.713Z",
    "creation_date": "2025-12-17T21:49:50.713Z",
    "approved_match_id": "string",
    "supplier": {
      "source_name": "string",
      "internal_id": "string",
      "internal_name": "string",
      "alternate_matches": [
        {
          "internal_id": "string",
          "internal_name": "string"
        }
      ]
    },
    "terminal": {
      "source_name": "string",
      "internal_id": "string",
      "internal_name": "string",
      "alternate_matches": [
        {
          "internal_id": "string",
          "internal_name": "string"
        }
      ]
    },
    "details": [
      {
        "id": "5eb7cf5a86d9755df3a6c593",
        "bol_number": "string",
        "type": "tax",
        "product": {
          "source_name": "string",
          "internal_id": "string",
          "internal_name": "string",
          "alternate_matches": [
            {
              "internal_id": "string",
              "internal_name": "string"
            }
          ]
        },
        "bol_date": "2025-12-17T21:49:50.714Z",
        "bol_date_local": "2025-12-17T21:49:50.714Z",
        "tax_type": "string",
        "tax_description": "string",
        "tax_authority": "string",
        "tax_non_deferred": true,
        "state": "string",
        "rate": 0,
        "amount": 0,
        "total": 0,
        "uom": "string",
        "gross_volume": 0,
        "net_volume": 0,
        "extra_data": {}
      }
    ],
    "extra_data": {},
    "void": false,
    "ship_to_city": "string",
    "ship_to_state": "string",
    "ship_from_city": "string",
    "ship_from_state": "string",
    "last_change_date": "2025-12-17T21:49:50.714Z",
    "status": "string",
    "matched_bols": [
      {
        "bol_number": "string",
        "bol_id": "string"
      }
    ],
    "matched_orders": [
      {
        "order_number": 0,
        "order_id": "string",
        "po_number": "string"
      }
    ],
    "is_exported": true
  }
]
Loading...