Export Reconciliation Snapshot

POST

https://api.staple.io/reconciliation/export

POST

/reconciliation/export

curl -X POST https://api.staple.io/reconciliation/export \
     -H "x-api-key: <apiKey>"

200Export Reconciliation Snapshot

{
  "collection_name": "Payables vs POs",
  "created_at": "2025-05-01T12:00:00Z",
  "last_execution_time": "2025-05-02T09:30:00Z",
  "secondary_docs": [
    {
      "match_rules": [
        {
          "id": "rule-1",
          "reconcile_rules": [
            {
              "id": "rr-1",
              "matches": [
                {
                  "source": {
                    "line_id": 1,
                    "table_name": "invoice_lines"
                  },
                  "target": {
                    "is_aggregated": false,
                    "is_force_reconciled": false,
                    "matched_rows": [
                      {
                        "doc_name": "po-1001.pdf",
                        "is_modified": false,
                        "line_id": 1,
                        "reconcile_status": "fully_reconciled",
                        "table_id": "po_lines",
                        "values": {
                          "POAmount": {
                            "value": "100.50"
                          },
                          "POLineNumber": {
                            "value": "10"
                          }
                        }
                      }
                    ],
                    "reconcile_status": "fully_reconciled",
                    "target_value": "100.50"
                  }
                },
                {
                  "source": {
                    "line_id": 2,
                    "table_name": "invoice_lines"
                  },
                  "target": {
                    "is_aggregated": true,
                    "is_force_reconciled": false,
                    "matched_rows": [
                      {
                        "doc_name": "po-1001.pdf",
                        "is_modified": false,
                        "line_id": 21,
                        "reconcile_status": "fully_reconciled",
                        "table_id": "po_lines",
                        "values": {
                          "POAmount": {
                            "value": "100.50"
                          },
                          "POLineNumber": {
                            "value": "20"
                          }
                        }
                      },
                      {
                        "doc_name": "po-1001.pdf",
                        "is_modified": false,
                        "line_id": 22,
                        "reconcile_status": "not_reconciled",
                        "table_id": "po_lines",
                        "values": {
                          "POAmount": {
                            "value": "50.25"
                          },
                          "POLineNumber": {
                            "value": "21"
                          }
                        }
                      }
                    ],
                    "reconcile_status": "partially_reconciled",
                    "target_value": "150.75"
                  }
                }
              ],
              "metadata": {
                "error": 0,
                "fully_reconciled": 1,
                "not_found": 0,
                "not_reconciled": 0,
                "partially_reconciled": 1,
                "total_count": 2
              },
              "reconcile_policy": {
                "options": {
                  "allow_negative": false,
                  "max_amount_diff": 0
                },
                "type": "match_amount_sum"
              },
              "source_field": "Amount",
              "target_field": "POAmount"
            }
          ]
        }
      ],
      "secondary_doc_type": "PO"
    }
  ],
  "source_document": {
    "data": [
      {
        "rows": [
          {
            "line_id": 0,
            "target_value": {
              "InvoiceDate": {
                "value": "2025-04-25"
              },
              "InvoiceNumber": {
                "value": "INV-20301"
              }
            }
          }
        ],
        "table_name": "header"
      },
      {
        "rows": [
          {
            "line_id": 1,
            "target_value": {
              "Amount": {
                "value": "100.50"
              },
              "LineID": {
                "value": "1"
              }
            }
          }
        ],
        "table_name": "Table 1"
      }
    ],
    "doc_id": "INV-20301",
    "doc_name": "inv-20301.pdf"
  }
}

Exports a full reconciliation snapshot for a primary doc across all configured secondary doc types under the given view.

Key nuances

Header is represented as table_name header with line_id 0.
Amount aggregation sums numeric values in when policy type includes “amount”; otherwise values are comma-joined; status is aggregated using worst-case.

Authentication

x-api-keystring

API key issued by Staple.

AuthorizationBearer

JWT obtained from the login endpoint.

Request

This endpoint expects an object.

matching_collection_idintegerOptional

doc_idstringOptional

view_idstringOptional

versionintegerOptional

Key nuances

Authentication

Request

Response