Document.New

post

https://api.rivhit.co.il/online/RivhitOnlineAPI.svc/Document.New

Create a New Document (Invoice, Shipping List, Order, ect..)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

api_token

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 | null

Customer First Name.

Length: 1 to 20
Default: Customer details

address

string | null

Customers Address.

Length: 1 to 30
Default: Customer details

city

string | null

Customer's city.

Length: 1 to 20
Default: Customer details

zipcode

integer | null

Customers Zipcode.

Range: 0 to 9999999
Default: Customer details

acc_ref

string | null

Customer Outer System Identifier.

Length: 1 to 9
Default: No

phone

string | null

Customer Phone Number.

Length: 1 to 15
Default: Customer details

customer_type

integer | null

enum

Type of the Customer - to Create.

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

Allowed:

id_number

integer | null

Customer Israeli Id (by Custom Format).

Range: 8-9 digits
Default: No

reference

integer | null

The Reference Value - Will be Saved in the Invoice.

Range: 0 to 999999999
Default: Rivhit settings

order

string | null

The Sale Order Value.

Length: 1 to 15
Default: No

agent_id

integer | null

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 | null

Project Id Serial Number (Rivhit system).

Range: 0 to 999999999
Default: No

comments

string | null

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

integer | null

enum

Discount Type.

Options: (1 = percentage 2 = amount)
Default: No

Allowed:

discount_value

double

Discount value.

Range: 0 to 999999999.99
Default: No

price_include_vat

boolean | null

Items Sent With or Without VAT.

Default: Document settings

due_date

date

Due Date for the Document.

Format: DD-MM-YY or DD/MM/YYYY
Default: Rivhit settings

issue_date

date

Issue Date of the Document.

Format: DD-MM-YY or DD/MM/YYYY
Default: Current day

issue_time

string | null

^([01]?[0-9]|2[0-3]):([0-5]?[0-9])$

Issue Time of the Document.

Format: HH:MM
Default: Current time

currency_id

integer | null

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

double | null

Fixed Currency Exchange Rate to ILS.

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

reject_item_quantity

boolean | null

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 | null

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

string | null

enum

Set the Document Language.

Options: (he/en)
Default: he

Allowed:

email_to

string | null

Customer Email Address.

Length: 6 to 50
Default: Customer details

email_bcc

string | null

Bcc Email Address.

Length: 6 to 50
Default: Rivhit mailing settings

digital_signature

boolean | null

Produce the Document With a Digital Signature.

true = With digital signature
Default: false

signature_pin

string | null

The Digital Signature PIN Code.

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

items

array of objects

required

items*

payments

array of objects

payments

check_only

boolean | null

Activate Check Mode.

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

request_reference

string | null

The Document Request Reference.

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

prevent_duplicates

boolean | null

Activate Prevent Duplicates.

~ Combine with request reference
Default: No

create_customer

boolean | null

Create a New Customer in Rivhit System.

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

send_mail

boolean | null

Send the Document to the Customer.

Default: true

find_by_mail

boolean | null

Locate Customer by Email Address.

Default: false

find_by_id

boolean | null

Locate Customer by Israeli Id/VAT Number.

Default: false

find_by_acc_ref

boolean | null

Locate Customer by the acc_ref

Default: false

find_by_phone

boolean | null

Locate Customer by Phone Number.

Default: false

create_items

boolean | null

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 | null

Customer Foreign Zip Code.

Length: 1 to 7
Default: No

thermal_print

boolean | null

Activate Thermal Print.

Default: false

validate_id

boolean | null

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

integer | null

enum

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

Allowed:

logo_url

url | null

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

Responses

200Success - Document Created

400Request Error

500Internal Server Error