accounting
transaction

List all transactions

Changed on

Returns a list of AccountingTransactions. Narrow the results with the query parameters before paging, then page through them with limit and offset (the default and maximum page size depend on the integration). Use fields to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the X-Total-Count response header. Use each item's id to retrieve, update, or delete it where those operations are supported.

get/accounting/{connection_id}/transaction

Request

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

contact_idstring

The contact ID to filter by (reference to AccountingContact)

start_gtestring

The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_ltstring

The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

org_idstring

The org ID to filter by (reference to AccountingOrganization)

account_idstring

The account ID to filter by (reference to AccountingAccount)

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

memostring
total_amountnumber

negative for CREDIT, positive for DEBIT

tax_amountnumber

negative for CREDIT, positive for DEBIT

account_idstring

(reference to AccountingAccount)

referencestring
sub_total_amountnumber
split_account_idstring
payment_methodstring
payment_termsstring
customer_messagestring
typestring

eg. CreditCardCharge, Check, Invoice, ReceivePayment, JournalEntry, Bill, CreditCardCredit, VendorCredit, Credit, BillPaymentCheck, BillPaymentCreditCard, Charge, Transfer, Deposit, BANK_DEPOSIT, BANK_TRANSFER, Statement, BillableCharge, TimeActivity, CashPurchase, SalesReceipt, CreditMemo, CreditRefund, Estimate, InventoryQuantityAdjustment, PurchaseOrder, GlobalTaxPayment, GlobalTaxAdjustment, Service Tax Refund, Service Tax Gross Adjustment, Service Tax Reversal, Service Tax Defer, Service Tax Partial Utilisation

currencystring
organization_idstring
category_idsstring[]
project_idstring

(reference to TaskProject)

transaction_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

exchange_ratenumber

Exchange rate to the base/home currency at the transaction date

status'PENDING' | 'POSTED' | 'VOID' | 'OTHER'

Posting state of the transaction

rawobject

Changes

    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property / to the response with the status

    • breaking

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