---
title: "Get document details"
method: POST
path: "/accounting/documents/getdetails/"
tags: ["Accounting (Documents)"]
---

# Get document details

`POST /accounting/documents/getdetails/`

Documents can be located either using DocumentID, or a combination of both DocumentType and DocumentNumber.

## Headers

- `Content-Language` unknown

## Request body

- AccountingDocumentsGetDetailsRequest
  - `Credentials` CoreAPICredentials, required
    - `CompanyID` integer, required — Company identifier
    - `APIKey` string, required — API key secret
  - `DocumentID` integer, nullable — Document identifier The system ID number. Seen in the url as the "c" number when doecument is viewed, or EntityID when document is received through a trigger. If used, DocumentID + DocumentType are not needed.
  - `DocumentType` 'Invoice (0)' | 'InvoiceAndReceipt (1)' | 'Receipt (2)' | 'ProformaInvoice (3)' | 'DonationReceipt (4)' | 'CreditInvoice (5)' | 'CreditInvoiceAndReceipt (6)' | 'CreditReceipt (7)' | 'Order (8)' | 'DeliveryNote (9)' | 'GoodsReturnNote (10)' | 'PurchasingOrder (11)' | 'PriceQuotation (12)' | 'PaymentRequest (13)' | 'CreditDonationReceipt (14)' | 'ExpenseInvoiceReceipt (15)' | 'ExpenseInvoice (16)' | 'ExpenseReceipt (17)' | 'ExpenseRequest (18)' | 'CreditExpenseInvoiceReceipt (19)' | 'CreditExpenseInvoice (20)' | 'CreditExpenseReceipt (21)' | 'SupplierPayment (22)'
  - `DocumentNumber` integer, nullable — Document number This number appears in the document title. It must have a value when DocumentType is used, and not needed if DocumentID is used.

## Response `200`

OK

- ResponseAccountingDocumentsGetDetailsResponse
  - `Status` 'Success (0)' | 'BusinessError (1)' | 'TechnicalError (2)'
  - `UserErrorMessage` string, nullable — Error message, in a user readable format
  - `TechnicalErrorDetails` string, nullable — Technical error details, let us know if you received this.
  - `Data` AccountingDocumentsGetDetailsResponse
    - `Document` AccountingTypedGetDetailsDocument
      - `IsDraft` boolean, nullable — Document is Draft
      - `Date` string, date-time, nullable — Document date
      - `Customer` AccountingTypedCustomer
        - `ID` integer, nullable — SUMIT identifier Leave empty to create a new entity or search by other fields when applicable
        - `Folder` string, nullable — Folder identifier. Can be either application folder name, or FolderID.
        - `Properties` object, nullable — Entity fields
        - `Name` string, nullable — Customer full name (or company name) Required for creating new customer (Leave empty to search by other fields)
        - `Phone` string, nullable — Customer phone number (Optional field)
        - `EmailAddress` string, nullable — Customer email address (Optional field)
        - `City` string, nullable — Customer city (Optional field)
        - `Address` string, nullable — Customer address (Optional field)
        - `ZipCode` string, nullable — Customer ZipCode (Optional field)
        - `CompanyNumber` string, nullable — Customer registered company number (VAT number) (Optional field)
        - `ExternalIdentifier` string, nullable — Customer external identifier. External identifier from calling application. Optional field
        - `NoVAT` boolean, nullable — NoVAT indication Set to true for VAT exempt customers Defaults to False
        - `SearchMode` 'Automatic (0)' | 'None (1)' | 'ExternalIdentifier (2)' | 'Name (3)' | 'CompanyNumber (4)' | 'Phone (5)' | 'EmailAddress (6)' — Customer searching mode
      - `Language` 'Hebrew (0)' | 'English (1)' | 'Arabic (2)' | 'Spanish (3)'
      - `Currency` 'ILS (0)' | 'USD (1)' | 'EUR (2)' | 'CAD (3)' | 'CHF (4)' | 'GBP (5)' | 'AUD (6)' | 'JPY (8)' | 'SEK (9)' | 'NOK (10)' | 'DKK (11)' | 'ZAR (12)' | 'JOD (13)' | 'LBP (14)' | 'EGP (15)' | 'ARS (32)' | 'BSD (44)' | 'BHD (48)' | 'BDT (50)' | 'AMD (51)' | 'BBD (52)' | 'BMD (60)' | 'BTN (64)' | 'BOB (68)' | 'BWP (72)' | 'BZD (84)' | 'SBD (90)' | 'BND (96)' | 'MMK (104)' | 'BIF (108)' | 'KHR (116)' | 'CVE (132)' | 'KYD (136)' | 'LKR (144)' | 'CLP (152)' | 'CNY (156)' | 'COP (170)' | 'KMF (174)' | 'CRC (188)' | 'HRK (191)' | 'CUP (192)' | 'CZK (203)' | 'DOP (214)' | 'SVC (222)' | 'ETB (230)' | 'ERN (232)' | 'FKP (238)' | 'FJD (242)' | 'DJF (262)' | 'GMD (270)' | 'GIP (292)' | 'GTQ (320)' | 'GNF (324)' | 'GYD (328)' | 'HTG (332)' | 'HNL (340)' | 'HKD (344)' | 'HUF (348)' | 'ISK (352)' | 'INR (356)' | 'IDR (360)' | 'IRR (364)' | 'IQD (368)' | 'JMD (388)' | 'KZT (398)' | 'KES (404)' | 'KPW (408)' | 'KRW (410)' | 'KWD (414)' | 'KGS (417)' | 'LAK (418)' | 'LSL (426)' | 'LRD (430)' | 'LYD (434)' | 'MOP (446)' | 'MWK (454)' | 'MYR (458)' | 'MVR (462)' | 'MUR (480)' | 'MXN (484)' | 'MNT (496)' | 'MDL (498)' | 'MAD (504)' | 'OMR (512)' | 'NAD (516)' | 'NPR (524)' | 'ANG (532)' | 'AWG (533)' | 'VUV (548)' | 'NZD (554)' | 'NIO (558)' | 'NGN (566)' | 'PKR (586)' | 'PAB (590)' | 'PGK (598)' | 'PYG (600)' | 'PEN (604)' | 'PHP (608)' | 'QAR (634)' | 'RUB (643)' | 'RWF (646)' | 'SHP (654)' | 'SAR (682)' | 'SCR (690)' | 'SLL (694)' | 'SGD (702)' | 'VND (704)' | 'SOS (706)' | 'SZL (748)' | 'SYP (760)' | 'THB (764)' | 'TOP (776)' | 'TTD (780)' | 'AED (784)' | 'TND (788)' | 'UGX (800)' | 'MKD (807)' | 'TZS (834)' | 'UYU (858)' | 'UZS (860)' | 'WST (882)' | 'YER (886)' | 'TWD (901)' | 'CUC (931)' | 'ZWL (932)' | 'BYN (933)' | 'TMT (934)' | 'GHS (936)' | 'SDG (938)' | 'RSD (941)' | 'MZN (943)' | 'AZN (944)' | 'RON (946)' | 'TRY (949)' | 'XAF (950)' | 'XCD (951)' | 'XOF (952)' | 'XPF (953)' | 'XAU (959)' | 'XDR (960)' | 'XAG (961)' | 'ZMW (967)' | 'SRD (968)' | 'MGA (969)' | 'AFN (971)' | 'TJS (972)' | 'AOA (973)' | 'BGN (975)' | 'CDF (976)' | 'BAM (977)' | 'UAH (980)' | 'GEL (981)' | 'PLN (985)' | 'BRL (986)' | 'CLF (990)'
      - `Type` 'Invoice (0)' | 'InvoiceAndReceipt (1)' | 'Receipt (2)' | 'ProformaInvoice (3)' | 'DonationReceipt (4)' | 'CreditInvoice (5)' | 'CreditInvoiceAndReceipt (6)' | 'CreditReceipt (7)' | 'Order (8)' | 'DeliveryNote (9)' | 'GoodsReturnNote (10)' | 'PurchasingOrder (11)' | 'PriceQuotation (12)' | 'PaymentRequest (13)' | 'CreditDonationReceipt (14)' | 'ExpenseInvoiceReceipt (15)' | 'ExpenseInvoice (16)' | 'ExpenseReceipt (17)' | 'ExpenseRequest (18)' | 'CreditExpenseInvoiceReceipt (19)' | 'CreditExpenseInvoice (20)' | 'CreditExpenseReceipt (21)' | 'SupplierPayment (22)'
      - `Description` string, nullable — Document description. The description is shown in the printed document.
      - `ExternalReference` string, nullable — Document external reference (expense invoice number).
      - `DueDate` string, date-time, nullable — Document due date
      - `DocumentValue` number, double, nullable — Document value in document currency ILS
      - `CompanyValue` number, double, nullable — Document value in ILS
      - `IsClosed` boolean, nullable — Document closed indicator (mostly used for Proforma invoices and Payment requests)
      - `AssignmentNumber` string, nullable — Document assignment number (מספר הקצאה)
    - `Items` AccountingTypedDocumentItem[], nullable
      - `Quantity` number, double, nullable — Quantity Defaults to 1
      - `UnitPrice` number, double, nullable — Single Unit price in ILS Leave this empty for non-ILS documents and automatic exchange rate.
      - `TotalPrice` number, double, nullable — Total price in ILS Leave this empty to auto calculate on ILS documents: Total price - Unit price * Quantity. Leave this empty for non-ILS documents and automatic exchange rate.
      - `DocumentCurrency_UnitPrice` number, double, nullable — Unit price in document currency Single unit price in the document currency. Leave this empty for ILS documents / automatic exchange rate.
      - `DocumentCurrency_TotalPrice` number, double, nullable — Total price in document currency Leave this empty to auto calculate: Total price - Unit price * Quantity. Leave this empty for ILS documents / automatic exchange rate.
      - `VAT` number, double, nullable — VAT in ILS. Can only be specified when using VATPerItem.
      - `DocumentCurrency_VAT` number, double, nullable — VAT in document currency Can only be specified when using VATPerItem.
      - `Item` AccountingTypedIncomeItem
        - `ID` integer, nullable — SUMIT identifier
        - `Name` string, nullable — Item name
        - `Description` string, nullable — Item description
        - `Price` number, double, nullable — Item price (for single unit)
        - `Currency` 'ILS (0)' | 'USD (1)' | 'EUR (2)' | 'CAD (3)' | 'CHF (4)' | 'GBP (5)' | 'AUD (6)' | 'JPY (8)' | 'SEK (9)' | 'NOK (10)' | 'DKK (11)' | 'ZAR (12)' | 'JOD (13)' | 'LBP (14)' | 'EGP (15)' | 'ARS (32)' | 'BSD (44)' | 'BHD (48)' | 'BDT (50)' | 'AMD (51)' | 'BBD (52)' | 'BMD (60)' | 'BTN (64)' | 'BOB (68)' | 'BWP (72)' | 'BZD (84)' | 'SBD (90)' | 'BND (96)' | 'MMK (104)' | 'BIF (108)' | 'KHR (116)' | 'CVE (132)' | 'KYD (136)' | 'LKR (144)' | 'CLP (152)' | 'CNY (156)' | 'COP (170)' | 'KMF (174)' | 'CRC (188)' | 'HRK (191)' | 'CUP (192)' | 'CZK (203)' | 'DOP (214)' | 'SVC (222)' | 'ETB (230)' | 'ERN (232)' | 'FKP (238)' | 'FJD (242)' | 'DJF (262)' | 'GMD (270)' | 'GIP (292)' | 'GTQ (320)' | 'GNF (324)' | 'GYD (328)' | 'HTG (332)' | 'HNL (340)' | 'HKD (344)' | 'HUF (348)' | 'ISK (352)' | 'INR (356)' | 'IDR (360)' | 'IRR (364)' | 'IQD (368)' | 'JMD (388)' | 'KZT (398)' | 'KES (404)' | 'KPW (408)' | 'KRW (410)' | 'KWD (414)' | 'KGS (417)' | 'LAK (418)' | 'LSL (426)' | 'LRD (430)' | 'LYD (434)' | 'MOP (446)' | 'MWK (454)' | 'MYR (458)' | 'MVR (462)' | 'MUR (480)' | 'MXN (484)' | 'MNT (496)' | 'MDL (498)' | 'MAD (504)' | 'OMR (512)' | 'NAD (516)' | 'NPR (524)' | 'ANG (532)' | 'AWG (533)' | 'VUV (548)' | 'NZD (554)' | 'NIO (558)' | 'NGN (566)' | 'PKR (586)' | 'PAB (590)' | 'PGK (598)' | 'PYG (600)' | 'PEN (604)' | 'PHP (608)' | 'QAR (634)' | 'RUB (643)' | 'RWF (646)' | 'SHP (654)' | 'SAR (682)' | 'SCR (690)' | 'SLL (694)' | 'SGD (702)' | 'VND (704)' | 'SOS (706)' | 'SZL (748)' | 'SYP (760)' | 'THB (764)' | 'TOP (776)' | 'TTD (780)' | 'AED (784)' | 'TND (788)' | 'UGX (800)' | 'MKD (807)' | 'TZS (834)' | 'UYU (858)' | 'UZS (860)' | 'WST (882)' | 'YER (886)' | 'TWD (901)' | 'CUC (931)' | 'ZWL (932)' | 'BYN (933)' | 'TMT (934)' | 'GHS (936)' | 'SDG (938)' | 'RSD (941)' | 'MZN (943)' | 'AZN (944)' | 'RON (946)' | 'TRY (949)' | 'XAF (950)' | 'XCD (951)' | 'XOF (952)' | 'XPF (953)' | 'XAU (959)' | 'XDR (960)' | 'XAG (961)' | 'ZMW (967)' | 'SRD (968)' | 'MGA (969)' | 'AFN (971)' | 'TJS (972)' | 'AOA (973)' | 'BGN (975)' | 'CDF (976)' | 'BAM (977)' | 'UAH (980)' | 'GEL (981)' | 'PLN (985)' | 'BRL (986)' | 'CLF (990)'
        - `Cost` number, double, nullable — Item cost (for single unit)
        - `ExternalIdentifier` string, nullable — Income item external identifier
        - `SKU` string, nullable
        - `SearchMode` 'Automatic (0)' | 'None (1)' | 'ExternalIdentifier (2)' | 'Name (3)' | 'SKU (4)' | 'Description (5)'
        - `Properties` object, nullable — Entity fields
      - `Description` string, nullable — Document description. The description is shown in the printed document.
    - `Payments` AccountingTypedDocumentPayment[], nullable
      - `Amount` number, double, nullable — Received payment amount Leave this empty for non-ILS documents and automatic exchange rate
      - `DocumentCurrency_Amount` number, double, nullable — Received payment amount Leave this empty for ILS documents / automatic exchange rate
      - `Type` 'Automatic (0)' | 'General (1)' | 'Cash (2)' | 'BankTransfer (3)' | 'Cheque (4)' | 'CreditCard (5)' | 'Digital (6)' | 'TaxWithholding (7)' | 'Other (8)'
      - `PaymentElementID` integer, nullable — Payment Element ID Leave Empty for Automatic (Detect by the supplied Details fields).
      - `Details_General` AccountingTypedPaymentGeneral
      - `Details_Cash` AccountingTypedPaymentCash
      - `Details_BankTransfer` AccountingTypedPaymentBankTransfer
        - `BankNumber` integer, nullable — Israeli bank number For instance, 12 indicates Bank Hapoalim.
        - `BranchNumber` integer, nullable — Israeli bank branch number
        - `AccountNumber` string, nullable — Bank account number
        - `Reference` string, nullable — Bank reference number
        - `DueDate` string, date-time, nullable — Payment date
      - `Details_Cheque` AccountingTypedPaymentCheque
        - `BankNumber` integer, nullable — Israeli bank number For instance, 12 indicates Bank Hapoalim.
        - `BranchNumber` integer, nullable — Israeli bank branch number
        - `AccountNumber` string, nullable — Bank account number
        - `ChequeNumber` string, nullable — Cheque number
        - `DueDate` string, date-time, nullable — Due date
      - `Details_CreditCard` AccountingTypedPaymentCreditCard
        - `CardBrand` string, nullable — Credit card brand
        - `Last4Digits` string, nullable — Last 4 credit card digits
        - `FirstPayment` number, double, nullable — First payment amount Optional
        - `EachPayment` number, double, nullable — Each payment amount (excluding first payment) Optional
        - `Payments` integer, nullable — Credit card payments count (defaults to 1)
      - `Details_Other` AccountingTypedPaymentOther
        - `Type` string, nullable — Payment type
        - `Description` string, nullable — Payment description
        - `DueDate` string, date-time, nullable — Due date
      - `Details_Digital` AccountingTypedPaymentDigital
        - `Type` string, nullable — Digital payment type
        - `Description` string, nullable — Digital payment description
      - `Details_TaxWithholding` AccountingTypedPaymentTaxWithholding
    - `DocumentDownloadURL` string, nullable — Document download URL Produced document will be original on first visit, or certified copy on additional visits.
    - `DocumentPaymentURL` string, nullable — Document payment URL
    - `DocumentID` integer — SUMIT Document identifier DocumentID is an internal identifier (also known as Card Number on SUMIT. Keep this for further API calls.
    - `DocumentNumber` integer, nullable — Document number For instance, for Invoice #1000, the DocumentNumber will be 1000.

---

[API](https://skmtc.net/myofficeguy/apis/sumit-api-full.md) · [All operations](https://skmtc.net/myofficeguy/apis/sumit-api-full/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/myofficeguy/sumit-api-full/revisions/5bd7e67f2af4/schema)