API reference›Supplier payables›Settle Supplier Payable
104 operations ↓ OpenAPI JSON Get API key
POST /v1/supplier-payables/{supplier_payable_id}/settlements

Settle Supplier Payable

Post a reviewed bank settlement against a supplier payable.

Requires API key Idempotent OpenAPI v1

Authentication

Use a HelvCore API key in the Authorization header. Keys are server-side secrets and must not be exposed to browser JavaScript.

GETHeader
Authorization: Bearer hc_...

Parameters

Idempotency-Keystringrequiredheader

Documented field.

supplier_payable_idstringrequiredpath

Documented field.

Request body

Send JSON using the documented schema. Unknown or unsafe fields fail with structured validation errors where the endpoint owns validation.

end_customer_idstringrequiredbody

Documented field.

settlement_datestringrequiredbody

Documented field.

amountobjectrequiredbody

Documented field.

bank_referencestringoptionalbody

Documented field.

evidence_sha256stringoptionalbody

Reviewed payment or bank evidence hash for this settlement. For CAMT.053-backed supplier-payable settlements, use the statement entry canonical_entry_hash from GET /v1/camt-053/entries/{entry_id}.

reviewer_justificationstringrequiredbody

Documented field.

Returns

Returns a documented JSON response on success and the standard HelvCore error envelope on failure.

201Successful response.
defaultStructured error response.
401invalid_auth - missing, expired, or invalid Bearer key

Stable error codes

api_key_disabledDocumented HelvCore error code for this operation.
api_key_expiredDocumented HelvCore error code for this operation.
idempotency_key_conflictDocumented HelvCore error code for this operation.
invalid_authDocumented HelvCore error code for this operation.
invalid_requestDocumented HelvCore error code for this operation.
missing_idempotency_keyDocumented HelvCore error code for this operation.
validation_failedDocumented HelvCore error code for this operation.