v1

latestOpenAPI 3.0.02026-08-04880393.1 KB

Receipt.List

post/online/RivhitOnlineAPI.svc/Receipt.List

Request body

api_tokenstring uuid required

Rivhit Merchant API Identifier.

Default: No

from_receipt_typeinteger

Receipt type to Start Filter.

~ combine with to_receipt_type Range: 0 to 999 Default: All types

to_receipt_typeinteger

Receipt type to End Filter.

~ combine with from_receipt_type Range: 0 to 999 Default: All types

from_customer_idinteger

Rivhit Customer Id to Start Filter.

~ combine with to_customer_id Range: 0 to 999999999 Default: All customers

to_customer_idinteger

Rivhit Customer Id to End Filter.

~ combine with from_customer_id Range: 0 to 999999999 Default: All customers

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: Last 6 months

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: Last 6 months

crm_user_idinteger nullable

Filter by CRM User.

Range: 0 to 99999 Default: All users

from_agent_idinteger nullable

Agent Id to Start Filter.

~ combine with to_agent_id Range: 0 to 999999999 Default: All agents

to_agent_idinteger nullable

Agent Id to End Filter.

~ combine with from_agent_id Range: 0 to 999999999 Default: All agents

from_receipt_numberinteger

Receipt Number Start Filter.

~ combine with to_receipt_number Range: 1 to 999999 Default: All Numbers

to_receipt_numberinteger

Receipt Number End Filter.

~ combine with from_receipt_number Range: 1 to 999999 Default: All Numbers

Example request

{
  "api_token": "DECD03E5-E35C-41E8-84F7-FBA2FB483928",
  "from_receipt_type": 1,
  "to_receipt_type": 1,
  "from_date": "01-01-2025",
  "to_date": "01-01-2025",
  "from_receipt_number": 115,
  "to_receipt_number": 120,
  "filter_fields": [
    {
      "filter_field": "amount",
      "filter_Value": "10"
    }
  ]
}

Response

Success - Receipt List Returned

error_codeinteger

The Response Error/Status Number (0 = Success).

client_messagestring

The Client Error Message.

debug_messagestring

The Response Error Message.