v1

latestOpenAPI 3.0.02026-08-04880393.1 KB

Customer.Update

post/online/RivhitOnlineAPI.svc/Customer.Update

Request body

api_tokenstring uuid required

Rivhit Merchant API Identifier.

Format: UUID Default: No

customer_idinteger required

Rivhit Customer Identifier.

Range: 0 to 999999999 Default: No

last_namestring

Customer Last Name/Company Name.

Length: 1 to 30 Default: Customer details

first_namestring nullable

Customer First Name.

Length: 1 to 20 Default: Customer details

addressstring nullable

Customers Address.

Length: 1 to 30 Default: Customer details

citystring nullable

Customer's city.

Length: 1 to 20 Default: Customer details

pobinteger nullable

Customers Postal Code.

Range: 0 to 9999999 Default: Customer details

zipcodeinteger nullable

Customers Zipcode.

Range: 0 to 9999999 Default: Customer details

phonestring nullable

Customer Phone Number.

Length: 1 to 15 Default: Customer details

phone2string nullable

Customer Second Phone Number.

Length: 1 to 15 Default: Customer details

faxstring nullable

Customer Fax Number.

Length: 1 to 15 Default: Customer details

emailstring email nullable

Customer Email Address.

Length: 6 to 50 Default: Customer details

id_numberinteger nullable

Customer Israeli Id (by Custom Format).

Range: 8-9 digits Default: No

vat_numberinteger nullable

Customer Israeli Vat Number(by Custom Format).

Range: 8-9 digits Default: No

agent_idinteger nullable

Agent Id Serial Number (Rivhit system).

Range: 0 to 999999999 Default: Customer settings

project_idinteger nullable

Project Id Serial Number (Rivhit system).

Range: 0 to 999999999 Default: No

paying_customer_idinteger

Defined a Paying Custommer.

Range: 0 to 999999999 Default: No

price_list_idinteger

Customer Price List.

Range: 0 to 999 Default: Price list settings

commentsstring nullable

Additional Comments About the Customer.

Length: 1 to 400 Default: Customer settings

customer_type1 | 20 | 60 nullable

Type of the Customer - to Create.

Options: (1 = Customers 20 = Suppliers 60 = Agents) Default: Rivhit settings (usually 1)

pal_code6 | 30 nullable

Customer Balance Sheet Type.

Options: (6 = Customers 30 = Suppliers) Default: Rivhit settings (usually 6)

acc_refstring nullable

Customer Third Party System Identifier.

Length: 1 to 20 Default: Customer details

countrystring

Customer Country.

Length: 1 to 39 Default: Customer details

statestring

Customer State.

Length: 1 to 10 Default: No

foreign_zipcodestring nullable

Customer Foreign Zip Code.

Length: 1 to 7 Default: No

currency_idinteger nullable

Document Currency Type.

Options: (1 = NIS 2 = USD 3 = EURO 4 = GBP 5 = AUD 6 = CAD 7 = CHF 8 = SEK 9 = DKK 10 = NOK) Default: Rivhit settings

exempt_vatboolean nullable

Set if Customer is Exempt.

Default: Not exempt

credit_terms1 | 2 | 3 nullable

Customer Credit Terms.

~ Combine Net EOM/Net with value "credit_days"
Options: (1 = Cash 2 = Net EOM 3 = Net) Default: No

credit_daysinteger nullable

Customer Credit Days.

Range: 1-100 Default: Rivhit settings

discount_percentnumber double

Discount value.

Range: 0 to 999999999.99 Default: No

request_referencestring nullable

The Customer creation Request Reference.

~ Use for future search with method - Status.LastRequest ~ Should be unique value Length: 2GB Default: No

Example request

{
  "api_token": "0279BF82-CD57-49BA-837C-930F0E2EB805",
  "last_name": "Israeli",
  "first_name": "Moshe",
  "address": "Ben Yehuda 1",
  "city": "Tel Aviv",
  "pob": 6329302,
  "zipcode": 6329302,
  "phone": "054-4444444",
  "phone2": "054-4444444",
  "fax": "054-4444444",
  "email": "a@a.com",
  "id_number": 123456790,
  "vat_number": 123456790,
  "paying_customer_id": 1,
  "price_list_id": 1,
  "comments": "Comments will be here",
  "customer_type": 1,
  "pal_code": 1,
  "acc_ref": "aa123",
  "country": "Israel",
  "state": "Texas",
  "foreign_zipcode": "ab123456",
  "currency_id": 1,
  "exempt_vat": true,
  "credit_terms": 1,
  "credit_days": 1,
  "discount_percent": 10,
  "request_reference": "abcdefg-&123456789"
}

Response

Success - Customer Updated.

error_codeinteger

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

client_messagestring

The Client Error Message.

debug_messagestring

The Response Error Message.

Example response

{
  "data": {
    "update_success": true
  }
}