latestOpenAPI 3.0.32026-08-0623677345.2 KB

70cbc827dc7b

Billing

Create payment receipt (draft)

post/payment-receipts/

Headers

x-simple-workspacestring required

Workspace (account) identifier. Required for every request.

x-piriod-test-modeboolean

Whether to operate against test-mode data. Defaults to false.

Request body

idinteger

sourcesstring[] required

IDs of payment sources covered by this receipt. All sources must belong to invoices for the same customer and document type, and cannot already have a payment receipt.

document'MX22' nullable

Fiscal document type (set automatically by the biller).

numberinteger

datestring date nullable

custom_changenumber nullable

Custom currency conversion factor.

metadataobject

tax_settingsobject

Country-specific tax-agency settings (validated at create/update).

status'draft' | 'finalized'

biller_statusstring

tax_agencyobject

local_filestring uri nullable

createdstring date-time

updatedstring date-time

Response

Payment receipt created.