Documents

Document classes

The API covers the following classes of documents:

  • Sale invoices
  • Sale orders
  • Sale quotes
  • Purchase orders
  • Purchase invoices
  • Payments
  • Receipts

Document endpoints are accessible using their class name:

  • api/saleOrder/...
  • api/saleInvoice/...

A generic endpoint api/document/... is also available, but it will require elevated permissions to query across all classes of documents.

Retrieving documents

Searching for a range of documents (summary result):

  • filtering

    • GET https://api.iplicit.com/api/document?LastModifiedFrom=2020-07-10
    • GET https://api.iplicit.com/api/purchaseInvoice?currency=EUR&docType=APPO

  • pagination is done via skip / take.

    • page 1: GET https://api.iplicit.com/api/document?LastModifiedFrom=2020-07-1&skip=0&take=50
    • page 2: GET https://api.iplicit.com/api/document?LastModifiedFrom=2020-07-1&skip=50&take=50
    • page 3: GET https://api.iplicit.com/api/document?LastModifiedFrom=2020-07-1&skip=100&take=50

A single document can be retrieved by both id or code:

  • GET https://api.iplicit.com/api/document/1a590f73-64f7-4341-a4db-24ba15a55d78
  • GET https://api.iplicit.com/api/document/POR004

Read more