Partial update credit note (draft only)
Credit notes
Partial update credit note (draft only)
PATCH
Partial update credit note (draft only)
Authorizations
Use header Authorization: Token <api_token>.
API tokens are obtained from the Piriod dashboard.
Headers
Workspace (account) identifier. Required for every request.
Whether to operate against test-mode data. Defaults to false.
Path Parameters
Resource identifier.
Body
application/json
Invoice ID this credit note adjusts.
Credit-note document type. Optional; the biller may assign one at finalize.
Maximum string length:
64Maximum string length:
1024Available options:
%, $ Response
200 - application/json
Updated credit note.
Invoice ID this credit note adjusts.
Credit-note document type. Optional; the biller may assign one at finalize.
Maximum string length:
64Maximum string length:
1024Available options:
%, $ Available options:
draft, finalized, cancelled 