Billing

Replace payment receipt (draft only)

put/payment-receipts/{id}/

Request

Base URL
https://api.piriod.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/piriod/apis/piriod-api/docs/payment-receipts/:id/put.ts
A function with typed inputs. Its response is checked against the schema.

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

Updated payment receipt.