Dokumentace

  • API pro stahování seznamu plateb dle data lze využívat u již používaných napojení (do účetnictví) i lze založit nezávislé napojení.
  • URL na webhook pro každý flow s koncovkou “get-payments”
  • Příklad použití:

https://devel.dativery.com/api/v1/hooks/flow/xxx/xxx/get-payments?fromDate=2024-04-22&toDate=2024-05-22

  • Parametry fromDate a toDate jsou povinné, jsou akceptovány formáty detekovatelné knihovnou momentjs, ovšem doporučovaný datový formát je YYYY-MM-DD
  • Pro použití musí být aktivováno trustyID
  • Je-li položen dotaz na platby, které jsou dříve než je termín od kdy se zpracovávájí s trustyID, zobrazí se chyba

Příkad dat:

{
        "key": "0c6db43fc66d177562d6",
        "com.dativery.model.sharedFields.outgoing@outgoing": true,
        "com.dativery.model.sharedFields.incoming@incoming": false,
        "com.dativery.model.entities.payments@amountSC": -5708.2,
        "com.dativery.model.entities.bankAccountTransactions@amountAC": -5708.2,
        "com.dativery.model.entities.currencies@currencyCode": "CZK",
        "com.dativery.model.entities.bankAccountTransactions@accountCurrencyCode": "CZK",
        "com.dativery.model.entities.bankAccountTransactions@bookingDate": "2024-04-23T00:00:00.000+02:00",
        "com.dativery.model.entities.bankAccountTransactions@instructedAmountSC": -5708.2,
        "com.dativery.model.components.czSkDomesticPaymentsSymbols@constantSymbol": "1178",
        "com.dativery.model.entities.bankAccountTransactions@instructedAmountCurrencyCode": "CZK",
        "cz.csas.databanking2.transactions@transactionDescription2": "US  HTTPSSENTRY.I   SENTRY",
        "cz.csas.databanking2.transactions@transactionDescription3": "USD       234.00 d.přep.22.04.2024",
        "cz.csas.databanking2.transactions@item": "PLATBA KARTOU OBCHODNÍK",
        "cz.csas.databanking2.transactions@transactionDescription1": "XXXXXXXXXXXX3188 d.tran.22.04.2024",
        "cz.csas.databanking2.transactions@transactionDescription4": "234.00 kurz USD 24.394",
        "cz.csas.databanking2.transactions@valueDate": "2024-04-23T00:00:00.000+02:00",
        "com.dativery.model.entities.payments@dateOfPayment": "2024-04-23T00:00:00.000+02:00",
        "cz.csas.databanking2.transactions@effectiveForeignCurrencyDate": "2024-04-23T00:00:00.000+02:00",
        "com.dativery.model.components.czSkDomesticPaymentsSymbols@variableSymbol": "22042024",
        "com.dativery.model.components.czSkDomesticPaymentsSymbols@specificSymbol": "4907293188",
        "com.dativery.model.entities.bankAccounts@bankNumberCode": "0800",
        "com.dativery.model.entities.bankAccounts@bankAccountNumber": "33126726",
        "com.dativery.model.entities.bankAccounts@bankAccountPrefix": "150199",
        "cz.csas.databanking2.transactions@transactionTypeDescription": "PLATBA KARTOU OBCHODNÍK       XXXXXXXXXXXX3188 d.tran.22.04.2024 US  HTTPSSENTRY.I   SENTRY         USD       234.00 d.přep.22.04.2024 234.0",
        "com.dativery.model.entities.bankAccounts@bankAccountPrefixAndNumber": "150199-33126726",
        "com.dativery.model.entities.bankAccountTransactions@unifiedDateOfPayment": "2024-04-23T00:00:00.000+02:00",
        "cz.csas.databanking2.transactions@dativeryTransactionIdSource": "1680011953|22042024|-5708.2|CZK|2024-04-23T00:00:00+02:00|22042024|4907293188|150199-33126726/800|",
        "cz.csas.databanking2.transactions@dativeryTransactionId": "0c6db43fc66d177562d6",
        "cz.csas.databanking2.transactions@itemIdentification": "68574616a0d4b25c5566",
        "cz.csas.databanking2.transactions@transactionId": "22042024",
        "com.dativery.model.components.document.numbers@documentInternalNumber": "22042024",
        "com.dativery.model.entities.bankAccountTransactions@noteForReceiver": "PLATBA KARTOU OBCHODNÍK       XXXXXXXXXXXX3188 d.tran.22.04.2024 US  HTTPSSENTRY.I   SENTRY         USD       234.00 d.přep.22.04.2024 234.0",
        "origKey": "0c6db43fc66d177562d6",
        "transactionId": "0c6db43fc66d177562d6",
        "shortKey": "9ed3006"
    }


key je identifikátor zbytek polí popsáno zde https://bankovni-vypisy.cz/developers/api/
Jsou tam jak obecná pole, tak i specifická pro daný systém. Je-li nějaké pole stejného významu duplicitně, doporučujeme výhradně použít obecný sloupec (tj. com.dativery.model….)

Příklad samostatného scénáře: https://app.dativery.com/s/csas-databanking-statements-to-dativery-universal-api/