---
title: "Document.New"
method: POST
path: "/online/RivhitOnlineAPI.svc/Document.New"
---

# Document.New

`POST /online/RivhitOnlineAPI.svc/Document.New`

## Request body

- object
  - `api_token` string, uuid, required — Rivhit Merchant API Identifier. **Default:** No
  - `document_type` integer, required — Document 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
  - `acc_ref` string, nullable — Customer Outer System Identifier. **Length:** 1 to 9 **Default:** No
  - `phone` string, nullable — Customer Phone Number. **Length:** 1 to 15 **Default:** Customer details
  - `customer_type` 1 | 20 | 60, nullable — Type of the Customer - to Create. **Options:** (1 = Customers 20 = Suppliers 60 = Agents) **Default:** Rivhit settings (usually 1)
  - `id_number` integer, nullable — Customer Israeli Id (by Custom Format). **Range:** 8-9 digits **Default:** No
  - `reference` integer, nullable — The Reference Value - Will be Saved in the Invoice. **Range:** 0 to 999999999 **Default:** Rivhit settings
  - `order` string, nullable — The Sale Order Value. **Length:** 1 to 15 **Default:** No
  - `agent_id` integer, nullable — Agent Id Serial Number (Rivhit system). **Range:** 0 to 999999999 **Default:** Customer settings
  - `paying_customer_id` integer — Defined a Paying Custommer by Id. **Range:** 0 to 999999999 **Default:** No
  - `project_id` integer, nullable — Project Id Serial Number (Rivhit system). **Range:** 0 to 999999999 **Default:** No
  - `comments` string, nullable — The Customer Comments (to print on the invoice). **Length:** 1 to 400 **Default:** Rivhit system settings
  - `sort_code` integer — The Sort Code Type. **Common:** 100 = With Vat 150 = Exempt Vat **Range:** 0 to 999 **Default:** Rivhit Document Settings
  - `discount_type` 1 | 2, nullable — Discount Type. **Options:** (1 = percentage 2 = amount) **Default:** No
  - `discount_value` number, double — Discount value. **Range:** 0 to 999999999.99 **Default:** No
  - `price_include_vat` boolean, nullable — Items Sent With or Without VAT. **Default:** Document settings
  - `due_date` string, date — Due Date for the Document. **Format:** DD-MM-YY or DD/MM/YYYY **Default:** Rivhit settings
  - `issue_date` string, date — Issue Date of the Document. **Format:** DD-MM-YY or DD/MM/YYYY **Default:** Current day
  - `issue_time` string, nullable — Issue Time of the Document. **Format:** HH:MM **Default:** Current time
  - `currency_id` integer, 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:** Document settings
  - `exchange_rate` number, double, nullable — Fixed Currency Exchange Rate to ILS. ~ From MTC to ILS **Range:** Decimal limit (only positive) **Default:** Rivhit Settings
  - `reject_item_quantity` boolean, nullable — Reject Document Producing by Items Stock. True = produce only when items are in stock false = produce even when items are out of stock **Default:** false
  - `no_update_inventory` boolean, nullable — Disable Reducing Items From the Stock. True = Don't reduce items from stock False = Reduce items from stock **Default:** false
  - `crm_user_id` integer — CRM User Id (Set the Document Producer). **Range:** 0 to 99999 **Default:** Rivhit user settings
  - `language` 'he' | 'en', nullable — Set the Document 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 Document 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
  - `items` object[], required
    - `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
    - `quantity` number, double, required — The Item Quantity. **Range:** 0.1 to 99999999.99 **Default:** No
    - `bruto_price_nis` number, double — The Item Bruto Price in ILS. ~ Send only with ILS Currency ~ Use with document format for discounts. **Range:** Decimal limit (can be negative) **Default:** No
    - `price_nis` number, double, required — The Item Price in ILS. ~ Mandatory in ILS charge **Range:** Decimal limit (can be negative) **Default:** No
    - `currency_id` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 — The Item Currency Type. **Options:** (1 = NIS 2 = USD 3 = EURO 4 = GBP 5 = AUD 6 = CAD 7 = CHF 8 = SEK 9 = DKK 10 = NOK) **Default:** Document settings
    - `price_mtc` number, double, required — The Item Price in foreign currency (MTC). ~ Mandatory in MTC charge **Range:** Decimal limit (can be negative) **Default:** No
    - `exchange_rate` number, double — Fixed Currency Exchange Rate to ILS. ~ Combine with ConvertToNIS **Range:** Decimal limit (only positive) **Default:** Rivhit document settings
    - `storage_id` integer, nullable — Storage Id Serial Number (Rivhit system). ~ The stock will decrease from this storage **Range:** 0 to 999999 **Default:** Rivhit item settings
    - `description` string, required — The Item Description. **Length:** 1 to 100 **Default:** Rivhit item settings
    - `serial_number` string — Serial number of the item. **Length:** 1 to 6 **Default:** No
    - `exempt_vat` boolean, nullable — Indicates if the item is VAT exempt. **Default:** Rivhit item settings
    - `closed_document_type` integer — Document Type to Close With the Item (Partial Closing). **Range:** 1 to 999 **Default:** No
    - `closed_document_num` integer — Document Number to Close With the Item (Partial Closing). **Range:** 1 to 999999 **Default:** No
    - `closed_document_line` integer — Set Item Line Number to Close in the Document (Partial Closing). **Range:** 1 to 232 **Default:** No
  - `payments` object[]
    - `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 Document. **Format:** DD-MM-YY or DD/MM/YYYY **Default:** Rivhit payments settings
    - `check_number` integer — Check/Transaction Voucher Number. ~ Mandatory in check payment **Range:** 1 to 99999999 **Length:** 1 to 8 **Default:** No
    - `bank_code` integer — Check Bank Code. ~ Mandatory in check payment **Range:** 1 to 99 **Default:** No
    - `branch_number` integer — Check Bank Branch Number. ~ Mandatory in check payment **Range:** 1 to 9999999 **Length:** 1 to 7 **Default:** No
    - `bank_account_number` string — Check Bank Branch Number. ~ Mandatory in check payment **Range:** 1 to 999999999 **Length:** 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 Document 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 Document 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
  - `create_items` boolean, nullable — Create New Items. **Default:** false
  - `document_number` integer — Set the Starting Number for a New Document. ~ Only when it is the first document **Range:** 0 to 999999 **Default:** Documents 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
  - `validate_id` boolean, nullable — Activate ID/VAT Validation. ~ False = In case of wrong ID/Vat format - data won't be saved on the document and customer. **Default:** true
  - `round_digits` 0 | 1 | 2, nullable — Round the document amount. ~ Combine with "price_include_vat":false **Options:** (0 = X.00 Full round 1 = X.X0 Partial 2 = X.XX No round) **Default:** Rivhit settings
  - `logo_url` string, url, nullable — The Business Logo - Printed on the Document. **Length:** 15 to 400 **Default:** Rivhit system settings
  - `default_email` boolean — Use the Default Customer Mail Address. **Default:** false

## Response `200`

Success - Document 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 — Document Type.
    - `document_number` integer — Document number.
    - `customer_id` integer — Customer Identifier.
    - `document_identity` string, uuid — Document Identifier.
    - `document_link` string, url — Document Link
    - `print_status` integer — Digital Signature Error/Status (0 = Success)
    - `amount` number, float — Document 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/revisions/ed5261a52458/schema)