API Reference

Document.New

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

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required

Rivhit Merchant API Identifier.

Default: No

integer
required

Document type.

Range: 0 to 999 Default: No

integer
required

Rivhit Customer Identifier.

Range: 0 to 999999999 Default: No

string
required

Customer Last Name/Company Name.

Length: 1 to 30 Default: Customer details

string | null

Customer First Name.

Length: 1 to 20 Default: Customer details

string | null

Customers Address.

Length: 1 to 30 Default: Customer details

string | null

Customer's city.

Length: 1 to 20 Default: Customer details

integer | null

Customers Zipcode.

Range: 0 to 9999999 Default: Customer details

string | null

Customer Outer System Identifier.

Length: 1 to 9 Default: No

string | null

Customer Phone Number.

Length: 1 to 15 Default: Customer details

integer | null
enum

Type of the Customer - to Create.

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

Allowed:
integer | null

Customer Israeli Id (by Custom Format).

Range: 8-9 digits Default: No

integer | null

The Reference Value - Will be Saved in the Invoice.

Range: 0 to 999999999 Default: Rivhit settings

string | null

The Sale Order Value.

Length: 1 to 15 Default: No

integer | null

Agent Id Serial Number (Rivhit system).

Range: 0 to 999999999 Default: Customer settings

integer

Defined a Paying Custommer by Id.

Range: 0 to 999999999 Default: No

integer | null

Project Id Serial Number (Rivhit system).

Range: 0 to 999999999 Default: No

string | null

The Customer Comments (to print on the invoice).

Length: 1 to 400 Default: Rivhit system settings

integer

The Sort Code Type.

Common: 100 = With Vat 150 = Exempt Vat Range: 0 to 999 Default: Rivhit Document Settings

integer | null
enum

Discount Type.

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

Allowed:
double

Discount value.

Range: 0 to 999999999.99 Default: No

boolean | null

Items Sent With or Without VAT.

Default: Document settings

date

Due Date for the Document.

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

date

Issue Date of the Document.

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

string | null

Issue Time of the Document.

Format: HH:MM Default: Current time

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

double | null

Fixed Currency Exchange Rate to ILS.

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

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

boolean | null

Disable Reducing Items From the Stock.

True = Don't reduce items from stock False = Reduce items from stock Default: false

integer

CRM User Id (Set the Document Producer).

Range: 0 to 99999 Default: Rivhit user settings

string | null
enum

Set the Document Language.

Options: (he/en) Default: he

Allowed:
string | null

Customer Email Address.

Length: 6 to 50 Default: Customer details

string | null

Bcc Email Address.

Length: 6 to 50 Default: Rivhit mailing settings

boolean | null

Produce the Document With a Digital Signature.

true = With digital signature
Default: false

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

Activate Check Mode.

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

string | null

The Document Request Reference.

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

boolean | null

Activate Prevent Duplicates.

~ Combine with request reference Default: No

boolean | null

Create a New Customer in Rivhit System.

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

boolean | null

Send the Document to the Customer.

Default: true

boolean | null

Locate Customer by Email Address.

Default: false

boolean | null

Locate Customer by Israeli Id/VAT Number.

Default: false

boolean | null

Locate Customer by the acc_ref

Default: false

boolean | null

Locate Customer by Phone Number.

Default: false

boolean | null

Create New Items.

Default: false

integer

Set the Starting Number for a New Document.

~ Only when it is the first document Range: 0 to 999999
Default: Documents settings

integer

Set the Type of Existing Document to be closed.

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

integer

Set the Number of Existing Document to be closed.

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

string

Customer Country.

Length: 1 to 39 Default: Customer details

string

Customer State.

Length: 1 to 10 Default: No

string | null

Customer Foreign Zip Code.

Length: 1 to 7 Default: No

boolean | null

Activate Thermal Print.

Default: false

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

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

The Business Logo - Printed on the Document.

Length: 15 to 400 Default: Rivhit system settings

boolean

Use the Default Customer Mail Address.

Default: false

Responses

Updated 10 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago