--- updatedAt: 2026-09-03T08:53:52.000Z agentTools: projectIndex: https://rivhit-api.readme.io/llms.txt --- # Document.List ### Get a List of Documents ### Note * The method default response will return last 6 months. * The response time is limited to 30 seconds, if it is too large it will probably return a timeout error. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Get a List of Documents", "version": "1.0.0" }, "paths": { "/online/RivhitOnlineAPI.svc/Document.List": { "post": { "summary": "Document.List", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "api_token": { "type": "string", "format": "uuid", "example": "DECD03E5-E35C-41E8-84F7-FBA2FB483928", "description": "Rivhit Merchant API Identifier.\n\n**Default:** No\n", "nullable": false, "deprecated": false }, "from_document_type": { "type": "integer", "example": 1, "description": "Document type to Start Filter.\n\n~ combine with to_document_type\n**Range:** 0 to 999\n**Default:** No\n", "nullable": false, "deprecated": false }, "to_document_type": { "type": "integer", "example": 1, "description": "Document type to End Filter.\n\n~ combine with from_document_type\n**Range:** 0 to 999\n**Default:** No\n", "nullable": false, "deprecated": false }, "from_customer_id": { "type": "integer", "example": 0, "description": "Rivhit Customer Id to Start Filter.\n\n~ combine with to_customer_id\n**Range:** 0 to 999999999\n**Default:** No\n", "nullable": false, "deprecated": false }, "to_customer_id": { "type": "integer", "example": 0, "description": "Rivhit Customer Id to End Filter.\n\n~ combine with from_customer_id\n**Range:** 0 to 999999999\n**Default:** No\n", "nullable": false, "deprecated": false }, "from_date": { "type": "string", "format": "date", "example": "01-01-2025", "description": "Issue Date to Start Filter.\n\n~ combine with to_date\n~ Date format DD-MM-YY or DD/MM/YYYY\n**Length:** 1 to 10\n**Default:** Current day\n", "nullable": false, "deprecated": false }, "to_date": { "type": "string", "format": "date", "example": "01-01-2025", "description": "Issue Date to End Filter.\n\n~ combine with from_date\n~ Date format DD-MM-YY or DD/MM/YYYY\n**Length:** 1 to 10\n**Default:** Current day\n", "nullable": false, "deprecated": false }, "from_agent_id": { "type": "integer", "example": 0, "description": "Agent Id to Start Filter.\n\n~ combine with to_agent_id\n**Range:** 0 to 999999999\n**Default:** Customer details\n", "nullable": true, "deprecated": false }, "to_agent_id": { "type": "integer", "example": 0, "description": "Agent Id to End Filter.\n\n~ combine with from_agent_id\n**Range:** 0 to 999999999\n**Default:** Customer details\n", "nullable": true, "deprecated": false }, "from_document_number": { "type": "integer", "example": 115, "description": "Document Number Start Filter.\n\n~ combine with to_document_number\n**Range:** 1 to 999999\n**Default:** No\n", "nullable": false, "deprecated": false }, "to_document_number": { "type": "integer", "example": 120, "description": "Document Number End Filter.\n\n~ combine with from_document_number\n**Range:** 1 to 999999\n**Default:** No\n", "nullable": false, "deprecated": false }, "filter_fields": { "type": "array", "items": { "type": "object", "properties": { "filter_field": { "type": "string", "example": "phone", "description": "Name of Response Field to Filter.\n\n**Length:** 1 to 30\n**Default:** No\n", "nullable": true, "deprecated": false }, "filter_value": { "type": "string", "example": "0506666666", "description": "Value of Response Field to Filter.\n\n**Length:** 1 to 30\n**Default:** No\n", "nullable": true, "deprecated": false } } } } }, "required": [ "api_token" ] } } } }, "responses": { "200": { "description": "Success - Document List Returned", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_code": { "type": "integer", "example": 0, "description": "The Response Error/Status Number (0 = Success)" }, "client_message": { "type": "string", "example": "", "description": "The Client Error Message." }, "debug_message": { "type": "string", "example": "", "description": "The Response Error Message." }, "data": { "type": "array", "items": { "type": "object", "properties": { "document_type": { "type": "integer", "description": "Receipt Type." }, "document_number": { "type": "integer", "description": "Receipt number." }, "document_date": { "type": "string", "format": "date", "description": "Document Issue Date." }, "document_time": { "type": "string", "description": "Document Issue Time." }, "amount": { "type": "number", "format": "float", "description": "Document Amount." }, "amount_exempt": { "type": "number", "format": "float", "description": "Document Exempt Amount." }, "customer_id": { "type": "integer", "description": "Customer Identifier." }, "agent_id": { "type": "integer", "description": "Agent Identifier." }, "is_cancelled": { "type": "boolean", "description": "Document Cancelation Status." }, "customer_name": { "type": "string", "description": "Customer Name." }, "order": { "type": "string", "description": "Order." }, "sort_code": { "type": "integer", "description": "Document Sort Code." }, "total_vat": { "type": "number", "format": "float", "description": "Document Vat Amount." }, "document_type_name": { "type": "string", "description": "Document Type Name." }, "is_accounting": { "type": "boolean", "description": "Document Accounting Settings." }, "project_id": { "type": "integer", "description": "Project Identifier." }, "reference": { "type": "integer", "description": "Document Reference Number." }, "phone": { "type": "integer", "description": "Customer Phone Number." }, "document_link": { "type": "string", "format": "url", "description": "Receipt Link." }, "comments": { "type": "string", "description": "The Customer Comments (to Print on the Invoice)." }, "customer_email": { "type": "string", "description": "Customer Email Address." }, "is_closed": { "type": "boolean", "description": "Document Closed Status." }, "customer_firstname": { "type": "string", "description": "Customer First Name." }, "customer_lastname": { "type": "string", "description": "Customer Last Name." }, "confirmation_number": { "type": "integer", "description": "The Document Confirmation Number." }, "due_date": { "type": "string", "description": "Document Due Date." } } } } } }, "example": { "error_code": "0,", "client_message": "", "debug_message": "", "data": [ { "document_type": 1, "document_number": "115,", "document_date": "15/07/2025", "document_time": "06:24:26", "amount": 4844.25, "amount_exempt": 0, "customer_id": 1, "agent_id": 0, "is_cancelled": false, "customer_name": "诪注\"诪 注讬住拽讗讜转 ", "order": "", "sort_code": 100, "total_vat": 738.95, "document_type_name": "讞砖讘讜谞讬转 诪住", "is_accounting": true, "project_id": 0, "reference": "", "phone": "", "document_link": "https://api.rivhit.co.il/pdf/FileService.svc/GetDocument/000000123/0d34eea6-23f7-4088-ba18-51efb8079974/true/1_115", "comments": "The current invoice's service period is: 2025-07-30 - 2025-08-15.", "customer_email": "", "is_closed": false, "customer_firstname": "", "customer_lastname": "诪注\"诪 注讬住拽讗讜转", "confirmation_number": 0, "due_date": "15/07/2025" }, { "document_type": 1, "document_number": 116, "document_date": "15/07/2025", "document_time": "06:24:27", "amount": 50381.63, "amount_exempt": 0, "customer_id": 1, "agent_id": 0, "is_cancelled": false, "customer_name": "诪注\"诪 注讬住拽讗讜转 ", "order": "", "sort_code": 100, "total_vat": 7685.33, "document_type_name": "讞砖讘讜谞讬转 诪住", "is_accounting": true, "project_id": 0, "reference": "", "phone": "", "document_link": "https://api.rivhit.co.il/pdf/FileService.svc/GetDocument/000000123/9e1608b4-db03-4fdf-b8fd-50502d311426/true/1_116", "comments": "The current invoice's service period is: 2025-07-30 - 2025-08-15.", "customer_email": "", "is_closed": false, "customer_firstname": "", "customer_lastname": "诪注\"诪 注讬住拽讗讜转", "confirmation_number": 0, "due_date": "15/07/2025" } ] } } } }, "400": { "description": "Request Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Request Error" } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_code": { "type": "integer", "example": 0, "description": "Error code of the response." }, "client_message": { "type": "string", "example": "", "description": "The Client Error Message." }, "debug_message": { "type": "string", "example": "", "description": "The Response Error Message." }, "data": { "type": "array", "example": null, "description": "Error Data." } } } } } } }, "description": "### Get a List of Documents" } } }, "servers": [ { "url": "https://api.rivhit.co.il/" } ] } ```