Skip to content

RepeatingTransactions Object

Properties

idstring
required·

The unique identifier for repeating transaction

created_atstring · date-time

Rhe date when the repeating transaction was created

day_of_monthnumber

The day of the month of the repeating transaction

day_of_weeknumber

The day of the week of the repeating transaction

days_beforenumber

The days before of the repeating transaction

end_datestring · date-time

The end date for the repeating transaction

entityobject

The entity of the repeating transaction. The schema will be based on the type of entity, but id and type will always be present.

idstring
required·

The unique identifier for the entity

typestring
required·

The type of the entity

Possible values:
invoicepurchase_ordervendor_creditcredit_notejournal_entry
interval_numnumber

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

interval_typestring

The interval type of the repeating transaction

Possible values:
dailyweeklymonthlyyearly
max_occurrencesnumber

The maximum number of occurrences for the repeating transaction

month_of_yearnumber

The month of the year of the repeating transaction

namestring

The name of the repeating transaction

next_datestring · date-time

The next date of the repeating transaction

prev_datestring · date-time

The previous date of the repeating transaction

recurring_typestring

The recurring type of the repeating transaction

Possible values:
unscheduledautomatedreminded
remote_dataRecord<string, any>

Raw data returned from the remote API call.

start_datestring · date-time

The start date for the repeating transaction

statusboolean

The status of the repeating transaction

Possible values:
activearchived
updated_atstring · date-time

The date when the repeating transaction was updated

week_of_monthnumber

The week of the month of the repeating transaction