---
title: "Document.List"
method: POST
path: "/online/RivhitOnlineAPI.svc/Document.List"
---

# Document.List

`POST /online/RivhitOnlineAPI.svc/Document.List`

## Request body

- object
  - `api_token` string, uuid, required — Rivhit Merchant API Identifier. **Default:** No
  - `from_document_type` integer — Document type to Start Filter. ~ combine with to_document_type **Range:** 0 to 999 **Default:** No
  - `to_document_type` integer — Document type to End Filter. ~ combine with from_document_type **Range:** 0 to 999 **Default:** No
  - `from_customer_id` integer — Rivhit Customer Id to Start Filter. ~ combine with to_customer_id **Range:** 0 to 999999999 **Default:** No
  - `to_customer_id` integer — Rivhit Customer Id to End Filter. ~ combine with from_customer_id **Range:** 0 to 999999999 **Default:** No
  - `from_date` string, date — Issue Date to Start Filter. ~ combine with to_date ~ Date format DD-MM-YY or DD/MM/YYYY **Length:** 1 to 10 **Default:** Current day
  - `to_date` string, date — Issue Date to End Filter. ~ combine with from_date ~ Date format DD-MM-YY or DD/MM/YYYY **Length:** 1 to 10 **Default:** Current day
  - `from_agent_id` integer, nullable — Agent Id to Start Filter. ~ combine with to_agent_id **Range:** 0 to 999999999 **Default:** Customer details
  - `to_agent_id` integer, nullable — Agent Id to End Filter. ~ combine with from_agent_id **Range:** 0 to 999999999 **Default:** Customer details
  - `from_document_number` integer — Document Number Start Filter. ~ combine with to_document_number **Range:** 1 to 999999 **Default:** No
  - `to_document_number` integer — Document Number End Filter. ~ combine with from_document_number **Range:** 1 to 999999 **Default:** No
  - `filter_fields` object[]
    - `filter_field` string, nullable — Name of Response Field to Filter. **Length:** 1 to 30 **Default:** No
    - `filter_value` string, nullable — Value of Response Field to Filter. **Length:** 1 to 30 **Default:** No

## Response `200`

Success - Document List Returned

- object
  - `error_code` integer — The Response Error/Status Number (0 = Success)
  - `client_message` string — The Client Error Message.
  - `debug_message` string — The Response Error Message.
  - `data` object[]
    - `document_type` integer — Receipt Type.
    - `document_number` integer — Receipt number.
    - `document_date` string, date — Document Issue Date.
    - `document_time` string — Document Issue Time.
    - `amount` number, float — Document Amount.
    - `amount_exempt` number, float — Document Exempt Amount.
    - `customer_id` integer — Customer Identifier.
    - `agent_id` integer — Agent Identifier.
    - `is_cancelled` boolean — Document Cancelation Status.
    - `customer_name` string — Customer Name.
    - `order` string — Order.
    - `sort_code` integer — Document Sort Code.
    - `total_vat` number, float — Document Vat Amount.
    - `document_type_name` string — Document Type Name.
    - `is_accounting` boolean — Document Accounting Settings.
    - `project_id` integer — Project Identifier.
    - `reference` integer — Document Reference Number.
    - `phone` integer — Customer Phone Number.
    - `document_link` string, url — Receipt Link.
    - `comments` string — The Customer Comments (to Print on the Invoice).
    - `customer_email` string — Customer Email Address.
    - `is_closed` boolean — Document Closed Status.
    - `customer_firstname` string — Customer First Name.
    - `customer_lastname` string — Customer Last Name.
    - `confirmation_number` integer — The Document Confirmation Number.
    - `due_date` string — Document Due Date.

## Other responses

- `400` — Request Error
- `500` — Internal Server Error

---

[API](https://skmtc.net/rivhit/apis/get-payment-url-22-12.md) · [All operations](https://skmtc.net/rivhit/apis/get-payment-url-22-12/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rivhit/get-payment-url-22-12/versions/ed5261a52458/schema)