Struktura API

Systém Dativery se obvykle přizpůsobuje cílovému systému. Pokud ovšem API pro bankovní výpisy navrhujete, doporučujeme do API zahrnout tyto atributy záznamu bankovní transakce či platby.

Identifikátor - pro deduplikaci transakcí, potřebujeme mít možnost zapsat (a deduplikovat) dle ID, které je unikátní. Tím zajístíme, aby se jedna platba nezapsala vícekrát. Toto ID může mít až 30 znaků.

Položka	Typ	Název	Popis
incoming	boolean	Příchozí platba	Hodnota určuje, zda jde z pohledu bankovního účtu o příchozí či odchozí platbu (resp. debetní či kreditní operaci). Hodnota může být nahrazena uvedením znaménka u částky.
amount	number	Částka	Záporné hodnoty jsou považovány za odchozí platby, kladné za příchozí.
transactionalFeeAmount	number	Poplatek	Částka poplatku. Pokud je součástí platby i poplatek, uveďte jej zde. Pokud je celá platba poplatkem, použijte isTransactionalFee
isTransactionalFee	boolean	Je celá platba poplatkem?	Pokud je celá platba poplatkem, bude tak i zaúčtována. Částka je v amount. Nelze kombinovat s transactionalFeeAmount
currencyCode	string	Kód měny účtu	Odpovídá měně účtu, resp. v jakých měnách lze účet vést v případě multiměnových účtů. V tříznakovém formátu dle ISO, např. CZK, EUR, USD, ...
dateOfPayment	datetime	Datum a čas platby	Dativery u platby rozlišuje několik kalendářních dat datumů, ale pro účetnictví stačí obvykle zvolit jedno z těchto dat.
variableSymbol	string	Variabilní symbol	Variabilní symbol platby používaný v Česku a na Slovensku. Při případném párování jsou ignorovány všechny úvodní nuly, tj. hodnota je uvažována jako číslo a nikoliv jako řetězec.
specificSymbol	string	Specifický symbol	Specifický symbol platby používaný v Česku a na Slovensku.
constantSymbol	string	Konstantní symbol	Konstantní symbol platby používaný v Česku a na Slovensku.
bankAccountNumber	string	Číslo protiúčtu bez banky	Číslo protiúčtu včetně předčíslí, ale bez číselného kódu banky. Číslo není povinné.
bankNumberCode	string	Kód banky protiúčtu	Čtyřmístný číselný kód banky protiúčtu používaný v Česku. Není povinné
transactionType	string	Způsob platby	Popsání způsobu provedení platby, např. karta, převodem.
iban	string	IBAN protiúčtu	Mezinárodní číslo protiúčtu. Může být vyplněné současně s číslem protiúčtu, není povinné.
bic	string	BIC kód protiúčtu (SWIFT kód)	Kód BIC banky protiúčtu, není povinné.
bankAccountName	string	Název účtu protistrany.
privateNote	string	Můj popis	Popis platby.
description	string	Popis protistrany	Popis platby protistranou.
transactionId	string	Identifikace platby	Unikátní identifikace platby, unikátní minimálně v kontextu bankovního účtu. Důvodem je potřeba určit, zda byla platba do cílového systému již zapsána či nikoliv.
originalAmount	number	Částka v jiné měně	Částka v jiné měně než je měna účtu. Bude prázdné v případě, že měna platby je shodná s měnou účtu.
originalAmountCurrencyCode	string	Kód jiné měny platby	Kód měny platby, pokud je jiná než měna účtu. Bude prázdné v případě, že měna platby je shodná s měnou účtu.
exchangeRate	number	Směnný kurz.	Koeficient směnného kurzu použitého pro automatickou konverzi.

Obecněji o unifikaci API.