Billing

Finalize credit note

Submits the credit note to the tax agency (when applicable) and locks the document.

get/creditnotes/{id}/finalize/

Request

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

Finalized 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

No recorded changes to this operation across all 1 revision of this API.