TAG LINE
TAG LINE
SMALL TITLE
A list of previously run, or currently running, Bill Run details.
identity READ-ONLY | "identity": 1 Type: Number This is the unique numeric identifier for the BillRunHistory |
ownerId READ-ONLY | "ownerId": 23 Type: Number Unique identifier for the associated Owner object. |
ownerName READ-ONLY | "ownerName": "Sample Name" Type: String The name of the object associated with the ownerId property. |
billRunId | "billRunId": 27 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. |
name | "name": "Hello World" Type: String The name of the bill run executed. |
complete READ-ONLY | "complete": true Type: Boolean Whether or not this Bill Run has completed. |
billRunScheduleId | "billRunScheduleId": 3 Type: Number Unique identifier for the associated BillRunSchedule object. |
billRunScheduleName | "billRunScheduleName": "Sample Name" Type: String The name of the object associated with the billRunScheduleId property. |
currencyExchangeId | "currencyExchangeId": 4 Type: Number Unique identifier for the associated CurrencyExchange object. |
currencyExchangeName | "currencyExchangeName": "Sample Name" Type: String The name of the object associated with the currencyExchangeId property. |
parentBillRunHistoryId | "parentBillRunHistoryId": 23 Type: Number Unique identifier for the associated BillRunHistory object. |
parentBillRunHistoryName | "parentBillRunHistoryName": "Sample Name" Type: String The name of the object associated with the parentBillRunHistoryId property. |
| GET | BillRun/History/ |
| Retrieve all of the BillRunHistory objects. | |
Retrieve all of the BillRunHistory objects. GET BillRun/History/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 15,
"ownerName": "Sample Text Data",
"billRunId": 6,
"billRunName": "Sample Text Data",
"name": "Sample Text Data",
"complete": true,
"billRunScheduleId": 11,
"billRunScheduleName": "Sample Text Data",
"currencyExchangeId": 7,
"currencyExchangeName": "Sample Text Data",
"parentBillRunHistoryId": 26,
"parentBillRunHistoryName": "Sample Text Data"
}
]
} | |
| GET | BillRun/History/Paged |
| Retrieve all of the BillRunHistory objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints. | |
Retrieve all of the BillRunHistory objects in a paged fashion. GET BillRun/History/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,
"ownerId": 1,
"ownerName": "Sample Text Data",
"billRunId": 8,
"billRunName": "Sample Text Data",
"name": "Sample Text Data",
"complete": true,
"billRunScheduleId": 9,
"billRunScheduleName": "Sample Text Data",
"currencyExchangeId": 25,
"currencyExchangeName": "Sample Text Data",
"parentBillRunHistoryId": 19,
"parentBillRunHistoryName": "Sample Text Data"
}
]
}
} | |
| GET | BillRun/History/{id} |
| Retrieve an instance of the BillRunHistory object by its ID. | |
| {id} | Unique identifier for the BillRunHistory object. |
Retrieve an instance of the BillRunHistory object by its ID. GET BillRun/History/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 13,
"ownerName": "Sample Text Data",
"billRunId": 23,
"billRunName": "Sample Text Data",
"name": "Sample Text Data",
"complete": true,
"billRunScheduleId": 27,
"billRunScheduleName": "Sample Text Data",
"currencyExchangeId": 22,
"currencyExchangeName": "Sample Text Data",
"parentBillRunHistoryId": 17,
"parentBillRunHistoryName": "Sample Text Data"
}
} | |
| GET | BillRun/History/{id}/Detail |
| Retrieve deep detail of the BillRunHistory object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the BillRunHistory object. |
Retrieve deep detail of the BillRunHistory object by its ID. GET BillRun/History/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 13,
"ownerName": "Sample Text Data",
"billRunId": 17,
"billRunName": "Sample Text Data",
"name": "Sample Text Data",
"complete": true,
"billRunScheduleId": 5,
"billRunScheduleName": "Sample Text Data",
"currencyExchangeId": 14,
"currencyExchangeName": "Sample Text Data",
"parentBillRunHistoryId": 21,
"parentBillRunHistoryName": "Sample Text Data",
"details": {
"billRunHistorySteps": [
{
"identity": 6,
"billRunHistoryId": 34,
"billRunHistoryName": "Sample Text Data",
"billRunStepTypeId": 9,
"billRunStepTypeName": "Sample Text Data",
"retry": true,
"start": "2021-04-26T15:25:27.587Z",
"end": "2021-04-26T15:25:27.587Z",
"total": 27,
"queued": 41,
"processed": 55,
"errorCount": 47,
"updated": "2021-04-26T15:25:27.587Z",
"accountsTotal": 12,
"accountsQueued": 91,
"accountsProcessed": 66,
"details": {
"billRunHistoryErrors": [
{
"identity": 56,
"billRunHistoryStepId": 9,
"accountPackageName": "Sample Text Data",
"accountServiceName": "Sample Text Data",
"accountId": 55,
"accountName": "Sample Text Data",
"billingErrorTypeId": 24,
"billingErrorTypeName": "Sample Text Data",
"errorMessage": "Sample Text Data"
}
]
}
}
],
"billRunSchedule": {
"identity": 60,
"created": "2021-04-26T15:25:27.587Z",
"start": "2021-04-26T15:25:27.587Z",
"complete": "2021-04-26T15:25:27.587Z",
"billRunId": 44,
"billRunName": "Sample Text Data",
"billRunScheduleStatusTypeId": 44,
"billRunScheduleStatusTypeName": "Sample Text Data",
"accountId": 42,
"accountName": "Sample Text Data",
"periodStart": "2021-04-26T15:25:27.587Z",
"periodEnd": "2021-04-26T15:25:27.587Z",
"createdByUserId": 89,
"createdByUserName": "Sample Text Data",
"orderId": 38,
"parentBillRunId": 54,
"parentBillRunName": "Sample Text Data",
"scheduleId": 83,
"scheduleName": "Sample Text Data",
"billRunSettings": "Sample Text Data"
}
}
}
} | |
| POST | BillRun/History/{id}/Recovery |
| Create a new instance of a Recovery object that belongs to the BillRunHistory. | |
| {id} | Unique identifier for the BillRunHistory object. |
Create a new instance of a Recovery object that belongs to the BillRunHistory. POST BillRun/History/{id}/Recovery
{
"billRunId": 6,
"name": "Sample Text Data",
"billRunScheduleId": 14,
"currencyExchangeId": 14,
"parentBillRunHistoryId": 8
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 25,
"ownerName": "Sample Text Data",
"billRunId": 2,
"billRunName": "Sample Text Data",
"name": "Sample Text Data",
"complete": true,
"billRunScheduleId": 15,
"billRunScheduleName": "Sample Text Data",
"currencyExchangeId": 12,
"currencyExchangeName": "Sample Text Data",
"parentBillRunHistoryId": 26,
"parentBillRunHistoryName": "Sample Text Data"
}
]
}
} | |