Request parameters (JSON):

  • tenant - (mandatory) - business tenant, e.g. "zegoal"
  • account_id - (conditional) - Account ID
  • account_name - (conditional) - Account Name
  • account_code - (conditional) - Account Code
  • payment_id - (optional; default "") - Payment ID
  • payment_external_id - (optional; default "") - payment external id (from payment system, CRM, 1c...)
  • 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.

Response parameters (JSON):


  • GetAccountInvoices
  • request
    • "input" (request parameters) as is; only those parameters that were sent in input
  • response
    • <all request parameters> (filled with default values if were missing in input)
    • TZ - time zone of processing
      • payments - array of found invoices
        [0..n]
        • paym_target_id - Payment target id
        • paym_source_id - Payment source id
        • paym_ext_id - Payment external id
        • paym_amt - Payment amount
        • effective_date - Effective date

Example

{
  "tenant": "zegoal",
  "account_id": 1,
  "from_date": "2019-01-01",
  "to_date": "2021-01-01"
}
CODE


{
   "processing_result":    {
      "text": "success",
      "status": "ok",
      "code": 0
   },
   "processing_date": "2019-11-19 14:31:03",
   "GetAccountPayments":    {
      "response":       {
         "tenant": "zegoal",
         "skip_lookup_account": false,
         "payments":          [
                        {
               "payment_id": 2,
               "paym_target_id": "",
               "paym_source_id": "UI",
               "paym_external_id": "4mtT3DQQ",
               "paym_amt": "1",
               "effective_date": "2019-11-19 14:21:31",
               "balance_name": "Money_BYN"
            },
                        {
               "payment_id": 1,
               "paym_target_id": "",
               "paym_source_id": "UI",
               "paym_external_id": "7HJf3NGm",
               "paym_amt": "1",
               "effective_date": "2019-11-19 14:21:05",
               "balance_name": "Money_BYN"
            }
         ],
         "account_name": "hhh",
         "account_id": 1,
         "account_code": "anna2",
         "TZ": "Europe/Minsk"
      },
      "request":       {
  			"tenant": "zegoal",
  			"account_id": 1,
  			"from_date": "2019-01-01",
  			"to_date": "2021-01-01"
      }
   }
}
CODE