Skip to main content
PATCH
Update clearing amount

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

Path Parameters

creditNoteId
string<uuid>
required
invoicePayableId
string<uuid>
required

Body

application/json;charset=UTF-8
amount
integer<int64>

Updated amount to clear in cents

Response

default - application/json;charset=UTF-8

default response

companyId
string<uuid>

ID of the company

creditNote
object

Invoice payable details

invoicePayable
object

Invoice payable details

amount
integer<int64>

Clearing amount in cents

currency
string
Example:

"USD"

createdAt
string<date-time>

Timestamp when the link was created

updatedAt
string<date-time>

Timestamp when the link was last updated