Sign in
latestOpenAPI 3.0.02026-08-04880393.1 KB

ed5261a52458

Customer.List

post/online/RivhitOnlineAPI.svc/Customer.List

Request body

api_tokenstring uuid required

Rivhit Merchant API Identifier.

Format: UUID Default: No

customer_typeinteger

Return by Specific Customer Type.

Range: 0 to 999999999 Default: No

agent_idinteger nullable

Return by a Specific Agent Id.

Range: 0 to 999999999 Default: Customer details

created_afterstring date

Filter Customers by Creation Date.

~ Date format DD-MM-YY or DD/MM/YYYY Length: 1 to 10 Default: All Customers

Example request

{
  "api_token": "0279BF82-CD57-49BA-837C-930F0E2EB805",
  "filter_fields": [
    {
      "filter_field": "credit_terms",
      "filter_Value": "3"
    }
  ],
  "created_after": "01-01-2025"
}

Response

Success

error_codeinteger

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

client_messagestring

The Client Error Message.

debug_messagestring

The Response Error Message.

Example response

{
  "data": {
    "customer_list": [
      {
        "customer_id": 11,
        "last_name": "Israeli",
        "first_name": "Moshe",
        "street": "Ben Yehuda 11",
        "city": "Tel Aviv",
        "zipcode": "123456",
        "country": "Israel",
        "phone": "0544444444",
        "phone2": "0544444444",
        "fax": "03-3333333",
        "email": "d@d.com",
        "id_number": 123456790,
        "vat_number": 123456790,
        "customer_type": 1,
        "price_list_id": 2,
        "agent_id": 42,
        "project_id": 10,
        "acc_ref": "CUST-001",
        "exempt_vat": true,
        "comments": "Preferred customer with high priority.",
        "available_from": "12:00:00",
        "available_to": "15:30:00",
        "credit_terms": 30,
        "credit_days": 45,
        "due_date": "2024-02-15",
        "pob": 100,
        "pal_code": 200,
        "paying_customer_id": 300,
        "is_registered": true,
        "balance": 100.75,
        "currency_id": 1
      }
    ]
  }
}