Submits the invoice to the tax agency (when applicable) and locks the
document. Requires status draft or pending. When status is pending
all linked payments must be succeeded.
Documentation Index
Fetch the complete documentation index at: https://piriod-d406ac55.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Use header Authorization: Token <api_token>.
API tokens are obtained from the Piriod dashboard.
Workspace (account) identifier. Required for every request.
Whether to operate against test-mode data. Defaults to false.
Resource identifier.
Finalized invoice.
Customer ID.
Document type ID (fiscal document; depends on country).
deferred, deferred_dues, automatically "inv_01H8XYZ123ABC"
Sequence number assigned at finalize time.
Currency code from the customer's currency.
256Subtotal of taxable lines (computed).
Subtotal of tax-exempt lines (computed).
Total tax (computed).
Final amount (computed).
%, $ Custom currency conversion factor.
x >= 1draft, finalized, paid, cancelled, uncollectible, pending pending, queued, succeeded, failed, processing Tax-agency response payload (country-specific).
Signed URL to the fiscal PDF/XML when applicable.
Linked subscription ID when generated by a subscription cycle.