Appearance

Create Repeating transactions ​

Endpoint ​

http
POST /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.

  • 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.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
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. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Request Body ​

Refer Writing data using Unified APIs

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
Required in
  • Xero
Supported in
  • QuickBooks
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
Enum support by integration
  • Xero
    • monthly
    • weekly
Required in
  • Xero
Supported in
  • QuickBooks
interval_num
number

The interval number of the repeating transaction. E.g., 1 (every 1 week), 2 (every 2 months), etc.

Required in
  • Xero
Supported in
  • QuickBooks
start_date
string · date-time

The start date for the repeating transaction

Required in
  • Xero
Supported in
  • QuickBooks
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
days_before
number

The days before of the repeating transaction

Supported in
  • QuickBooks
day_of_month
number

The day of the month of the repeating transaction

Required in
  • Xero
due_date_type
string

Type of due date for repeating transactions

All possible enum values:
  • days_after_bill_date
  • days_after_bill_month
  • of_current_month
  • of_following_month
Enum support by integration
  • Xero
    • days_after_bill_date
    • days_after_bill_month
    • of_current_month
    • of_following_month
Required in
  • Xero
contact
Required in
  • Xero
line_items
object[]

The line items of the repeating transaction

Required in
  • Xero
note
string

The note of the line item

id
string

The unique identifier for the line item

quantity
number

The quantity for the line item

account
string

The ID of the account

line_amount_type
string

The type of line amount for repeating transaction

All possible enum values:
  • exclusive
  • inclusive
  • no_tax
Enum support by integration
  • Xero
    • exclusive
    • inclusive
    • no_tax
Required in
  • Xero
currency
string

The currency of the repeating transaction

Required in
  • Xero
remote_data
object

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body ​

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.