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.

Request Information

URI Parameters

Name	Description	Type	Additional information
agencyId	Get schedules for specific agency	integer	None.

Body Parameters

Collection of integer

Request Formats

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'IEnumerable`1'.

application/json, text/json

Sample:

[
  1,
  2
]

Response Information

Resource Description

RecurringInvoiceScheduleDataContract

Name	Type	Additional information
AgencyId	integer	None.
OriginalInvoiceId	integer	None.
Frequency	RecurrenceType	None.
Occurrences	integer	None.
Interval	integer	None.
DaysOfTheWeek	integer	None.
RecurringStartDate	date	None.
RecurringEndDate	date	None.
NextRunDate	date	None.
MetaData	string	None.
IsActive	boolean	None.
CreatedDate	date	None.
LastUpdated	date	None.
Id	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "AgencyId": 1,
  "OriginalInvoiceId": 2,
  "Frequency": 0,
  "Occurrences": 3,
  "Interval": 4,
  "DaysOfTheWeek": 5,
  "RecurringStartDate": "2025-12-09T19:42:33.5589252Z",
  "RecurringEndDate": "2025-12-09T19:42:33.5589252Z",
  "NextRunDate": "2025-12-09T19:42:33.5589252Z",
  "MetaData": "sample string 8",
  "IsActive": true,
  "CreatedDate": "2025-12-09T19:42:33.5589252Z",
  "LastUpdated": "2025-12-09T19:42:33.5589252Z",
  "Id": 9
}