TAG LINE
TAG LINE
SMALL TITLE
The Bill Run Schedule holds information for any one-off or recurring scheduled Bill Runs.
identity READ-ONLY | "identity": 8 Type: Number This is the unique numeric identifier for the BillRunSchedule |
created READ-ONLY | "created": "2021-04-26T15:25:27.587Z" Type: Date This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format. |
start READ-ONLY | "start": "2021-04-26T15:25:27.587Z" Type: Date The time stamp when this Bill Run Schedule started. Date and time values are specified in the ISO 8601 format. |
complete READ-ONLY | "complete": "2021-04-26T15:25:27.587Z" Type: Date The time stamp when this Bill Run Schedule completed. Date and time values are specified in the ISO 8601 format. |
billRunId | "billRunId": 0 Type: Number Unique identifier for the associated BillRun object. |
billRunName | "billRunName": "Sample Name" Type: String The name of the object associated with the billRunId property. |
billRunScheduleStatusTypeId | "billRunScheduleStatusTypeId": 7 Type: Number Unique identifier for the associated BillRunScheduleStatusType object. |
billRunScheduleStatusTypeName | "billRunScheduleStatusTypeName": "Sample Name" Type: String The name of the object associated with the billRunScheduleStatusTypeId property. |
accountId | "accountId": 3 Type: Number This property would be used in a one-off Bill Run for a specific Account. Unique identifier for the associated Account object. |
accountName | "accountName": "Sample Name" Type: String The name of the object associated with the accountId property. |
periodStart | "periodStart": "2021-04-26T15:25:27.587Z" Type: Date |
periodEnd | "periodEnd": "2021-04-26T15:25:27.587Z" Type: Date |
createdByUserId | "createdByUserId": 16 Type: Number Unique identifier for the associated User object. |
createdByUserName | "createdByUserName": "Sample Name" Type: String The name of the object associated with the createdByUserId property. |
orderId | "orderId": 10 Type: Number This property would be used in a one-off Bill Run for a specific Order. Unique identifier for the associated Order object. |
orderName | "orderName": "Sample Name" Type: String The name of the object associated with the orderId property. |
parentBillRunId | "parentBillRunId": 27 Type: Number Unique identifier for the associated BillRun object. |
parentBillRunName | "parentBillRunName": "Sample Name" Type: String The name of the object associated with the parentBillRunId property. |
scheduleId | "scheduleId": 11 Type: Number Unique identifier for the associated Schedule object. |
scheduleName | "scheduleName": "Sample Name" Type: String The name of the object associated with the scheduleId property. |
billRunSettings | "billRunSettings": "Hello World" Type: String |
| GET | api/v5/BillRun/Schedule/ |
| Retrieve all of the BillRunSchedule objects. | |
Retrieve all of the BillRunSchedule objects. GET api/v5/BillRun/Schedule/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"created": "2021-04-26T15:25:27.587Z",
"start": "2021-04-26T15:25:27.587Z",
"complete": "2021-04-26T15:25:27.587Z",
"billRunId": 25,
"billRunName": "Sample Text Data",
"billRunScheduleStatusTypeId": 12,
"billRunScheduleStatusTypeName": "Sample Text Data",
"accountId": 20,
"accountName": "Sample Text Data",
"periodStart": "2021-04-26T15:25:27.587Z",
"periodEnd": "2021-04-26T15:25:27.587Z",
"createdByUserId": 6,
"createdByUserName": "Sample Text Data",
"orderId": 10,
"orderName": "Sample Text Data",
"parentBillRunId": 9,
"parentBillRunName": "Sample Text Data",
"scheduleId": 15,
"scheduleName": "Sample Text Data",
"billRunSettings": "Sample Text Data"
}
]
} | |
| GET | api/v5/BillRun/Schedule/Paged |
| Retrieve all of the BillRunSchedule objects in a paged fashion. NOTE: This end point is no longer supported in v4 of the API. | |
Retrieve all of the BillRunSchedule objects in a paged fashion. GET api/v5/BillRun/Schedule/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"created": "2021-04-26T15:25:27.587Z",
"start": "2021-04-26T15:25:27.587Z",
"complete": "2021-04-26T15:25:27.587Z",
"billRunId": 9,
"billRunName": "Sample Text Data",
"billRunScheduleStatusTypeId": 25,
"billRunScheduleStatusTypeName": "Sample Text Data",
"accountId": 0,
"accountName": "Sample Text Data",
"periodStart": "2021-04-26T15:25:27.587Z",
"periodEnd": "2021-04-26T15:25:27.587Z",
"createdByUserId": 6,
"createdByUserName": "Sample Text Data",
"orderId": 3,
"orderName": "Sample Text Data",
"parentBillRunId": 20,
"parentBillRunName": "Sample Text Data",
"scheduleId": 3,
"scheduleName": "Sample Text Data",
"billRunSettings": "Sample Text Data"
}
]
}
} | |
| GET | api/v5/BillRun/Schedule/{id} |
| Retrieve an instance of the BillRunSchedule object by its ID. NOTE: This end point is no longer supported in v4 of the API. | |
| {id} | Unique identifier for the BillRunSchedule object. |
Retrieve an instance of the BillRunSchedule object by its ID. GET api/v5/BillRun/Schedule/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"created": "2021-04-26T15:25:27.587Z",
"start": "2021-04-26T15:25:27.587Z",
"complete": "2021-04-26T15:25:27.587Z",
"billRunId": 6,
"billRunName": "Sample Text Data",
"billRunScheduleStatusTypeId": 1,
"billRunScheduleStatusTypeName": "Sample Text Data",
"accountId": 19,
"accountName": "Sample Text Data",
"periodStart": "2021-04-26T15:25:27.587Z",
"periodEnd": "2021-04-26T15:25:27.587Z",
"createdByUserId": 19,
"createdByUserName": "Sample Text Data",
"orderId": 21,
"orderName": "Sample Text Data",
"parentBillRunId": 21,
"parentBillRunName": "Sample Text Data",
"scheduleId": 17,
"scheduleName": "Sample Text Data",
"billRunSettings": "Sample Text Data"
}
} | |
| POST | api/v5/BillRun/Schedule/OneTime |
| Create a new One Time BillRunSchedule object. | |
Create a new One Time BillRunSchedule object. POST api/v5/BillRun/Schedule/OneTime
{
"billRunId": 26,
"billRunScheduleStatusTypeId": 13,
"accountId": 17,
"periodStart": "2021-04-26T15:25:27.587Z",
"periodEnd": "2021-04-26T15:25:27.587Z",
"createdByUserId": 23,
"orderId": 10,
"parentBillRunId": 20,
"scheduleId": 18,
"billRunSettings": "Sample Text Data"
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"created": "2021-04-26T15:25:27.587Z",
"start": "2021-04-26T15:25:27.587Z",
"complete": "2021-04-26T15:25:27.587Z",
"billRunId": 22,
"billRunName": "Sample Text Data",
"billRunScheduleStatusTypeId": 6,
"billRunScheduleStatusTypeName": "Sample Text Data",
"accountId": 18,
"accountName": "Sample Text Data",
"periodStart": "2021-04-26T15:25:27.587Z",
"periodEnd": "2021-04-26T15:25:27.587Z",
"createdByUserId": 10,
"createdByUserName": "Sample Text Data",
"orderId": 3,
"orderName": "Sample Text Data",
"parentBillRunId": 5,
"parentBillRunName": "Sample Text Data",
"scheduleId": 2,
"scheduleName": "Sample Text Data",
"billRunSettings": "Sample Text Data"
}
]
}
} | |
| POST | api/v5/BillRun/Schedule/Recurring |
| Create a new Recurring BillRunSchedule object. | |
Create a new Recurring BillRunSchedule object. POST api/v5/BillRun/Schedule/Recurring
{
"billRunId": 19,
"billRunScheduleStatusTypeId": 11,
"accountId": 6,
"periodStart": "2021-04-26T15:25:27.587Z",
"periodEnd": "2021-04-26T15:25:27.587Z",
"createdByUserId": 9,
"orderId": 4,
"parentBillRunId": 26,
"scheduleId": 14,
"billRunSettings": "Sample Text Data"
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"created": "2021-04-26T15:25:27.587Z",
"start": "2021-04-26T15:25:27.587Z",
"complete": "2021-04-26T15:25:27.587Z",
"billRunId": 22,
"billRunName": "Sample Text Data",
"billRunScheduleStatusTypeId": 25,
"billRunScheduleStatusTypeName": "Sample Text Data",
"accountId": 26,
"accountName": "Sample Text Data",
"periodStart": "2021-04-26T15:25:27.587Z",
"periodEnd": "2021-04-26T15:25:27.587Z",
"createdByUserId": 24,
"createdByUserName": "Sample Text Data",
"orderId": 11,
"orderName": "Sample Text Data",
"parentBillRunId": 13,
"parentBillRunName": "Sample Text Data",
"scheduleId": 16,
"scheduleName": "Sample Text Data",
"billRunSettings": "Sample Text Data"
}
]
}
} | |
| POST | api/v5/BillRun/Schedule/{id}/Cancel |
| Cancel an existing BillRunSchedule based on the {id} provided. | |
| {id} | Unique identifier for the BillRunSchedule object. |