banks2ff/firefly-iii-api/docs/TransactionSplit.md

TransactionSplit

Properties

Name	Type	Description	Notes
user	Option<String>	User ID	[optional][readonly]
transaction_journal_id	Option<String>	ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals making up the splits of the transaction.	[optional][readonly]
r#type	models::TransactionTypeProperty
date	String	Date of the transaction
order	Option<i32>	Order of this entry in the list of transactions.	[optional]
currency_id	Option<String>	Currency ID. Default is the source account's currency, or the user's default currency. Can be used instead of currency_code.	[optional]
currency_code	Option<String>	Currency code. Default is the source account's currency, or the user's default currency. Can be used instead of currency_id.	[optional]
currency_symbol	Option<String>		[optional][readonly]
currency_name	Option<String>		[optional][readonly]
currency_decimal_places	Option<i32>	Number of decimals used in this currency.	[optional][readonly]
foreign_currency_id	Option<String>	Currency ID of the foreign currency. Default is null. Is required when you submit a foreign amount.	[optional]
foreign_currency_code	Option<String>	Currency code of the foreign currency. Default is NULL. Can be used instead of the foreign_currency_id, but this or the ID is required when submitting a foreign amount.	[optional]
foreign_currency_symbol	Option<String>		[optional][readonly]
foreign_currency_decimal_places	Option<i32>	Number of decimals in the currency	[optional][readonly]
amount	String	Amount of the transaction.
foreign_amount	Option<String>	The amount in a foreign currency.	[optional]
description	String	Description of the transaction.
source_id	Option<String>	ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account.
source_name	Option<String>	Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name.	[optional]
source_iban	Option<String>		[optional][readonly]
source_type	Option<models::AccountTypeProperty>		[optional]
destination_id	Option<String>	ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account.
destination_name	Option<String>	Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough.	[optional]
destination_iban	Option<String>		[optional][readonly]
destination_type	Option<models::AccountTypeProperty>		[optional]
budget_id	Option<String>	The budget ID for this transaction.	[optional]
budget_name	Option<String>	The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored.	[optional][readonly]
category_id	Option<String>	The category ID for this transaction.	[optional]
category_name	Option<String>	The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name.	[optional]
bill_id	Option<String>	Optional. Use either this or the bill_name	[optional]
bill_name	Option<String>	Optional. Use either this or the bill_id	[optional]
reconciled	Option<bool>	If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user.	[optional]
notes	Option<String>		[optional]
tags	Option<Vec>	Array of tags.	[optional]
internal_reference	Option<String>	Reference to internal reference of other systems.	[optional]
external_id	Option<String>	Reference to external ID in other systems.	[optional]
external_url	Option<String>	External, custom URL for this transaction.	[optional]
original_source	Option<String>	System generated identifier for original creator of transaction.	[optional][readonly]
recurrence_id	Option<String>	Reference to recurrence that made the transaction.	[optional][readonly]
recurrence_total	Option<i32>	Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite.	[optional][readonly]
recurrence_count	Option<i32>	The # of the current transaction created under this recurrence.	[optional][readonly]
bunq_payment_id	Option<String>	Internal ID of bunq transaction. DEPRECATED	[optional]
import_hash_v2	Option<String>	Hash value of original import transaction (for duplicate detection).	[optional][readonly]
sepa_cc	Option<String>	SEPA Clearing Code	[optional]
sepa_ct_op	Option<String>	SEPA Opposing Account Identifier	[optional]
sepa_ct_id	Option<String>	SEPA end-to-end Identifier	[optional]
sepa_db	Option<String>	SEPA mandate identifier	[optional]
sepa_country	Option<String>	SEPA Country	[optional]
sepa_ep	Option<String>	SEPA External Purpose indicator	[optional]
sepa_ci	Option<String>	SEPA Creditor Identifier	[optional]
sepa_batch_id	Option<String>	SEPA Batch ID	[optional]
interest_date	Option<String>		[optional]
book_date	Option<String>		[optional]
process_date	Option<String>		[optional]
due_date	Option<String>		[optional]
payment_date	Option<String>		[optional]
invoice_date	Option<String>		[optional]
latitude	Option<f64>	Latitude of the transaction's location, if applicable. Can be used to draw a map.	[optional]
longitude	Option<f64>	Latitude of the transaction's location, if applicable. Can be used to draw a map.	[optional]
zoom_level	Option<i32>	Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels.	[optional]
has_attachments	Option<bool>	If the transaction has attachments.	[optional]

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