Find Bank Transactions for Bank Account

Egy bankszámlához tartozó tranzakciók lekérdezése.

Endpoint: POST /v1/bank_transaction/by_bank_account/{bankAccountId}

Request:

• fejléc
  • x-api-key: API-kulcs
• paraméterek
  • bankAccountId: a bankszámla id-ja

Request body:

{
   "filter": {
      "transaction_ids": [1, 2, 3],
      "transaction_id": {
         "minimum": 1
      },
      "value_date": {
         "minimum": "2021-06-30"
      },
      "updated_on": {
         "minimum": "2021-07-22T00:00:00Z"
      },
      "include_reconciled": true,
      "query": ""
   },
   "page": {
      "size": 10,
      "index": 0
   }
}

filter mezői (a tranzakciók közötti szűréshez):

• transaction_ids: leszűkíti a találatokat az id alapján megadott tranzakciókra; ha null vagy üres, akkor nem történik szűrés ez alapján
• transaction_id: egész szám típusú szűrő a tranzakció id-jára; ha nincs megadva vagy null, akkor nem történik szűrés ez alapján
• value_date: dátum típusú szűrő a tranzakció értéknapjára; ha nincs megadva vagy null, akkor nem történik szűrés ez alapján
• updated_on: dátum+időpont típusú szűrő a tranzakció Billcityben történt utolsó módosításának időpontjára; ha nincs megadva vagy null, akkor nem történik szűrés ez alapján
• include_reconciled: ha igaz, akkor a már teljesen pontozott tranzakciókat is tartalmazza a válasz; ha false, vagy nincs megadva, akkor csak a pontozatlan vagy részben pontozott tranzakciók lesznek a válaszban
• query: egyszerű szöveges szűrő; keres a tranzakció ellenpartnerének a nevében, a közleményben, valamint (ha a kifejezés egy szám) akkor a tranzakció értékében; ha null vagy üres, akkor nem történik szűrés ez alapján

page mezői (a találatok közötti lapozáshoz):

• size: egy oldalon található tranzakciók száma
• index: a kívánd oldal sorszáma (0-val kezdődik)

Response:

{
   "items": [
      ...
   ],
   "count": 433,
   "pages": 44
}

Response mezői:

• items: az talált tranzakciók listája
• count: a találatok száma
• pages: a kérésben megadott page.size oldalméret mellett az oldalak száma

Amennyiben a megadott szűrés szerint nincs találat, az items lista üres, a count és page mezők értéke pedig 0.