--- title: "Receipt.New" method: POST path: "/online/RivhitOnlineAPI.svc/Receipt.New" --- # Receipt.New `POST /online/RivhitOnlineAPI.svc/Receipt.New` ## Request body - object - `api_token` string, uuid, required — Rivhit Merchant API Identifier. **Default:** No - `receipt_type` integer, required — Receipt type. **Range:** 0 to 999 **Default:** No - `customer_id` integer, required — Rivhit Customer Identifier. **Range:** 0 to 999999999 **Default:** No - `last_name` string, required — Customer Last Name/Company Name. **Length:** 1 to 30 **Default:** Customer details - `first_name` string, nullable — Customer First Name. **Length:** 1 to 20 **Default:** Customer details - `address` string, nullable — Customers Address. **Length:** 1 to 30 **Default:** Customer details - `city` string, nullable — Customer's city. **Length:** 1 to 20 **Default:** Customer details - `zipcode` integer, nullable — Customers Zipcode. **Range:** 0 to 9999999 **Default:** Customer details - `phone` string, nullable — Customer Phone Number. **Length:** 1 to 15 **Default:** Customer details - `acc_ref` string, nullable — Customer Outer System Identifier. **Length:** 1 to 9 **Default:** No - `id_number` integer, nullable — Customer Israeli Id (by Custom Format). **Range:** 8-9 digits **Default:** No - `issue_date` string, date — Issue Date of the receipt. ~ Date format DD-MM-YY or DD/MM/YYYY **Length:** 1 to 10 **Default:** Current day - `issue_time` string, nullable — Issue time of the receipt. ~ Time format HH:MM **Length:** 1 to 5 **Default:** Current time - `reference` integer, nullable — The Reference Value - Will be Saved in the Invoice. **Range:** 0 to 9999999999 **Default:** Rivhit settings - `comments` string, nullable — The Customer Comments (to print on the invoice). **Length:** 1 to 400 **Default:** Rivhit system settings - `agent_id` integer, nullable — Agent Id Serial Number (Rivhit system). **Range:** 0 to 999999999 **Default:** Customer details - `project_id` integer, nullable — Project Id Serial Number (Rivhit system). **Range:** 0 to 999999999 **Default:** No - `currency_id` integer, 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_rate` number, double, nullable — Fixed Currency Exchange Rate to ILS. ~ From MTC to ILS **Range:** Decimal limit (only positive) **Default:** Rivhit Settings - `crm_user_id` integer — 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_to` string, email, nullable — Customer Email Address. **Length:** 6 to 50 **Default:** Customer details - `email_bcc` string, email, nullable — Bcc Email Address. **Length:** 6 to 50 **Default:** Rivhit mailing settings - `digital_signature` boolean, nullable — Produce the Receipt With a Digital Signature. true = With digital signature **Default:** false - `signature_pin` string, nullable — The Digital Signature PIN Code. ~ *Send only by API support instructions* **Length:** 3 to 6 **Default:** No - `payments` object[], required - `payment_type` integer, required — The Payment Type. ~ common Rivhit default values (1 = Check 2 = Cash 4 = Isracard 5 = Visa 9 = Bank Transfer) **Range:** 1 to 99 **Default:** No - `amount_nis` number, float, required — The Payment Price in ILS. ~ Mandatory in ILS charge **Range:** Decimal limit (can be negative) **Default:** No - `due_date` string, date, nullable — Due Date for the Receipt. ~ Date format DD-MM-YY or DD/MM/YYYY **Length:** 1 to 10 **Default:** Rivhit payments settings - `check_number` integer — Check/Transaction Voucher Number. ~ Mandatory in check payment **Range:** 5 to 9 **Default:** No - `bank_code` integer — Check Bank Code. ~ Mandatory in check payment **Range:** 1 to 3 **Default:** No - `branch_number` integer — Check Bank Branch Number. ~ Mandatory in check payment **Range:** 1 to 999999999 **Default:** No - `bank_account_number` string — Check Bank Branch Number. ~ Mandatory in check payment **Range:** 1 to 9 **Default:** No - `amount_mtc` number, float, required — The Payment Price in MTC. ~ Mandatory in MTC charge **Range:** Decimal limit (can be negative) **Default:** No - `description` string, nullable, required — Payment Description. **Length:** 1 to 30 **Default:** Payments settings - `number_of_payments` integer, nullable — Number of Multiple Payments. ~ The system will divide the payments **Range:** 1 to 999 **Default:** Single payment - `check_only` boolean, nullable — Activate Check Mode. ~ Response will include status and error message. **Default:** false - `request_reference` string, nullable — The Receipt Request Reference. ~ Combine with prevent_duplicates ~ Should be unique value **Length:** 2GB **Default:** No - `prevent_duplicates` boolean, nullable — Activate Prevent Duplicates. ~ Combine with request reference **Default:** No - `create_customer` boolean, nullable — Create a New Customer in Rivhit System. ~ When exsiting customer can't be found **Default:** false - `send_mail` boolean, nullable — Send the Receipt to the Customer. **Default:** true - `find_by_mail` boolean, nullable — Locate Customer by Email Address. **Default:** false - `find_by_id` boolean, nullable — Locate Customer by Israeli Id/VAT Number. **Default:** false - `find_by_acc_ref` boolean, nullable — Locate Customer by the acc_ref. **Default:** false - `find_by_phone` boolean, nullable — Locate Customer by Phone Number. **Default:** false - `receipt_number` integer — Set the Starting Number for a New Receipt. ~ Only when it is the first receipt **Range:** 1 to 99999 **Default:** Receipts settings - `closed_document_type` integer — Set the Type of Existing Document to be closed. ~ Combine with ClosedDocumentNumber **Range:** 1 to 999 **Default:** No - `closed_document_number` integer — Set the Number of Existing Document to be closed. ~ combine with ClosedDocumentType **Range:** 1 to 999999 **Default:** No - `country` string — Customer Country. **Length:** 1 to 39 **Default:** Customer details - `state` string — Customer State. **Length:** 1 to 10 **Default:** No - `foreign_zipcode` string, nullable — Customer Foreign Zip Code. **Length:** 1 to 7 **Default:** No - `thermal_print` boolean, nullable — Activate Thermal Print. **Default:** false - `logo_url` string, url, nullable — The Business Logo - Printed on the Receipt. **Length:** 15 to 400 **Default:** Rivhit system settings - `default_email` boolean — Use the Default Customer Mail Address. **Default:** false - `item_id` integer — Rivhit Item Identifier (For Delayed Receipts). ~ This item id will be defined in the future invoice. **Range:** 0 to 999999999 **Default:** 0 - `items` object[] - `item_id` integer, required — Rivhit Item Identifier. **Range:** 0 to 999999999 **Default:** Document settings - `catalog_number` string — Item Catalog Number (SKU). **Length:** 1 to 15 **Default:** Item details - `description` string, required — The Item Description. **Length:** 1 to 100 **Default:** Rivhit item settings ## Response `200` Success - Receipt Created - 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 - `document_type` integer — Receipt Type. - `document_number` integer — Receipt number. - `customer_id` integer — Customer Identifier. - `document_identity` string — Receipt Identifier. - `document_link` string, url — Receipt Link. - `print_status` integer — Digital Signature Error/Status (0 = Success). - `amount` number, float — Receipt Amount. - `confirmation_number` integer — Confirmation Number. ## 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/versions/ed5261a52458/schema)