ed5261a52458

latestOpenAPI 3.0.02026-08-04880393.1 KB

Document.List

post/online/RivhitOnlineAPI.svc/Document.List

Request body

api_tokenstring uuid required

Rivhit Merchant API Identifier.

Default: No

from_document_typeinteger

Document type to Start Filter.

~ combine with to_document_type Range: 0 to 999 Default: No

to_document_typeinteger

Document type to End Filter.

~ combine with from_document_type Range: 0 to 999 Default: No

from_customer_idinteger

Rivhit Customer Id to Start Filter.

~ combine with to_customer_id Range: 0 to 999999999 Default: No

to_customer_idinteger

Rivhit Customer Id to End Filter.

~ combine with from_customer_id Range: 0 to 999999999 Default: No

from_datestring 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_datestring 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_idinteger nullable

Agent Id to Start Filter.

~ combine with to_agent_id Range: 0 to 999999999 Default: Customer details

to_agent_idinteger nullable

Agent Id to End Filter.

~ combine with from_agent_id Range: 0 to 999999999 Default: Customer details

from_document_numberinteger

Document Number Start Filter.

~ combine with to_document_number Range: 1 to 999999 Default: No

to_document_numberinteger

Document Number End Filter.

~ combine with from_document_number Range: 1 to 999999 Default: No

Example request

{
  "api_token": "DECD03E5-E35C-41E8-84F7-FBA2FB483928",
  "from_document_type": 1,
  "to_document_type": 1,
  "from_date": "01-01-2025",
  "to_date": "01-01-2025",
  "from_document_number": 115,
  "to_document_number": 120,
  "filter_fields": [
    {
      "filter_field": "phone",
      "filter_value": "0506666666"
    }
  ]
}

Response

Success - Document List Returned

error_codeinteger

The Response Error/Status Number (0 = Success)

client_messagestring

The Client Error Message.

debug_messagestring

The Response Error Message.