Request parameters:

  • tenant - (mandatory) - business tenant, e.g. "zegoal"
  • account_id - (conditional) - Account ID
  • account_name - (conditional) - Account Name
  • account_code - (conditional) - Account Code
  • invoice_id - (optional; default "") - Invoice ID
  • invoice_type - (optional; default "") - Invoice Type (interim, regular); empty or missing value will mean "all types"
  • invoice_status - (optional; default "") - Invoice Status (covered, noncovered); empty or missing value will mean "all statuses"
  • from_date - (optional; default "") - from (start) date of a checked period
  • to_date - (optional; default "") - to (end) date of a checked period

One of conditional parameters: account_id, or account_name, or account_code - is mandatory to be provided.


Responce parameters:

API returns invoice collection with all attributes.


Request example

{
 "tenant": "zegoal",
 "account_id": "2",
 "FromDate": "2016-01-01",
 "ToDate": "2020-01-01",
 "invoice_type": "interim"
}
CODE

Response example

 {
   "processing_result":    {
      "text": "success",
      "status": "ok",
      "code": 0
   },
   "processing_date": "2019-04-25 16:16:01",
   "GetInvoiceData":    {
      "response":       {
         "to_date": "",
         "tenant": "zegoal",
         "skip_lookup_account": false,
         "invoices": [         {
            "uncovered_doc_amt": 0,
            "statement_date": "2019-04-24 16:40:02",
            "render_file_name": "/static/invoices/zegoal/bill_2_1_2019-04-24.pdf",
            "pymnt_due_date": "2019-05-05 00:00:00",
            "origin": "interim",
            "is_paid": 1,
            "end_balance": "325.00",
            "doc_amt_net": "0.00",
            "doc_amt_gross": 0,
            "covered_doc_amt": 0,
            "bill_type_id": "invoice",
            "bill_id": 1,
            "account_id": 2
         }],
         "invoice_type": "interim",
         "invoice_status": "",
         "invoice_id": "",
         "from_date": "",
         "account_name": "Название аккаунта 27",
         "account_id": 2,
         "account_code": "27",
         "ToDate": "2020-01-01",
         "TZ": "Europe/Minsk",
         "FromDate": "2016-01-01"
      },
      "request":       {
         "tenant": "zegoal",
         "invoice_type": "interim",
         "account_id": "2",
         "ToDate": "2020-01-01",
         "FromDate": "2016-01-01"
      }
   }
}
CODE