---
title: "List all documents"
method: GET
path: "/receivables/{id}/documents"
tags: ["Receivables"]
---

# List all documents

`GET /receivables/{id}/documents`

## Request

- Base URL: `https://core.sivo.com`
- URL: `https://core.sivo.com/receivables/{id}/documents`
- Auth: one of:
  - API key in header `Authorization`
  - OAuth 2
    - Authorization code: `https://dashboard.sivo.com/oauth/authorize`
    - Client credentials
    - Token URL: `https://core.sivo.com/oauth/token`
- TypeScript: <https://skmtc.dev/sivo/apis/sivo-advance-api/docs/receivables/:id/documents/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `id` string, required: An object ID assigned and owned by the originator

## Query parameters

- `limit` integer: Maximum number of results to return, from 1 to 100; defaults to 25
- `page` string: Opaque page token from a previous response's next_page or previous_page; pass it back unchanged, with the same sort and filters
- `expand` string[]: Extra fields to include in the page; total_count counts the matching results, exactly up to 10000
- `sort` 'created_at_desc': Result order; defaults to created_at_desc
- `type` 'invoice' | 'contract' | 'proof_of_delivery' | 'other': Kind of document attached to the receivable
- `status` 'pending_upload' | 'uploaded' | 'quarantined': Lifecycle status of the document: pending_upload until the file upload is confirmed, quarantined when the file failed malware scanning (upload a replacement file to clear it)

## Response `200`

Successful operation

- object: One page of a list
  - `data` object[], required
    - `file_name` string, required: File name of the document, used when the file is downloaded
    - `content_type` 'application/pdf' | 'image/png' | 'image/jpeg' | 'image/webp' | 'application/xml' | 'text/xml', required: MIME type of the document file
    - `size_bytes` integer, required: Size of the file in bytes, at most 25 MB
    - `type` 'invoice' | 'contract' | 'proof_of_delivery' | 'other': Kind of document attached to the receivable
    - `metadata` object: Additional custom data associated with this document
    - `id` string, required: The receivable document ID assigned by the originator
    - `created_at` string, date-time, required: Creation date and time
    - `created_by` string, required: ID of the user that created this object
    - `updated_at` string, date-time, required: Last update date and time
    - `updated_by` string, required: ID of the user that last updated this object
    - `status` 'pending_upload' | 'uploaded' | 'quarantined', required: Lifecycle status of the document: pending_upload until the file upload is confirmed, quarantined when the file failed malware scanning (upload a replacement file to clear it)
    - `etag` string: Entity tag of the stored file, set once the upload is confirmed
  - `has_more` boolean, required: Whether more results follow this page in the list order
  - `next_page` string, nullable, required: Token for the page after this one, or null when this is the last page
  - `previous_page` string, nullable, required: Token for the page before this one, or null when this is the first page
  - `total_count` integer: Number of results matching the filters, exact up to 10000; 10001 means more than that. Only present when the request expands total_count

## Changes

- **2026-11-03** `4bbab9699612`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/sivo/apis/sivo-advance-api/changes/receivables/:id/documents/get.md)

---

[API](https://skmtc.dev/sivo/apis/sivo-advance-api.md) - [All operations](https://skmtc.dev/sivo/apis/sivo-advance-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sivo/apis/sivo-advance-api/revisions/4bbab9699612?raw)