Export Reconciliation Snapshot | Staple AI

{
  "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.

Exports a full reconciliation snapshot for a primary doc across all configured secondary doc types under the given view. ##### Key nuances 1. Header is represented as table\_name `header` with line\_id 0. 2. 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

1	{
2	"collection_name": "Payables vs POs",
3	"created_at": "2025-05-01T12:00:00Z",
4	"last_execution_time": "2025-05-02T09:30:00Z",
5	"secondary_docs": [
6	{
7	"match_rules": [
8	{
9	"id": "rule-1",
10	"reconcile_rules": [
11	{
12	"id": "rr-1",
13	"matches": [
14	{
15	"source": {
16	"line_id": 1,
17	"table_name": "invoice_lines"
18	},
19	"target": {
20	"is_aggregated": false,
21	"is_force_reconciled": false,
22	"matched_rows": [
23	{
24	"doc_name": "po-1001.pdf",
25	"is_modified": false,
26	"line_id": 1,
27	"reconcile_status": "fully_reconciled",
28	"table_id": "po_lines",
29	"values": {
30	"POAmount": {
31	"value": "100.50"
32	},
33	"POLineNumber": {
34	"value": "10"
35	}
36	}
37	}
38	],
39	"reconcile_status": "fully_reconciled",
40	"target_value": "100.50"
41	}
42	},
43	{
44	"source": {
45	"line_id": 2,
46	"table_name": "invoice_lines"
47	},
48	"target": {
49	"is_aggregated": true,
50	"is_force_reconciled": false,
51	"matched_rows": [
52	{
53	"doc_name": "po-1001.pdf",
54	"is_modified": false,
55	"line_id": 21,
56	"reconcile_status": "fully_reconciled",
57	"table_id": "po_lines",
58	"values": {
59	"POAmount": {
60	"value": "100.50"
61	},
62	"POLineNumber": {
63	"value": "20"
64	}
65	}
66	},
67	{
68	"doc_name": "po-1001.pdf",
69	"is_modified": false,
70	"line_id": 22,
71	"reconcile_status": "not_reconciled",
72	"table_id": "po_lines",
73	"values": {
74	"POAmount": {
75	"value": "50.25"
76	},
77	"POLineNumber": {
78	"value": "21"
79	}
80	}
81	}
82	],
83	"reconcile_status": "partially_reconciled",
84	"target_value": "150.75"
85	}
86	}
87	],
88	"metadata": {
89	"error": 0,
90	"fully_reconciled": 1,
91	"not_found": 0,
92	"not_reconciled": 0,
93	"partially_reconciled": 1,
94	"total_count": 2
95	},
96	"reconcile_policy": {
97	"options": {
98	"allow_negative": false,
99	"max_amount_diff": 0
100	},
101	"type": "match_amount_sum"
102	},
103	"source_field": "Amount",
104	"target_field": "POAmount"
105	}
106	]
107	}
108	],
109	"secondary_doc_type": "PO"
110	}
111	],
112	"source_document": {
113	"data": [
114	{
115	"rows": [
116	{
117	"line_id": 0,
118	"target_value": {
119	"InvoiceDate": {
120	"value": "2025-04-25"
121	},
122	"InvoiceNumber": {
123	"value": "INV-20301"
124	}
125	}
126	}
127	],
128	"table_name": "header"
129	},
130	{
131	"rows": [
132	{
133	"line_id": 1,
134	"target_value": {
135	"Amount": {
136	"value": "100.50"
137	},
138	"LineID": {
139	"value": "1"
140	}
141	}
142	}
143	],
144	"table_name": "Table 1"
145	}
146	],
147	"doc_id": "INV-20301",
148	"doc_name": "inv-20301.pdf"
149	}
150	}

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

Key nuances

Authentication

Request

Response

Key nuances