Skip to navigation
V2Reconciliation

List Document Sets

View as Markdown

Lists the document sets produced by one linking set. A document set is one anchor document (usually the invoice) together with the documents linked to it and the current reconciliation outcome.

This is an index, not the card grid: each item carries the anchor, state, overall_status, exception_count, and labels. facets gives the counts behind the status tabs. Use document_set_id with the export endpoint to pull the full result.

Requires reconciliation v2 on the organisation; other tenants receive 404.

Authentication

x-api-keystring
API key issued by Staple.
AuthorizationBearer
JWT obtained from the login endpoint.

Path parameters

uuidstringRequired
Linking set UUID, as returned by List Linking Sets.

Query parameters

stateenumOptional
Filter by document set state. Omit to return both.
Allowed values:
statuslist of enumsOptional

Filter by overall status. Repeat the parameter or pass a comma-separated list to select several, for example status=RECONCILED&status=NOT_FOUND.

Allowed values:
anchor_doc_idlist of integersOptional

Return only the document sets whose anchor (primary) document is one of these document IDs. Repeat the parameter or pass a comma-separated list, for example anchor_doc_id=101&anchor_doc_id=102 or anchor_doc_id=101,102, up to 200 IDs.

It matches the anchor only, never a document that is just linked into a set, so one uploaded document gives at most one document set per linking set. An empty items means the document has not been reconciled in this linking set yet. A value that is not a positive integer returns 400.

Use it to open the reconcile details screen for a document you uploaded: /linking-sets/{uuid}/document-sets/{document_set_id}, with document_set_id URL-encoded.

limitintegerOptional<=200Defaults to 50
Page size. Defaults to 50 and is capped at 200.
offsetintegerOptionalDefaults to 0
Number of records to skip for pagination.

Response

OK