Skip to content

List Repeating transactions

Endpoint

http
GET /unified/accounting/repeating_transactions
Integrations supported
  • QuickBooks
  • Xero

Query parameters

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string
The format of the response. Defaults to `unified`. `unified` will return the response with unified mappings applied. `raw` will return the raw response from the remote API. `normalized` will apply the unified mappings and return the data in a normalized format.
All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string
By default the `result` attribute is an array of objects. This parameter allows you to specify a field in each `result` objects to use as key, which transforms the `result` array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.
Example: id
truto_ignore_limit
boolean
Ignores the `limit` query parameter.
truto_ignore_remote_data
boolean
Excludes the `remote_data` attribute from the response.
truto_exclude_fields
array
Array of fields to exclude from the response.
Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object
Query parameters to pass to the underlying API without any transformations.
Example: remote_query[foo]=bar
created_at
string · date-time
Rhe date when the repeating transaction was created
Supported in
  • QuickBooks
updated_at
string · date-time
The date when the repeating transaction was updated
Supported in
  • QuickBooks
status
boolean
The status of the repeating transaction
All possible enum values:
  • active
  • archived
Supported in
  • QuickBooks
  • Xero
type
All possible enum values:
  • bill
  • invoice
Supported in
  • Xero

Response Body

result
object[]
List of Repeating transactions
id
string
REQUIRED · The unique identifier for repeating transaction
Supported in
  • QuickBooks
  • Xero
name
string
The name of the repeating transaction
Supported in
  • QuickBooks
entity
object
The entity of the repeating transaction. The schema will be based on the type of entity, but `id` and `type` will always be present.
Supported in
  • QuickBooks
  • Xero
id
string
REQUIRED · The unique identifier for the entity
type
string
REQUIRED · The type of the entity
All possible enum values:
  • invoice
  • purchase_order
  • vendor_credit
  • credit_note
  • journal_entry
status
boolean
The status of the repeating transaction
All possible enum values:
  • active
  • archived
Supported in
  • QuickBooks
  • Xero
recurring_type
string
The recurring type of the repeating transaction
All possible enum values:
  • unscheduled
  • automated
  • reminded
Supported in
  • QuickBooks
interval_type
string
The interval type of the repeating transaction
All possible enum values:
  • daily
  • weekly
  • monthly
  • yearly
Supported in
  • QuickBooks
  • Xero
interval_num
number
The interval number of the repeating transaction. E.g., 1 (every 1 week), 2 (every 2 months), etc.
Supported in
  • QuickBooks
  • Xero
day_of_month
number
The day of the month of the repeating transaction
Supported in
  • QuickBooks
  • Xero
month_of_year
number
The month of the year of the repeating transaction
Supported in
  • QuickBooks
day_of_week
number
The day of the week of the repeating transaction
Supported in
  • QuickBooks
week_of_month
number
The week of the month of the repeating transaction
Supported in
  • QuickBooks
days_before
number
The days before of the repeating transaction
Supported in
  • QuickBooks
start_date
string · date-time
The start date for the repeating transaction
Supported in
  • QuickBooks
  • Xero
end_date
string · date-time
The end date for the repeating transaction
Supported in
  • QuickBooks
  • Xero
max_occurrences
number
The maximum number of occurrences for the repeating transaction
Supported in
  • QuickBooks
next_date
string · date-time
The next date of the repeating transaction
Supported in
  • QuickBooks
  • Xero
prev_date
string · date-time
The previous date of the repeating transaction
Supported in
  • QuickBooks
created_at
string · date-time
Rhe date when the repeating transaction was created
Supported in
  • QuickBooks
updated_at
string · date-time
The date when the repeating transaction was updated
Supported in
  • QuickBooks
remote_data
object
Raw data returned from the remote API call.
next_cursor
string
The cursor to use for the next page of results. Pass this value as `next_cursor` in the query parameter in the next request to get the next page of results.