Skip to main content
GET
Get RecurringBill record

Authorizations

X-API-KEY
string
header
required

Path Parameters

record_number
integer
required

The number attribute of the record.

Query Parameters

search
string | null
company_id
integer[] | null
number
integer[] | null
recurring_type
enum<string>[] | null
Available options:
automatic,
reminder
record_status
enum<string>[] | null
Available options:
draft,
posted,
archived
updated_after
string<date-time> | null
updated_before
string<date-time> | null

Response

OK

internal_id
integer
required
number
integer
required
name
string
required
memo
string
required
date
string<date>
required
company_id
integer
required
company_name
string
required
company_currency
string
required
status
enum<string>
required
Available options:
active,
inactive
record_payload
any
required
rrule
string
required
next_occurrence
string<date-time> | null
required
last_generated
string<date-time> | null
required
errors
Errors · object
required

Lists failures that stop this template from creating records. The key is the date in next_occurrence (YYYY-MM-DD) and the value is the error message.

recurring_type
enum<string>
required
Available options:
automatic,
reminder
records
PublicRecurringRecordSchemaOut · object[]
required
created_at
string<date-time>
required

Date and time the record was created

updated_at
string<date-time>
required

Date and time the record was last updated

created_by
AuditActorSchemaOut · object | null

Schema for audit actor information.

updated_by
AuditActorSchemaOut · object | null

Schema for audit actor information.

code
string | null