Create an item

post

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

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

Body Params

Create a creditor

date

required

Date on which the transaction occurred

amount

integer

required

≥ 0

Amount for the transaction

balance

integer

required

Receivable balance including the amount in this transaction

type

string

enum

required

Type of the transaction being reported

receivable_status

string

enum

required

Status of the receivable at the time the transaction occurred

Allowed:

description

string

length ≥ 1

Description associated with this transaction

metadata

object

Additional custom data associated with this receivable item

Headers

IdempotencyKey

string

A unique key per operation, could be V4 UUID or other high‑entropy random string. Keys can be up to 255 characters. See Idempotent Requests.

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