Skip to content

RepeatingTransactions Object



id
string
REQUIRED · 

The unique identifier for repeating transaction

name
string

The name of the repeating transaction

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.

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
recurring_type
string

The recurring type of the repeating transaction

All possible enum values:
  • unscheduled
  • automated
  • reminded
interval_type
string

The interval type of the repeating transaction

All possible enum values:
  • daily
  • weekly
  • monthly
  • yearly
interval_num
number

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

day_of_month
number

The day of the month of the repeating transaction

month_of_year
number

The month of the year of the repeating transaction

day_of_week
number

The day of the week of the repeating transaction

week_of_month
number

The week of the month of the repeating transaction

days_before
number

The days before of the repeating transaction

start_date
string · date-time

The start date for the repeating transaction

end_date
string · date-time

The end date for the repeating transaction

max_occurrences
number

The maximum number of occurrences for the repeating transaction

next_date
string · date-time

The next date of the repeating transaction

prev_date
string · date-time

The previous date of the repeating transaction

created_at
string · date-time

Rhe date when the repeating transaction was created

updated_at
string · date-time

The date when the repeating transaction was updated

remote_data
object

Raw data returned from the remote API call.