v1

latestOpenAPI 3.0.02026-08-04880393.1 KB

Add a New Accounting Journal.

post/online/RivhitOnlineAPI.svc/Accounting.AddJournal

Request body

api_tokenstring uuid required

Rivhit Merchant API Identifier.

Default: No

yearinteger nullable

Year of the Accounting Journal.

Format: YYYY Default: Current year

monthinteger nullable

Month of the Accounting Journal.

Format: MM Default: Current month

sort_codeinteger required

The Sort Code Type.

Common: 100 = With Vat 150 = Exempt Vat Range: 0 to 999 Default: No

customer_id_debitinteger required

Journal Debit Code.

~ Invoice - Customer ID, Receipt - Rivhit Payment Code (Check 7 Cash 8..)
Range: 0 to 999999999 Default: No

customer_id_creditinteger nullable

Journal Credit Code.

~ Invoice - Rivhit Income Code (With VAT 4 Exempt Vat 6), Receipt - Customer ID
Range: 0 to 999999999 Default: 0

reference_datestring date nullable

Reference Date for the Accounting Journal.

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

due_datestring date nullable

Due Date for the Accounting Journal.

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

amountnumber float required

Amount of the Accounting Journal in ILS.

Range: Decimal limit (can be negative) Default: No

reference1string nullable

The First Reference Value - Will be Saved in the Accounting Journal.

Length: 1 to 10 Default: Rivhit settings

reference2string nullable

The Second Reference Value - Will be Saved in the Accounting Journal.

Length: 1 to 10 Default: Rivhit settings

detailsstring nullable

Details for the Accounting Journal.

Length: 1 to 80 Default: No

currency_idinteger nullable

Accounting Journal Currency Type (Rivhit Settings).

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

foreign_amountnumber float nullable

Amount of the Accounting Journal in MTC.

Range: Decimal limit (can be negative) Default: 0

exchange_ratenumber double nullable

Fixed Currency Exchange Rate to ILS.

~ From MTC to ILS Range: Decimal limit Default: 0

project_idinteger nullable

Project Id Serial Number (Rivhit system).

Range: 0 to 999999999 Default: No

id_numberinteger nullable

Customer Israeli Id (by Custom Format).

Range: 8-9 digits Default: No

request_referencestring nullable

The Accounting Journal Creation Request Reference.

~ Use for future search with method - Status.LastRequest ~ Should be unique value Length: 2GB Default: No

shaam_invoiceinteger nullable

Tax Assignment number.

Range: 0 to 999999999 Default: No

Example request

{
  "api_token": "DECD03E5-E35C-41E8-84F7-FBA2FB483928",
  "year": 2025,
  "month": 7,
  "sort_code": 100,
  "reference_date": "26/01/2025",
  "due_date": "08-01-2025",
  "amount": 1234.56,
  "reference1": "Ab12345678",
  "reference2": "Ab12345678",
  "details": "String content",
  "currency_id": 1,
  "foreign_amount": 12678967.543233,
  "exchange_rate": 3.456789,
  "project_id": 1,
  "id_number": 123456790,
  "request_reference": "abcdefg-&123456789",
  "shaam_invoice": 214748364
}

Response

Success - Accounting Journal Added.

error_codeinteger

The Response Error/Status Number (0 = Success).

client_messagestring

The Client Error Message.

debug_messagestring

The Response Error Message.

Example response

{
  "error_code": 0,
  "client_message": "String content",
  "debug_message": "String content",
  "data": {
    "year": "2025",
    "month": "7",
    "line": "2062"
  }
}