Skip to content

Transactions Object

Relationships

Schema relationships 
graph LR
    Transactions -->|"account"| Accounts
    Transactions -->|"account_from"| Accounts
    Transactions -->|"contact"| Contacts
    Transactions -->|"company"| CompanyInfo
    Transactions -->|"tracking_categories"| TrackingCategories

Properties

idstring
required·

The unique identifier for transactions

accountstring

The account which receives the transaction

References: Accounts → id
account_fromstring

The account which initiates the transaction

References: Accounts → id
companystring

The company the transaction belongs to

References: CompanyInfo → id
contactstring

The contact to whom the transaction relates to

References: Contacts → id
created_atstring · date-time

This represents the date when the transaction was created

currencystring

The currency of the transaction

exchange_ratestring

The exchange rate of the transaction

line_itemsobject[]
accountstring

The ID of the account

currencystring

The currency of the line item

descriptionstring

The description of the line item

exchange_ratenumber

The exchange rate of the currency for the line item

idstring

The unique identifier for line item

itemstring

The ID of the item

namestring

The name of the line item

quantitynumber

The quantity of the line item

tax_ratestring

The ID of the tax rate

total_line_amountnumber

The total line amount of the line item.

tracking_categoriesobject[]

Tracking categories of the line item

3 properties
idstring

The ID of the tracking category

namestring

The name of the tracking category

optionstring

The option of the tracking category

typestring

The type of the line item

unit_pricenumber

The unit price of the line item

numberstring

The number of the transaction

remote_dataRecord<string, any>

Raw data returned from the remote API call.

total_amountstring

The total amount of the transaction

tracking_categoriesobject[]

Tracking categories of the transaction

References: TrackingCategories → id
idstring
required·

The unique identifier for tracking categories

namestring

The name of the tracking category

transaction_datestring · date-time

The date upon which the transaction occurred

transaction_typestring

The type of the transaction

Possible values:
refunddepositestimatetransfercredit_cardspendreceivereceive_overpaymentreceive_prepaymentspend_overpaymentspend_prepayment
updated_atstring · date-time

This represents the date when the transaction was updated