Debt Lines

Get a period's debt line or collateral statement as a PDF

get/debt-lines/{id}/statements/{period}/document

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/debt-lines/:id/statements/:period/document/get.ts
A function with typed inputs. Its response is checked against the schema.

idstring required

An object id with prefix

Example:user_0123456789ABCDEFGHIJKLMNOPq

periodstring required

period of data to be retrieved

Example:2024-01

account'debt_line' | 'collateral' required

statement account: debt_line (principal and fees ledgers) or collateral

Successful operation

file_namestring required

suggested file name of the statement PDF

pdf_base64string required

the statement PDF, base64-encoded