Skip to content

Latest commit

 

History

History
executable file
·
40 lines (36 loc) · 7.85 KB

Transaction.md

File metadata and controls

executable file
·
40 lines (36 loc) · 7.85 KB
Raw

Transaction

Properties

Name Type Description Notes
Id int64 Transaction identifier [default to null]
ParentId int64 Parent transaction identifier [optional] [default to null]
AccountId int64 Account identifier [default to null]
ValueDate string Value date in the format 'YYYY-MM-DD HH:MM:SS.SSS' (german time). [default to null]
BankBookingDate string Bank booking date in the format 'YYYY-MM-DD HH:MM:SS.SSS' (german time). [default to null]
FinapiBookingDate string finAPI Booking date in the format 'YYYY-MM-DD HH:MM:SS.SSS' (german time). NOTE: In some cases, banks may deliver transactions that are booked in future, but already included in the current account balance. To keep the account balance consistent with the set of transactions, such &quot;future transactions&quot; will be imported with their finapiBookingDate set to the current date (i.e.: date of import). The finapiBookingDate will automatically get adjusted towards the bankBookingDate each time the associated bank account is updated. Example: A transaction is imported on July, 3rd, with a bank reported booking date of July, 6th. The transaction will be imported with its finapiBookingDate set to July, 3rd. Then, on July 4th, the associated account is updated. During this update, the transaction's finapiBookingDate will be automatically adjusted to July 4th. This adjustment of the finapiBookingDate takes place on each update until the bank account is updated on July 6th or later, in which case the transaction's finapiBookingDate will be adjusted to its final value, July 6th.<br/> The finapiBookingDate is the date that is used by the finAPI PFM services. E.g. when you calculate the spendings of an account for the current month, and have a transaction with finapiBookingDate in the current month but bankBookingDate at the beginning of the next month, then this transaction is included in the calculations (as the bank has this transaction's amount included in the current account balance as well). [default to null]
Amount float32 Transaction amount [default to null]
Purpose string Transaction purpose. Maximum length: 2000 [optional] [default to null]
CounterpartName string Counterpart name. Maximum length: 80 [optional] [default to null]
CounterpartAccountNumber string Counterpart account number [optional] [default to null]
CounterpartIban string Counterpart IBAN [optional] [default to null]
CounterpartBlz string Counterpart BLZ [optional] [default to null]
CounterpartBic string Counterpart BIC [optional] [default to null]
CounterpartBankName string Counterpart Bank name [optional] [default to null]
CounterpartMandateReference string The mandate reference of the counterpart [optional] [default to null]
CounterpartCustomerReference string The customer reference of the counterpart [optional] [default to null]
CounterpartCreditorId string The creditor ID of the counterpart [optional] [default to null]
Type_ string Transaction type, according to the bank. If set, this will contain a German term that you can display to the user. Some examples of common values are: &quot;Lastschrift&quot;, &quot;Auslands&uuml;berweisung&quot;, &quot;Geb&uuml;hren&quot;, &quot;Zinsen&quot;. The maximum possible length of this field is 255 characters. [optional] [default to null]
TypeCodeZka string ZKA business transaction code which relates to the transaction's type. Possible values range from 1 through 999. If no information about the ZKA type code is available, then this field will be null. [optional] [default to null]
TypeCodeSwift string SWIFT transaction type code. If no information about the SWIFT code is available, then this field will be null. [optional] [default to null]
SepaPurposeCode string SEPA purpose code, according to ISO 20022 [optional] [default to null]
Primanota string Transaction primanota (bank side identification number) [optional] [default to null]
Category *Category Transaction category, if any is assigned. Note: Recently imported transactions that have currently no category assigned might still get categorized by the background categorization process. To check the status of the background categorization, see GET /bankConnections. Manual category assignments to a transaction will remove the transaction from the background categorization process (i.e. the background categorization process will never overwrite a manual category assignment). [optional] [default to null]
Labels []Label Array of assigned labels [optional] [default to null]
IsPotentialDuplicate bool While finAPI uses a well-elaborated algorithm for uniquely identifying transactions, there is still the possibility that during an account update, a transaction that was imported previously may be imported a second time as a new transaction. For example, this can happen if some transaction data changes on the bank server side. However, finAPI also includes an algorithm of identifying such &quot;potential duplicate&quot; transactions. If this field is set to true, it means that finAPI detected a similar transaction that might actually be the same. It is recommended to communicate this information to the end user, and give him an option to delete the transaction in case he confirms that it really is a duplicate. [default to null]
IsAdjustingEntry bool Indicating whether this transaction is an adjusting entry ('Zwischensaldo').<br/><br/>Adjusting entries do not originate from the bank, but are added by finAPI during an account update when the bank reported account balance does not add up to the set of transactions that finAPI receives for the account. In this case, the adjusting entry will fix the deviation between the balance and the received transactions so that both adds up again.<br/><br/>Possible causes for such deviations are:<br/>- Inconsistencies in how the bank calculates the balance, for instance when not yet booked transactions are already included in the balance, but not included in the set of transactions<br/>- Gaps in the transaction history that finAPI receives, for instance because the account has not been updated for a while and older transactions are no longer available [default to null]
IsNew bool Indicating whether this transaction is 'new' or not. Any newly imported transaction will have this flag initially set to true. How you use this field is up to your interpretation. For example, you might want to set it to false once a user has clicked on/seen the transaction. You can change this flag to 'false' with the PATCH method. [default to null]
ImportDate string Date of transaction import, in the format 'YYYY-MM-DD HH:MM:SS.SSS' (german time). [default to null]
Children []int64 Sub-transactions identifiers (if this transaction is split) [optional] [default to null]
PaypalData *PaypalTransactionData Additional, PayPal-specific transaction data. This field is only set for transactions that belong to an account of the 'PayPal' bank (BLZ 'PAYPAL').<br/>NOTE: This field is deprecated as the bank with blz 'PAYPAL' is no longer supported. Do not use this field, as it will be removed at some point. [optional] [default to null]
EndToEndReference string End-To-End reference [optional] [default to null]

[Back to Model list] [Back to API list] [Back to README]