Skip to main content

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.

Required Scopes (ia.r)

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​

results: list
List of match result objects.

Show Result Attributes

match_id: str
Unique identifier for the match.

status: str
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.

bol_date: datetime | None
The earliest BOL date for this match.

invoice_total: float | None
Total invoice amount for this match.

bol_total: float | None
Total BOL amount for this match.

terminals: list[str]
List of terminal names associated with this match.

products: list[str]
List of product names associated with this match.

export_status: str | None
The ERP export status for this match.

invoices: list
List of invoices in this match.

Show Invoice Attributes

invoice_id: str | None
Unique identifier for the invoice.

invoice_number: str | None
The invoice number.

invoice_date: datetime | None
Date of the invoice.

invoice_due_date: datetime | None
Due date of the invoice.

total: float | None
Total amount on the invoice.

bols: list
List of BOLs in this match.

Show BOL Attributes

bol_id: str | None
Unique identifier for the BOL.

bol_number: str | None
The BOL number.

bol_date: datetime | None
Date of the BOL.

order_id: str | None
The associated order ID.

order_number: int | None
The associated order number.

po_number: str | None
The purchase order number.

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.

Responses​

Successful Response

{
  "rows": [
    {
      "timezone_data": {},
      "id": "string",
      "supplier_id": "string",
      "supplier_name": "string",
      "status": "approved",
      "bol_date": "2026-05-11T19:25:52.534Z",
      "bol_numbers": [
        {
          "number": "string",
          "id": "string"
        }
      ],
      "invoice_numbers": [
        {
          "number": "string",
          "id": "string"
        }
      ],
      "invoice_due_date": "2026-05-11T19:25:52.534Z",
      "invoice_date": "2026-05-11T19:25:52.534Z",
      "invoice_received_date": "2026-05-11T19:25:52.534Z",
      "invoice_bol_date": "2026-05-11T19:25:52.534Z",
      "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",
      "source_name": "string",
      "assignee": {
        "username": "string",
        "name": "string"
      },
      "details": [
        {
          "invoice_id": "string",
          "invoice_number": "string",
          "invoice_due_date": "2026-05-11T19:25:52.534Z",
          "invoice_date": "2026-05-11T19:25:52.534Z",
          "creation_date": "2026-05-11T19:25:52.534Z",
          "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-05-11T19:25:52.534Z",
          "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-05-11T19:25:52.534Z",
      "hold_by": "string",
      "export_status": "sent"
    }
  ],
  "unmapped_supplier_names": [
    "string"
  ],
  "unmapped_invoice_count": 0,
  "params": [
    {
      "title": "string",
      "datatype": "string",
      "filter_column": "string",
      "options": [
        null
      ]
    }
  ]
}
Loading...