v1
latestOpenAPI 3.0.32026-08-0623677345.2 KBBilling
Replace credit note (draft only)
put/creditnotes/{id}/
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
Updated credit note.
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