Sign in

v1

latestOpenAPI 3.0.02026-08-04880393.1 KB

Receipt.New

post/online/RivhitOnlineAPI.svc/Receipt.New

Request body

api_tokenstring uuid required

Rivhit Merchant API Identifier.

Default: No

receipt_typeinteger required

Receipt type.

Range: 0 to 999 Default: No

customer_idinteger required

Rivhit Customer Identifier.

Range: 0 to 999999999 Default: No

last_namestring required

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

zipcodeinteger nullable

Customers Zipcode.

Range: 0 to 9999999 Default: Customer details

phonestring nullable

Customer Phone Number.

Length: 1 to 15 Default: Customer details

acc_refstring nullable

Customer Outer System Identifier.

Length: 1 to 9 Default: No

id_numberinteger nullable

Customer Israeli Id (by Custom Format).

Range: 8-9 digits Default: No

issue_datestring date

Issue Date of the receipt.

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

issue_timestring nullable

Issue time of the receipt.

~ Time format HH:MM Length: 1 to 5 Default: Current time

referenceinteger nullable

The Reference Value - Will be Saved in the Invoice.

Range: 0 to 9999999999 Default: Rivhit settings

commentsstring nullable

The Customer Comments (to print on the invoice).

Length: 1 to 400 Default: Rivhit system settings

agent_idinteger nullable

Agent Id Serial Number (Rivhit system).

Range: 0 to 999999999 Default: Customer details

project_idinteger nullable

Project Id Serial Number (Rivhit system).

Range: 0 to 999999999 Default: No

currency_idinteger nullable

Receipt Currency Type.

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

exchange_ratenumber double nullable

Fixed Currency Exchange Rate to ILS.

~ From MTC to ILS Range: Decimal limit (only positive) Default: Rivhit Settings

crm_user_idinteger

CRM User Id (Set the Receipt Producer).

Range: 0 to 99999 Default: Rivhit user settings

language'he' | 'en' nullable

Set the Receipt Language.

Options: (he/en) Default: he

email_tostring email nullable

Customer Email Address.

Length: 6 to 50 Default: Customer details

email_bccstring email nullable

Bcc Email Address.

Length: 6 to 50 Default: Rivhit mailing settings

digital_signatureboolean nullable

Produce the Receipt With a Digital Signature.

true = With digital signature
Default: false

signature_pinstring nullable

The Digital Signature PIN Code.

~ Send only by API support instructions Length: 3 to 6 Default: No

check_onlyboolean nullable

Activate Check Mode.

~ Response will include status and error message.
Default: false

request_referencestring nullable

The Receipt Request Reference.

~ Combine with prevent_duplicates ~ Should be unique value Length: 2GB Default: No

prevent_duplicatesboolean nullable

Activate Prevent Duplicates.

~ Combine with request reference Default: No

create_customerboolean nullable

Create a New Customer in Rivhit System.

~ When exsiting customer can't be found
Default: false

send_mailboolean nullable

Send the Receipt to the Customer.

Default: true

find_by_mailboolean nullable

Locate Customer by Email Address.

Default: false

find_by_idboolean nullable

Locate Customer by Israeli Id/VAT Number.

Default: false

find_by_acc_refboolean nullable

Locate Customer by the acc_ref.

Default: false

find_by_phoneboolean nullable

Locate Customer by Phone Number.

Default: false

receipt_numberinteger

Set the Starting Number for a New Receipt.

~ Only when it is the first receipt Range: 1 to 99999
Default: Receipts settings

closed_document_typeinteger

Set the Type of Existing Document to be closed.

~ Combine with ClosedDocumentNumber Range: 1 to 999 Default: No

closed_document_numberinteger

Set the Number of Existing Document to be closed.

~ combine with ClosedDocumentType Range: 1 to 999999 Default: No

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

thermal_printboolean nullable

Activate Thermal Print.

Default: false

logo_urlstring url nullable

The Business Logo - Printed on the Receipt.

Length: 15 to 400 Default: Rivhit system settings

default_emailboolean

Use the Default Customer Mail Address.

Default: false

item_idinteger

Rivhit Item Identifier (For Delayed Receipts).

~ This item id will be defined in the future invoice. Range: 0 to 999999999 Default: 0

Example request

{
  "api_token": "DECD03E5-E35C-41E8-84F7-FBA2FB483928",
  "receipt_type": 1,
  "last_name": "Israeli",
  "first_name": "Moshe",
  "address": "Ben Yehuda 1",
  "city": "Tel Aviv",
  "zipcode": 6329302,
  "phone": "054-4444444",
  "acc_ref": "Ab1234567",
  "id_number": 123456790,
  "issue_date": "01-01-2025",
  "issue_time": "10:30",
  "reference": 12345,
  "comments": "Comments will be here",
  "currency_id": 1,
  "crm_user_id": 5,
  "language": "he",
  "email_to": "a@a.com",
  "email_bcc": "a@a.com\"",
  "digital_signature": true,
  "signature_pin": "Ab123",
  "payments": [
    {
      "payment_type": 2,
      "amount_nis": 100.5,
      "due_date": "08-01-2025",
      "check_number": 100000028,
      "bank_code": 11,
      "branch_number": 118,
      "bank_account_number": "300111",
      "amount_mtc": 25,
      "description": "Cash Payment",
      "number_of_payments": 1
    },
    {
      "payment_type": 5,
      "amount_nis": 200.75,
      "due_date": "10-01-2025",
      "check_number": 100000029,
      "bank_code": 1,
      "branch_number": 119,
      "bank_account_number": "300112",
      "amount_mtc": 50,
      "description": "Visa Payment",
      "number_of_payments": 3
    }
  ],
  "check_only": true,
  "request_reference": "abcdefg-&123456789",
  "prevent_duplicates": true,
  "create_customer": true,
  "send_mail": true,
  "find_by_mail": true,
  "find_by_id": true,
  "find_by_acc_ref": true,
  "find_by_phone": true,
  "receipt_number": 1000,
  "closed_document_type": 1,
  "closed_document_number": 115,
  "country": "Israel",
  "state": "Texas",
  "foreign_zipcode": "ab123456",
  "logo_url": "https://www.rivhit.co.il/wp-content/uploads/2023/01/logo-main.svg ",
  "items": [
    {
      "item_id": 0,
      "catalog_number": "abc123",
      "description": "item test"
    }
  ]
}

Response

Success - Receipt Created

error_codeinteger

The Response Error/Status Number (0 = Success)

client_messagestring

The Client Error Message.

debug_messagestring

The Response Error Message.

Example response

{
  "data": {
    "document_type": 1,
    "document_number": 16402,
    "document_identity": "54e17b1f-3842-459b-a5cf-3d2a3682a2e5",
    "document_link": "https://api.rivhit.co.il/pdf/FileService.svc/GetDocument/000008888/54e17b1f-3842-459b-a5cf-3d2a3682a2e5/true/01_016402",
    "amount": 10
  }
}