API reference · Financial
POST/api/v1/financial/invoices/{id}/finalize

Finalize financial invoice (maps to generic update)

Despite route naming, the handler calls ApiFinancialController.update() which performs generic financial update validation and update semantics. Path id is extracted as financial resource id and processed by FinancialService.update().

RBAC · financial

Path parameters

idstring <uuid>Required
Path UUID parameter resolved by ApiBaseController.extractIdFromPath().

Request body

Content type: application/json · schema FinancialUpdateTransactionBody

client_idstring <uuid>
invoice_idstring <uuid>
amountnumber
typestring
statusstring
parent_transaction_idstring <uuid>
descriptionstring
reference_numberstring
metadataobject
balance_afternumber
expiration_datestring
related_transaction_idstring <uuid>

Response body

Success response 200 · schema FinancialInvoiceApiSuccess

dataanyOfRequired
anyOf (option 1)object
anyOf (option 2)array of object
itemsobject
metaobject

Response codes

200
Financial resource updated.
400
Invalid id or payload.
401
API key missing/invalid.
403
financial:update permission denied.
404
Financial resource not found.
500
Unexpected update failure.