---
updatedAt: 2026-01-05T09:34:49.000Z
agentTools:
  projectIndex: https://rivhit-api.readme.io/llms.txt
---

# 🙋‍♀️ Customers

All customers (and agents) managment - create, update, get customers information and more

# Customer Management

Create, update and get all customers information.

<br />

## Create a New Customer

Create a new customer.

<br />

Methods -

[Customer.New](https://rivhit-api.readme.io/reference/post_online-rivhitonlineapi-svc-customer-new#/)

<br />

It is possible to choose the next customer serial number.

send in request parameter:

`'cust_id'`

Send the number to set the next customer (the system will continue from this setting).

<br />

## Update Customer Details

Update an existing customer.

<br />

Methods -

[Customer.Update](https://rivhit-api.readme.io/reference/post_online-rivhitonlineapi-svc-customer-update#/)

<br />

## Erase a Customer

Delete an existing customer.

<br />

Method -

[Customer.Delete](https://rivhit-api.readme.io/reference/post_online-rivhitonlineapi-svc-customer-delete#/)

<Callout icon="❗️" theme="error">
  #### Erasing an existing customer will be possible only if it wasn't ascribed to a document/receipt.
</Callout>

<br />

# Get the Customers Info

Receive a specific customer or all customers information.

<br />

Methods -

[Customer.Get](https://rivhit-api.readme.io/reference/post_online-rivhitonlineapi-svc-customer-get#/)

Get the details for a specific customer.

<br />

[Customer.List](https://rivhit-api.readme.io/reference/post_online-rivhitonlineapi-svc-customer-list#/)

Get all customers details in a specific account.

To filter the customers by type - send request parameter:

`'customer_type'`

Send the customer type accordingly.

<br />

# Customer Types

The customers will hold all tickets used in the system and are divided by types.

| Type Name            | Meaning                                                                                                                     | Default Code |
| :------------------- | :-------------------------------------------------------------------------------------------------------------------------- | :----------- |
| Simple Customers     | The regular customers for sales                                                                                             | 1            |
| Suppliers            | Businesses or individuals who provide the products or materials that the business purchases for resale or use in operations | 20           |
| Income/Outcome codes | General income and outcome tickets (electricity, water, insurance etc.) of the business                                     | 40-59        |
| Agents               | The agents purpose is to separate the orders/sales between the agents employ of the merchant                                | 60           |

<Callout icon="📘" theme="info">
  #### To add other custom types contact Rivhit call center.
</Callout>

<br />

# Customers Identification

To associate the customer while producing a document/receipt, there are two possible ways:

## By Customer's System Id

The most accurate and certain way to identify the customers is by sending the serial customer number as it defined in the system.

In order to do that, the merchant system/website server needs to hold all the customers and their identify numbers accordingly.

To identify by that value send the request parameter:

`'customer_id'`

The Rivhit customer serial number

<br />

## By Customer's Identify details

Try to locate the customer by specific identifier (phone number, ID number, email),

The identifier must be included in the request and has to be unique to this customer.

If a customer is not found by the identifier/s that was defined - a new customer will be created.

<br />

Send the request parameters:

`'create_customer' = true`

Enables customer identification mechanism

> New customer will be created automatically If there wasn't any existing customer with the identify values sent.

<br />

`'find_by_mail' = true`

Search by email

`'email_to'`

The customer email

<br />

`'find_by_id' =  true`

Search by ID number

`'id_number'`

The customer Israeli Id or Vat number

<br />

`'find_by_phone' = true`

Search by phone number

`'phone'`

The customer phone number

<br />

`'find_by_acc_ref' = true`

Search by third party identifier

`'acc_ref'`

The customer third party identifier

<br />

# Customer Reports

For customers and other relevant report - [Go to here](https://rivhit-api.readme.io/docs/customers-and-accounting-reports#/).