Update an item

patch

https://core.sivo.com/creditors/{creditor_id}/receivables/{receivable_id}/items/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

creditor_id

string

required

^[a-z]{3,7}_[0-9A-Za-z]{27}$

An object id with prefix

receivable_id

string

required

^[a-z]{3,7}_[0-9A-Za-z]{27}$

An object id with prefix

string

required

^[a-z]{3,7}_[0-9A-Za-z]{27}$

An object id with prefix

Body Params

Update a creditor

date

Date on which the transaction occurred

amount

integer

≥ 0

Amount for the transaction

balance

integer

Receivable balance including the amount in this transaction

type

string

enum

Type of the transaction being reported

receivable_status

string

enum

Status of the receivable at the time the transaction occurred

Allowed:

description

string | null

Description associated with this transaction

metadata

object | null

Additional custom data associated with this receivable item

Headers

if-match

date-time

required

ETag value for Optimistic Concurrency Control (OCC). Should contain the last known updated_at timestamp in ISO 8601 format.

Response

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful operation