Document VAT Settings - Exempt/Not Exempt

To define the document VAT settings send request parameter:

'sort_code'

100 - With VAT

150 - Exempt VAT

📘
This are the sort code default values in Rivhit (the settings can be different and changed in the specific business account)

Example of VAT Section in the document:

Set with VAT -

Exempt VAT -

Items Total Amount Settings - With/Without VAT

To define if the document items amounts include the VAT or not send request parameter:

'price_include_vat'

true- the items amounts will includes the VAT

false- the items amounts will will not include the VAT

📘
The default value will be by the document settings

The System VAT Calculation

The system will handle the VAT and Items total calculation by this settings and according to the document type.

Case 1: Document with Payments Array - like 'Invoice Receipt'

Parameter value sent:

'price include vat = true'

Total Items array value should be equal to total payments array value.

No need to calculate the VAT - the system will extend and display it accordingly.

price include vat example

Request
{
  "api_token": "DECD03E5-E35C-41E8-84F7-FBA2FB483928",
  "document_type": 2,
  "customer_id": 0,
  "last_name": "Doe",
  "first_name": "John",
  "price_include_vat": true,
  "currency_id": 1,
  "round_digits": 0,
  "items": [
      {
          "item_id": 0,
          "quantity": 1,
          "price_nis": 10,
          "description": "Item Test"
      }
  ],
  "payments": [
      {
          "payment_type": 2,
          "description": "Cash",
          "amount_nis": 10
      }
  ]
}

Document produced:

Parameter value sent:

'price include vat = false'

Total items array value should not include the VAT.

Total Payments array value should include the VAT added.

Calculation should be done and added on the merchant server and sent to the Document.New method accordingly.

price not include vat example

Request
{
  "api_token": "DECD03E5-E35C-41E8-84F7-FBA2FB483928",
  "document_type": 2,
  "customer_id": 0,
  "last_name": "Doe",
  "first_name": "John",
  "price_include_vat": false,
  "currency_id": 1,
  "round_digits": 0,
  "items": [
      {
          "item_id": 0,
          "quantity": 1,
          "price_nis": 10,
          "description": "Item Test"
      }
  ],
  "payments": [
      {
          "payment_type": 2,
          "description": "Cash",
          "amount_nis": 11.8
      }
  ]
}

Document produced:

Case 2: Document with items Array only - like 'Invoice' ,'Shipping Certificate' etc.

Parameter value sent:

'price include vat = true'

The document total will be the same as it was sent.

The system will extend and display the VAT from the items amount sent accordingly.

price include vat example

Request
{
  "api_token": "DECD03E5-E35C-41E8-84F7-FBA2FB483928",
  "document_type": 1,
  "customer_id": 0,
  "last_name": "Doe",
  "first_name": "John",
  "price_include_vat": true,
  "currency_id": 1,
  "round_digits": 0,
  "items": [
      {
          "item_id": 0,
          "quantity": 1,
          "price_nis": 10,
          "description": "Item Test"
      }
  ]
}

Document produced:

Parameter value sent:

'price include vat = false'

The document total will be with VAT added to the amount sent.

The system will calculate the VAT and add it to the items total amount that was sent.

price not include vat example

Request
{
  "api_token": "DECD03E5-E35C-41E8-84F7-FBA2FB483928",
  "document_type": 1,
  "customer_id": 0,
  "last_name": "Doe",
  "first_name": "John",
  "price_include_vat": false,
  "currency_id": 1,
  "round_digits": 0,
  "items": [
      {
          "item_id": 0,
          "quantity": 1,
          "price_nis": 10,
          "description": "Item Test"
      }
  ]
}

Document produced: