Models

RecurrenceTransaction

object

idstring

Example

ID of the recurring transaction. Not to be confused with the ID of the recurrence itself.

descriptionstringrequired

Example

Rent for the current month

object_has_currency_settingbooleanread only

Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency.

Example

true

currency_idstring

The currency ID of the currency associated with this object.

Example

currency_namestring

The currency name of the currency associated with this object.

Example

Euro

currency_codestring

The currency code of the currency associated with this object.

Example

EUR

currency_symbolstringread only

Example

currency_decimal_placesinteger<int32>read only

Example

primary_currency_idstringread only

The currency ID of the administration's primary currency.

Example

primary_currency_namestringread only

The currency name of the administration's primary currency.

Example

Euro

primary_currency_codestringread only

The currency code of the administration's primary currency.

Example

EUR

primary_currency_symbolstringread only

The currency symbol of the administration's primary currency.

Example

primary_currency_decimal_placesinteger<int32>read only

The currency decimal places of the administration's primary currency.

Example

amountstring<amount>required

Amount of the transaction.

Example

123.45

pc_amountstring<amount>

Amount of the transaction in primary currency.

Example

123.45

foreign_amountstring<amount> | null

Foreign amount of the transaction.

Example

123.45

pc_foreign_amountstring<amount> | null

Foreign amount of the transaction.

Example

123.45

foreign_currency_idstring | null

Example

foreign_currency_namestring | null

Example

British Pound

foreign_currency_codestring | null

Example

GBP

foreign_currency_symbolstring | nullread only

Example

foreign_currency_decimal_placesinteger<int32> | nullread only

Number of decimals in the currency

Example

budget_idstring

The budget ID for this transaction.

Example

budget_namestring | nullread only

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.

Example

Groceries

category_idstring

Category ID for this transaction.

Example

category_namestring

Category name for this transaction.

Example

Bills

source_idstring

ID of the source account. Submit either this or source_name.

Example

source_namestring

Name of the source account. Submit either this or source_id.

Example

Checking account

source_ibanstring | nullread only

Example

NL02ABNA0123456789

source_typeAccountTypePropertyDefault accountCash accountAsset accountExpense accountRevenue accountInitial balance accountBeneficiary accountImport accountReconciliation accountLoanDebtMortgageread only

Example

Asset account

destination_idstring

ID of the destination account. Submit either this or destination_name.

Example

destination_namestring

Name of the destination account. Submit either this or destination_id.

Example

Buy and Large

destination_ibanstring | nullread only

Example

NL02ABNA0123456789

destination_typeAccountTypePropertyDefault accountCash accountAsset accountExpense accountRevenue accountInitial balance accountBeneficiary accountImport accountReconciliation accountLoanDebtMortgageread only

Example

Asset account

tagsArray<string> | null

Array of tags.

Example

null

piggy_bank_idstring | null

Example

piggy_bank_namestring | null

subscription_idstring | null

Example

subscription_namestring | null

Example

{
  "id": "ID of the recurring transaction. Not to be confused with the ID of the recurrence itself.",
  "description": "Rent for the current month",
  "object_has_currency_setting": true,
  "currency_id": "5",
  "currency_name": "Euro",
  "currency_code": "EUR",
  "currency_symbol": "$",
  "currency_decimal_places": 2,
  "primary_currency_id": "5",
  "primary_currency_name": "Euro",
  "primary_currency_code": "EUR",
  "primary_currency_symbol": "$",
  "primary_currency_decimal_places": 2,
  "amount": "123.45",
  "pc_amount": "123.45",
  "foreign_amount": "123.45",
  "pc_foreign_amount": "123.45",
  "foreign_currency_id": "17",
  "foreign_currency_name": "British Pound",
  "foreign_currency_code": "GBP",
  "foreign_currency_symbol": "$",
  "foreign_currency_decimal_places": 2,
  "budget_id": "4",
  "budget_name": "Groceries",
  "category_id": "211",
  "category_name": "Bills",
  "source_id": "913",
  "source_name": "Checking account",
  "source_iban": "NL02ABNA0123456789",
  "source_type": "Asset account",
  "destination_id": "258",
  "destination_name": "Buy and Large",
  "destination_iban": "NL02ABNA0123456789",
  "destination_type": "Asset account",
  "tags": null,
  "piggy_bank_id": "123",
  "piggy_bank_name": "string",
  "subscription_id": "123",
  "subscription_name": "string"
}