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

# Document.Details

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

## 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
  - `document_number` integer, required — Document Number. **Range:** 0 to 999999 **Default:** No

## Response `200`

Success - Document Details Returned

- 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
    - `agent_id` integer — Agent Identifier.
    - `comments` string — The Customer Comments (to print on the invoice).
    - `company_address` string — The Merchant Address
    - `company_fax` string — The Merchant Fax Number.
    - `company_id` integer — The Merchant Identifier.
    - `company_name` string — Name of the Business/Merchant.
    - `company_phone` string — The Merchant Phone Number.
    - `confirmation_number` integer — The Confirmation Number.
    - `country` string — Country of the Business/Merchant.
    - `crm_user_id` integer — CRM User Id (Set the Document Producer).
    - `currency_id` integer — The Item Currency Type.
    - `customer_address` string — Customer Address.
    - `customer_city` string — Customer City.
    - `customer_email` string, email — Customer email.
    - `customer_id` integer — Rivhit Customer Identifier.
    - `customer_id_number` integer — Customer Israeli ID (by Custom Format).
    - `customer_name` string — Customer Full Name (First and Last Name).
    - `customer_phone` string — Customer Phone Number.
    - `customer_zipcode` integer — Customer Zip Code.
    - `discount_amount` number, double — Discount Amount.
    - `discount_percent` number, double — Discount Percentage.
    - `document_date` string — Document Date (DD/MM/YYYY).
    - `document_due_date` string — Document Due Date (DD/MM/YYYY).
    - `document_number` string — The Serial Document Number and Type ("02/000005").
    - `document_total` number, double — The Document Total Amount in NIS.
    - `document_total_mtc` number, double — The Document Total in MTC Currency.
    - `document_type` string — Document type.
    - `documnet_time` string — Document Time of Making (HH:MM:SS).
    - `exchange_rate` number, double — Exchange Rate Used for the Document.
    - `is_cancelled` boolean — Indicates Whether the Document is Cancelled.
    - `is_closed` boolean — Indicates Whether the Document is Closed.
    - `items` object[] — List of Items Included in the Document.
      - `bruto_price_nis` number, double — The Item Bruto Price in ILS.
      - `catalog_number` string — Item Catalog Number (SKU).
      - `description` string — Rivhit Item Description.
      - `discount` number, double — Discount Value.
      - `is_closed` boolean — Indicates whether the item is closed.
      - `item_id` integer — Rivhit Item Identifier.
      - `line` integer — Line Number of the Item in the Document.
      - `mtc_code` integer — MTC Code for the Item.
      - `price_mtc` number, double — The Item Price in foreign currency (MTC).
      - `price_nis` number, double — The Item Price in ILS.
      - `quantity` number, double — The Item Quantity.
      - `storage_id` integer — The Storage Id Serial Number (Rivhit system).
      - `total_line` number, double — Total Amount for the Item in the Line.
    - `order` string — The Order Value.
    - `payments` object[] — List of Payments Associated with the Document.
      - `account_number` string — Account Number of the Bank.
      - `amount` number, double — Payment Amount.
      - `bank` integer — Bank Code.
      - `branch` integer — Bank Branch.
      - `check_number` integer — Check Number for the Payment.
      - `details` string — Payment Description.
      - `due_date` string — Due Date of the Payment (DD/MM/YYYY).
      - `line_number` integer — Line Number of the Payment.
      - `payment_type` string — The Payment Type (Default 1 = Check 2 = Cash 4 = Isracard 5 = Visa 9 = Bank Transfer).
      - `payment_type_format` integer — Format of the Payment Type.
      - `payment_type_id` integer — Payment Type Identifier.
    - `price_include_vat` boolean — Indicates Whether the Item Price Includes VAT.
    - `project_id` integer — Project Identifier.
    - `receipt_total` number, double — Receipt Total Amount.
    - `reference` integer — The Reference Value - Will be Saved in the Invoice.
    - `sort_code` integer — The Sort Code of the Document.
    - `total_vat` number, double — The VAT Amount.
    - `total_without_vat` number, double — Total Amount Without VAT.
    - `vat_percent` string — VAT Percentage.

## 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)