bank_transactions

Shows a bank_transaction for editing

Changed on

Displays a bank_transaction by id

get/api/v1/bank_transactions/{id}/edit

Request

Path parameters

idstring string required

The BankTransaction Hashed ID

Query parameters

includestring
Example:first_load

Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes

Headers

X-API-TOKENstring required
Example:TOKEN

The API token to be used for authentication

X-Requested-Withstring required
Example:XMLHttpRequest

Used to send the XMLHttpRequest header

Response

Returns the bank_transaction object

idstring

The bank integration hashed id

user_idstring

The user hashed id

transaction_idinteger

The id of the transaction rule

amountnumber

The transaction amount

currency_idstring

The currency ID of the currency

account_typestring

The account type

descriptionstring

The description of the transaction

category_idinteger

The category id

category_typestring

The category description

base_typestring

Either CREDIT or DEBIT

datestring

The date of the transaction

bank_account_idinteger

The ID number of the bank account

Example response

{
  "id": "AS3df3A",
  "user_id": "AS3df3A",
  "transaction_id": 343434,
  "amount": 10,
  "currency_id": "1",
  "account_type": "creditCard",
  "description": "Potato purchases for kevin",
  "category_id": 1,
  "category_type": "Expenses",
  "base_type": "CREDIT",
  "date": "2022-09-01",
  "bank_account_id": 1
}

Changes

    • info

      the response optional property became read-only for the status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status