Sign in

v1

latestOpenAPI 3.0.32026-08-0623677345.2 KB
Billing

Create credit note (draft)

Creates a credit note. If the related invoice or chosen document allows partial credit, the line totals are computed from the request; otherwise the lines mirror the invoice.

post/creditnotes/

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
invoicestring required

Invoice ID this credit note adjusts.

documentinteger nullable

Credit-note document type. Optional; the biller may assign one at finalize.

numberinteger
datestring date required
notestring nullable
internal_notestring nullable
amountnumber nullable
exemptnumber nullable
taxnumber nullable
tax_percentnumber nullable
subtotalnumber nullable
totalnumber nullable
retentionnumber nullable
discountnumber nullable
discount_scheme'%' | '$' nullable
status'draft' | 'finalized' | 'cancelled'
biller_statusstring
tax_agencyobject
local_filestring uri nullable
importedboolean
test_modeboolean
createdstring date-time
updatedstring date-time

Response

Credit note created.

idinteger
invoicestring required

Invoice ID this credit note adjusts.

documentinteger nullable

Credit-note document type. Optional; the biller may assign one at finalize.

numberinteger
datestring date required
notestring nullable
internal_notestring nullable
amountnumber nullable
exemptnumber nullable
taxnumber nullable
tax_percentnumber nullable
subtotalnumber nullable
totalnumber nullable
retentionnumber nullable
discountnumber nullable
discount_scheme'%' | '$' nullable
status'draft' | 'finalized' | 'cancelled'
biller_statusstring
tax_agencyobject
local_filestring uri nullable
importedboolean
test_modeboolean
createdstring date-time
updatedstring date-time