Upsert a receivable document and get a presigned upload URL

post

https://core.sivo.com/receivables/{id}/documents

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

length between 1 and 255

An object ID assigned and owned by the originator

Body Params

Create a receivable

Creates the receivable document when the id is new, otherwise updates the existing document with the provided fields. Changing the file name, content type or size resets the document to pending_upload and issues a fresh upload URL. Set an optional field to null to clear it.

string

required

length between 1 and 255

The receivable document ID assigned by the originator

file_name

string

length between 1 and 255

File name of the document, used when the file is downloaded. Required at creation, optional for updates.

content_type

string

enum

MIME type of the document file. Required at creation, optional for updates.

Allowed:

size_bytes

integer

≤ 26214400

Size of the file in bytes, at most 25 MB. Required at creation, optional for updates.

type

string | null

enum

Kind of document attached to the receivable

Allowed:

metadata

object | null

Additional custom data associated with this document

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

200Successful operation