Receivables

Get a short-lived download URL for the document file

post/receivables/{id}/documents/{document_id}/download

Request

Base URL
https://core.sivo.com
Auth
- API key in header Authorization
- or OAuth 2
  Authorization codehttps://dashboard.sivo.com/oauth/authorize
  Client credentials
  Token URLhttps://core.sivo.com/oauth/token
TypeScript
https://skmtc.dev/sivo/apis/sivo-advance-api/docs/receivables/:id/documents/:document_id/download/post.ts
A function with typed inputs. Its response is checked against the schema.

idstring required

An object ID assigned and owned by the originator

Example:acct-123

document_idstring required

An object ID assigned and owned by the originator

Example:acct-123

Idempotency-Keystring

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

Example:978771af-77de-4e24-ba39-f602502ceb78

Successful operation

file_namestring required

Suggested file name for the downloaded document

urlstring uri required

Short-lived URL to download the document file

expires_atstring date-time required

Expiry of the download URL

{
  "url": "https://www.acme.com",
  "expires_at": "2024-01-15T10:30:00Z"
}