Supplier Reconciliation Match Overview Ep
POST/v1/supplier_reconciliation/match/overview
Supplier Reconciliation Match Overview
Retrieves all supplier reconciliation matches for a given date range with optional filtering.
Provides a simplified, flat view of supplier invoice-to-BOL matching data for easier integration.
Request
from_date: datetime
The start date and time for which to retrieve supplier reconciliation matches. Will be converted to UTC based on the timezone parameter.
to_date: datetime
The end date and time for which to retrieve supplier reconciliation matches. Will be converted to UTC based on the timezone parameter.
status: str | None = None
Optional status filter. Valid values: "approved", "unapproved", "unmatched", "void", "hold", "open".
supplier_name: str | None = None
Optional supplier name filter to restrict results to a specific supplier.
invoice_number: str | None = None
Optional invoice number filter.
bol_number: str | None = None
Optional BOL number filter.
timezone: str | None = "UTC"
Timezone for the from_date and to_date parameters. Dates will be converted to UTC for querying.
Response
rows: list[RecMatchRow] = []
List of match result objects.
Show Result Attributes
id: str
Unique identifier for the match.
status: SRInvoiceStatus
The current status of the match (e.g., "approved", "unapproved", "unmatched", "void", "hold").
supplier_id: str
The supplier's unique identifier.
supplier_name: str
The supplier's name.
suppliers: list[str] = []
Every supplier name represented in this match.
has_multiple_suppliers: bool = False
Whether the match spans more than one supplier.
bol_date: datetime | None = None
The earliest BOL date for this match, in the terminal's timezone. A bol_date_local
companion carrying the IANA timezone is emitted alongside it.
bol_numbers: list[NumberId] = []
The BOLs in this match, each as a number / id pair.
Show Child Attributes
number: str
The BOL number.
id: str
Internal identifier of the BOL.
invoice_numbers: list[InvoiceNumberId] = []
The supplier invoices in this match, with their audit metadata.
Show Child Attributes
number: str
The invoice number.
id: str
Internal identifier of the invoice.
created_by: str | None = None
The user who created the invoice.
created_date: datetime | None = None
When the invoice was created.
updated_by: str | None = None
The user who last updated the invoice.
updated_date: datetime | None = None
When the invoice was last updated.
invoice_date: datetime | None = None
Date of the invoice.
invoice_due_date: datetime | None = None
The earliest invoice due date in this match.
invoice_received_date: datetime | None = None
The earliest date an invoice in this match was received.
invoice_bol_date: datetime | None = None
The BOL date as stated on the invoice, in the terminal's timezone.
order_numbers: list[NumberId] = []
The orders associated with this match, each as a number / id pair.
po_numbers: list[str] = []
The purchase order numbers associated with this match.
invoice_total: float | None = None
Total invoice amount for this match.
bol_total: float | None = None
Total BOL amount for this match.
terminals: list[str] = []
List of terminal names associated with this match.
terminal_states: list[str] = []
The states of those terminals.
destinations: list[DestinationView] = []
The delivery destinations in this match.
Show Child Attributes
site_name: str
Name of the destination site.
site_number: str
Store number of the destination site.
destination_states: list[str] = []
The states of those destinations.
products: list[str] = []
List of product names associated with this match.
bol_carrier: str | None = None
The carrier recorded on the BOLs.
invoice_carriers: list[str] = []
The carriers recorded on the invoices.
source_name: str | None = None
The supplier name exactly as it appeared on the source invoice, before mapping.
assignee: Assignee | None = None
The user this match is assigned to.
Show Child Attributes
username: str
The assignee's username.
name: str
The assignee's display name.
details: list[RecMatchDetailRow] = []
The per-invoice breakdown behind this match.
Show Child Attributes
invoice_id: str | None = None
Internal identifier of the invoice.
invoice_number: str | None = None
The invoice number.
invoice_date: datetime | None = None
Date of the invoice.
invoice_due_date: datetime | None = None
Due date of the invoice.
creation_date: datetime | None = None
When the invoice record was created.
supplier: str | None = None
The supplier on this invoice.
terminal: str | None = None
The terminal on this invoice.
products: list[str] = []
The products on this invoice.
bol_numbers: list[str] = []
The BOL numbers matched to this invoice.
bol_date: datetime | None = None
The BOL date for this invoice.
order_numbers: list[int] = []
The order numbers matched to this invoice.
bol_total: float | None = None
BOL amount for this invoice.
invoice_total: float | None = None
Invoiced amount for this invoice.
warnings: list[SRWarning] = []
Variance warnings raised against this match.
Show Child Attributes
type: str
The kind of warning.
threshold: float | None = None
The configured threshold that was breached.
variance: float | None = None
The measured variance.
extra_date: datetime | None = None
A supporting date for the warning, when applicable.
hold_reason: str | None = None
Why the match is on hold, if it is.
hold_date: datetime | None = None
When the match was placed on hold.
hold_by: str | None = None
The user who placed the match on hold.
export_status: ERPStatus | None = pending
The ERP export status for this match.
can_approve: bool = False
Whether this match is currently eligible for approval.
approval_block_reason: str | None = None
Why approval is blocked, when can_approve is False.
approval_warning_note: str | None = None
A non-blocking warning to surface when approving.
timezone_data: dict | None = None
Timezone lookup data backing the _local companions on the terminal-timezone date fields.
unmapped_supplier_names: list[str]
List of supplier names from invoices that have not been mapped to an internal supplier.
unmapped_invoice_count: int
Count of invoices with unmapped suppliers.
params: list[SmartGridParams] = []
Grid column metadata describing the filterable columns available for these rows.
Show Child Attributes
title: str
Display title of the column.
datatype: str
The column's data type.
filter_column: str
The field name to filter on.
options: list[Any] | None = None
The set of selectable values, when the column is a set filter.
Responses
- 200
- 422
Successful Response
- application/json
- Example (from schema)
{
"rows": [
{
"timezone_data": {},
"id": "string",
"supplier_id": "string",
"supplier_name": "string",
"status": "approved",
"bol_date": "2026-09-25T19:33:18.409Z",
"bol_numbers": [
{
"number": "string",
"id": "string"
}
],
"invoice_numbers": [
{
"number": "string",
"id": "string",
"created_by": "string",
"created_date": "2026-09-25T19:33:18.409Z",
"updated_by": "string",
"updated_date": "2026-09-25T19:33:18.409Z"
}
],
"invoice_due_date": "2026-09-25T19:33:18.409Z",
"invoice_date": "2026-09-25T19:33:18.409Z",
"invoice_received_date": "2026-09-25T19:33:18.409Z",
"invoice_bol_date": "2026-09-25T19:33:18.409Z",
"order_numbers": [
{
"number": "string",
"id": "string"
}
],
"invoice_total": 0,
"bol_total": 0,
"suppliers": [
"string"
],
"has_multiple_suppliers": false,
"terminals": [
"string"
],
"terminal_states": [
"string"
],
"destinations": [
{
"site_name": "string",
"site_number": "string"
}
],
"destination_states": [
"string"
],
"products": [
"string"
],
"bol_carrier": "string",
"invoice_carriers": [
"string"
],
"source_name": "string",
"assignee": {
"username": "string",
"name": "string"
},
"details": [
{
"invoice_id": "string",
"invoice_number": "string",
"invoice_due_date": "2026-09-25T19:33:18.409Z",
"invoice_date": "2026-09-25T19:33:18.409Z",
"creation_date": "2026-09-25T19:33:18.409Z",
"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"
}
]
},
"products": [
{
"source_name": "string",
"internal_id": "string",
"internal_name": "string",
"alternate_matches": [
{
"internal_id": "string",
"internal_name": "string"
}
]
}
],
"bol_numbers": [
{
"number": "string",
"id": "string"
}
],
"bol_date": "2026-09-25T19:33:18.409Z",
"order_numbers": [
{
"number": "string",
"id": "string"
}
],
"bol_total": 0,
"invoice_total": 0
}
],
"warnings": [
{
"type": "supplier_mismatch",
"threshold": 0,
"variance": 0,
"extra_date": {}
}
],
"po_numbers": [
"string"
],
"hold_reason": "string",
"hold_date": "2026-09-25T19:33:18.409Z",
"hold_by": "string",
"export_status": "sent",
"can_approve": false,
"approval_block_reason": "string",
"approval_warning_note": "string"
}
],
"unmapped_supplier_names": [
"string"
],
"unmapped_invoice_count": 0,
"params": [
{
"title": "string",
"datatype": "string",
"filter_column": "string",
"options": [
null
]
}
]
}
Validation Error
- application/json
- Example (from schema)
{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}