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

# Customer.List

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

## Request body

- object
  - `api_token` string, uuid, required — Rivhit Merchant API Identifier. **Format:** `UUID` **Default:** No
  - `customer_type` integer — Return by Specific Customer Type. **Range:** 0 to 999999999 **Default:** No
  - `agent_id` integer, nullable — Return by a Specific Agent Id. **Range:** 0 to 999999999 **Default:** Customer details
  - `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
  - `created_after` string, date — Filter Customers by Creation Date. ~ Date format DD-MM-YY or DD/MM/YYYY **Length:** 1 to 10 **Default:** All Customers

## Response `200`

Success

- 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
    - `customer_list` object[] — Customers List Array.
      - `customer_id` integer — Customer Identifier.
      - `last_name` string — Customer Last Name.
      - `first_name` string — Customer First Name.
      - `street` string — Customer Street Address.
      - `city` string — Customer City.
      - `zipcode` string — Customer Zipcode.
      - `country` string — Customer Country.
      - `phone` string — Customer Phone Number.
      - `phone2` string — Customer Second Phone Number.
      - `fax` string — Customer Fax Number.
      - `email` string — Customer Email Address.
      - `id_number` integer — Customer Israeli Id Number (by Custom Format).
      - `vat_number` integer — Customer Israeli VAT Number (by Custom Format).
      - `customer_type` integer — Type of The Customer (1 = Customers 20 = Suppliers 60 = Agents).
      - `price_list_id` integer — Customer Price List.
      - `agent_id` integer — Agent Id Serial Number (Rivhit system).
      - `project_id` integer — Project Id Serial Number (Rivhit system)
      - `discount_percent` number — Customer Discount Value.
      - `acc_ref` string — Customer Third Party System Identifier
      - `exempt_vat` boolean — Set if Customer is Exempt.
      - `comments` string — Additional Comments About the Customer.
      - `available_from` string — Time Start for the Customer Availablity (hh:mm:ss).
      - `available_to` string — Time End for the Customer Availablity (hh:mm:ss).
      - `credit_terms` integer — Customer Credit Terms (1 = Cash 2 = Net EOM 3 = Net).
      - `credit_days` integer — Customer Credit Days.
      - `due_date` string — Due Date Settings for the Customer.
      - `pob` integer — Point of business reference.
      - `pal_code` integer — PAL (Point of Access) code.
      - `paying_customer_id` integer — Identifier for the customer making payments.
      - `is_registered` boolean — Indicates whether the customer is registered.
      - `balance` number — Customer's current account balance.
      - `currency_id` integer — Currency identifier (e.g., 1 = USD, 2 = EUR).

## 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/revisions/ed5261a52458/schema)