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": 2 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": 19 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": 2 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": 11 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": 6 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": 8 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": 14 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": 25 Type: Number The ID of the schedule executed. |
billRunSettings | "billRunSettings": "Hello World" Type: String The listing of the bill run steps executed. |
GET | BillRun/Schedule/ |
Retrieve all of the BillRunSchedule objects. NOTE: This end point is no longer supported in v4 of the API. | |
Retrieve all of the BillRunSchedule objects. GET 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": 15, "billRunName": "Sample Text Data", "billRunScheduleStatusTypeId": 0, "billRunScheduleStatusTypeName": "Sample Text Data", "accountId": 27, "accountName": "Sample Text Data", "periodStart": "2021-04-26T15:25:27.587Z", "periodEnd": "2021-04-26T15:25:27.587Z", "createdByUserId": 22, "createdByUserName": "Sample Text Data", "orderId": 5, "orderName": "Sample Text Data", "parentBillRunId": 1, "parentBillRunName": "Sample Text Data", "scheduleId": 14, "billRunSettings": "Sample Text Data" } ] } |
GET | 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 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": 22, "billRunName": "Sample Text Data", "billRunScheduleStatusTypeId": 19, "billRunScheduleStatusTypeName": "Sample Text Data", "accountId": 15, "accountName": "Sample Text Data", "periodStart": "2021-04-26T15:25:27.587Z", "periodEnd": "2021-04-26T15:25:27.587Z", "createdByUserId": 7, "createdByUserName": "Sample Text Data", "orderId": 3, "orderName": "Sample Text Data", "parentBillRunId": 21, "parentBillRunName": "Sample Text Data", "scheduleId": 13, "billRunSettings": "Sample Text Data" } ] } } |
GET | 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 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": 8, "billRunName": "Sample Text Data", "billRunScheduleStatusTypeId": 4, "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": 1, "createdByUserName": "Sample Text Data", "orderId": 5, "orderName": "Sample Text Data", "parentBillRunId": 22, "parentBillRunName": "Sample Text Data", "scheduleId": 9, "billRunSettings": "Sample Text Data" } } |
POST | BillRun/Schedule/OneTime |
Create a new One Time BillRunSchedule object. | |
Create a new One Time BillRunSchedule object. POST BillRun/Schedule/OneTime { "collectionTypeId": 2, "currencyExchangeId": null, "accountId": 153, "periodStart": "2022-06-01T00:00:00", "periodEnd": "2022-06-30T00:00:00", "postingDate": "2022-04-20T00:00:00", "runBilling": true, "runBillUsage": true, "runDelivery": false, "runContract": false, "runPayment": false, "runPaymentTerm": false, "runRenderInvoice": true, "runInvoicing": true } HTTP/1.1 200 OK { "trackingId": "1ea52c52-82f9-4566-82d2-20255bacaa9a", "type": "create", "results": { "totalCount": 1, "items": [ { "identity": 4, "action": "created", "dtoTypeKey": "billRunSchedule", "instance": { "identity": 4, "created": "2022-04-20T13:45:47.423Z", "billRunScheduleStatusTypeId": 1, "billRunScheduleStatusTypeName": "Scheduled", "accountId": 153, "accountName": "admin", "periodStart": "2022-06-01T00:00:00Z", "periodEnd": "2022-06-30T00:00:00Z", "createdByUserId": 153, "createdByUserName": "admin", "billRunSettings": "{\r\n \"runBillUsage\": true,\r\n \"runBilling\": true,\r\n \"runInvoicing\": true,\r\n \"runContract\": false,\r\n \"runPayment\": false,\r\n \"runRenderInvoice\": true,\r\n \"runDelivery\": false,\r\n \"runPaymentTerm\": false,\r\n \"collectionTypeId\": 2,\r\n \"currencyExchangeId\": 4,\r\n \"postingDate\": \"2022-04-20T00:00:00Z\",\r\n \"ownerId\": 1\r\n}" } } ] } } |
POST | BillRun/Schedule/{id}/Cancel |
Cancel an existing BillRunSchedule based on the {id} provided. | |
{id} | Unique identifier for the BillRunSchedule object. |