v1

latestOpenAPI 3.1.12026-08-0684304578.8 KB
Accounting (Documents)

Get document details

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

post/accounting/documents/getdetails/

Headers

{"stackTrail":"paths:/accounting/documents/getdetails/:post:parameters:0:schema","oasType":"schema","type":"unknown"}

Sets the content response language. Defaults to Hebrew (he).

Request body

DocumentIDinteger 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)'
DocumentNumberinteger 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

OK

Status'Success (0)' | 'BusinessError (1)' | 'TechnicalError (2)'
UserErrorMessagestring nullable

Error message, in a user readable format

TechnicalErrorDetailsstring nullable

Technical error details, let us know if you received this.