Skip to main content
GET
/
private-records
/
{record_id}
/
documents
Error
A valid request URL is required to generate request examples
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "original_filename": "<string>",
      "document_type": "balance_sheet",
      "period": "2023-12-25",
      "analysis": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total_items": 1
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Requester-Organization-ID
string<uuid>
required

The unique identifier of the organization making the request. This ID is used to authorize the requester within the system.

​
Target-Organization-ID
string<uuid>
required

The unique identifier of the organization that is the target of the request. The Target-Organization-ID may match the Requester-Organization-ID if the requester accesses their own resources. If the Target-Organization-ID differs from the Requester-Organization-ID, the requester can access third-party resources if the requester has a connection with the target organization and is authorized to perform such actions.

Path Parameters

​
record_id
string<uuid>
required

Query Parameters

​
file_id
string<uuid> | null
​
document_types
enum<string>[] | null
Available options:
balance_sheet,
income_statement,
cashflow_statement
​
period_from
string<date> | null
​
period_to
string<date> | null
​
analysis_status
boolean | null
​
order_by
enum<string>
default:created_at
Available options:
created_at,
updated_at,
period
​
order_dir
enum<string>
default:desc
Available options:
asc,
desc
​
limit
integer
required
Required range: x <= 100
​
offset
integer
required
Required range: x >= 0

Response

Successful Response

​
items
PrivateRecordFinancialDocument · object[]
required
​
total_items
integer
required
Required range: x >= 0