POST api/invoice/invoiceschedules?agencyId={agencyId}
Get recurring invoice schedules. If invoiceId is provided, returns only schedules for that invoice. If agencyId is provided, returns only schedules for that agency. Otherwise, returns all schedules. Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| agencyId |
Get schedules for specific agency |
integer |
None. |
Body Parameters
The invoice ids value supplied with the request.
Collection of integerRequest Formats
application/x-www-form-urlencoded
Sample not available.
application/json, text/json
[ 1, 2 ]
Response Information
Resource Description
The response returned after the operation completes.
RecurringInvoiceScheduleDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| AgencyId |
The unique identifier of the related agency resource. |
integer |
None. |
| OriginalInvoiceId |
The unique identifier of the related original invoice resource. |
integer |
None. |
| Frequency |
The frequency classification. |
RecurrenceType |
None. |
| Occurrences |
The occurrences value. |
integer |
None. |
| Interval |
The interval value. |
integer |
None. |
| DaysOfTheWeek |
The days of the week value. |
integer |
None. |
| RecurringStartDate |
The recurring start date, expressed as a date and time. |
date |
None. |
| RecurringEndDate |
The recurring end date, expressed as a date and time. |
date |
None. |
| NextRunDate |
The next run date, expressed as a date and time. |
date |
None. |
| MetaData |
The meta data value. |
string |
None. |
| IsActive |
Indicates whether this item is active. |
boolean |
None. |
| CreatedDate |
The created date, expressed as a date and time. |
date |
None. |
| LastUpdated |
The last updated, expressed as a date and time. |
date |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Response Formats
application/json, text/json
{
"AgencyId": 1,
"OriginalInvoiceId": 2,
"Frequency": 0,
"Occurrences": 3,
"Interval": 4,
"DaysOfTheWeek": 5,
"RecurringStartDate": "2026-07-23T08:25:57.7630296Z",
"RecurringEndDate": "2026-07-23T08:25:57.7630296Z",
"NextRunDate": "2026-07-23T08:25:57.7630296Z",
"MetaData": "sample string 8",
"IsActive": true,
"CreatedDate": "2026-07-23T08:25:57.7630296Z",
"LastUpdated": "2026-07-23T08:25:57.7630296Z",
"Id": 9
}