TAG LINE
TAG LINE
SMALL TITLE

Bill Run / Schedule

(API Version v7)


The Bill Run Schedule holds information for any one-off or recurring scheduled Bill Runs.


What can you do with BillRunSchedule?


Properties

Property Details
identity
READ-ONLY
"identity": 21
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": 21
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": 4
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": 23
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
Start date for the billing period.

Date and time values are specified in the ISO 8601 format.
periodEnd
"periodEnd": "2021-04-26T15:25:27.587Z"
Type: Date
End date for the billing period.

Date and time values are specified in the ISO 8601 format.
createdByUserId
"createdByUserId": 5
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": 27
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": 0
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": 17
Type: Number
billRunSettings
"billRunSettings": "Hello World"
Type: String


End Points

DELETEBillRun/Schedule/{id}
Delete an instance of the BillRunSchedule object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system.
{id}Unique identifier for the BillRunSchedule object.
Delete an instance of the BillRunSchedule object.
DELETE BillRun/Schedule/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "delete",
    "results": {
        "totalCount": 4,
        "items": [
            {
                "identity": 1,
                "action": "deleted",
                "dtoTypeKey": "billRunSchedule"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETBillRun/Schedule/
Retrieve all of the BillRunSchedule objects.
Retrieve all of the BillRunSchedule objects.
GET BillRun/Schedule/
View Sample Response
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": 9,
            "billRunName": "Sample Text Data",
            "billRunScheduleStatusTypeId": 1,
            "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": 20,
            "createdByUserName": "Sample Text Data",
            "orderId": 5,
            "orderName": "Sample Text Data",
            "parentBillRunId": 15,
            "parentBillRunName": "Sample Text Data",
            "scheduleId": 26,
            "billRunSettings": "Sample Text Data"
        }
    ]
}
GETBillRun/Schedule/
Retrieve all of the BillRunSchedule objects.
Retrieve all of the BillRunSchedule objects.
GET BillRun/Schedule/
View Sample Response
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": 26,
            "billRunName": "Sample Text Data",
            "billRunScheduleStatusTypeId": 17,
            "billRunScheduleStatusTypeName": "Sample Text Data",
            "accountId": 25,
            "accountName": "Sample Text Data",
            "periodStart": "2021-04-26T15:25:27.587Z",
            "periodEnd": "2021-04-26T15:25:27.587Z",
            "createdByUserId": 20,
            "createdByUserName": "Sample Text Data",
            "orderId": 25,
            "orderName": "Sample Text Data",
            "parentBillRunId": 18,
            "parentBillRunName": "Sample Text Data",
            "scheduleId": 10,
            "billRunSettings": "Sample Text Data"
        }
    ]
}
GETBillRun/Schedule/
Retrieve all of the BillRunSchedule objects.
Retrieve all of the BillRunSchedule objects.
GET BillRun/Schedule/
View Sample Response
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": 2,
            "billRunName": "Sample Text Data",
            "billRunScheduleStatusTypeId": 17,
            "billRunScheduleStatusTypeName": "Sample Text Data",
            "accountId": 23,
            "accountName": "Sample Text Data",
            "periodStart": "2021-04-26T15:25:27.587Z",
            "periodEnd": "2021-04-26T15:25:27.587Z",
            "createdByUserId": 23,
            "createdByUserName": "Sample Text Data",
            "orderId": 9,
            "orderName": "Sample Text Data",
            "parentBillRunId": 23,
            "parentBillRunName": "Sample Text Data",
            "scheduleId": 11,
            "billRunSettings": "Sample Text Data"
        }
    ]
}
GETBillRun/Schedule/
Retrieve all of the BillRunSchedule objects.
Retrieve all of the BillRunSchedule objects.
GET BillRun/Schedule/
View Sample Response
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": 0,
            "billRunName": "Sample Text Data",
            "billRunScheduleStatusTypeId": 13,
            "billRunScheduleStatusTypeName": "Sample Text Data",
            "accountId": 17,
            "accountName": "Sample Text Data",
            "periodStart": "2021-04-26T15:25:27.587Z",
            "periodEnd": "2021-04-26T15:25:27.587Z",
            "createdByUserId": 13,
            "createdByUserName": "Sample Text Data",
            "orderId": 17,
            "orderName": "Sample Text Data",
            "parentBillRunId": 3,
            "parentBillRunName": "Sample Text Data",
            "scheduleId": 8,
            "billRunSettings": "Sample Text Data"
        }
    ]
}
GETBillRun/Schedule/
Retrieve all of the BillRunSchedule objects.
Retrieve all of the BillRunSchedule objects.
GET BillRun/Schedule/
View Sample Response
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": 5,
            "billRunName": "Sample Text Data",
            "billRunScheduleStatusTypeId": 27,
            "billRunScheduleStatusTypeName": "Sample Text Data",
            "accountId": 9,
            "accountName": "Sample Text Data",
            "periodStart": "2021-04-26T15:25:27.587Z",
            "periodEnd": "2021-04-26T15:25:27.587Z",
            "createdByUserId": 12,
            "createdByUserName": "Sample Text Data",
            "orderId": 14,
            "orderName": "Sample Text Data",
            "parentBillRunId": 9,
            "parentBillRunName": "Sample Text Data",
            "scheduleId": 0,
            "billRunSettings": "Sample Text Data"
        }
    ]
}
GETBillRun/Schedule/Metadata
Retrieve all of the BillRunSchedule objects.
Retrieve all of the BillRunSchedule objects.
GET BillRun/Schedule/Metadata
View Sample Response
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": 24,
            "billRunName": "Sample Text Data",
            "billRunScheduleStatusTypeId": 3,
            "billRunScheduleStatusTypeName": "Sample Text Data",
            "accountId": 6,
            "accountName": "Sample Text Data",
            "periodStart": "2021-04-26T15:25:27.587Z",
            "periodEnd": "2021-04-26T15:25:27.587Z",
            "createdByUserId": 13,
            "createdByUserName": "Sample Text Data",
            "orderId": 17,
            "orderName": "Sample Text Data",
            "parentBillRunId": 24,
            "parentBillRunName": "Sample Text Data",
            "scheduleId": 21,
            "billRunSettings": "Sample Text Data"
        }
    ]
}
GETBillRun/Schedule/Metadata/sql
Retrieve all of the BillRunSchedule objects.
Retrieve all of the BillRunSchedule objects.
GET BillRun/Schedule/Metadata/sql
View Sample Response
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": 27,
            "billRunName": "Sample Text Data",
            "billRunScheduleStatusTypeId": 4,
            "billRunScheduleStatusTypeName": "Sample Text Data",
            "accountId": 21,
            "accountName": "Sample Text Data",
            "periodStart": "2021-04-26T15:25:27.587Z",
            "periodEnd": "2021-04-26T15:25:27.587Z",
            "createdByUserId": 8,
            "createdByUserName": "Sample Text Data",
            "orderId": 0,
            "orderName": "Sample Text Data",
            "parentBillRunId": 1,
            "parentBillRunName": "Sample Text Data",
            "scheduleId": 0,
            "billRunSettings": "Sample Text Data"
        }
    ]
}
GETBillRun/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
View Sample Response
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": 1,
                "billRunName": "Sample Text Data",
                "billRunScheduleStatusTypeId": 21,
                "billRunScheduleStatusTypeName": "Sample Text Data",
                "accountId": 4,
                "accountName": "Sample Text Data",
                "periodStart": "2021-04-26T15:25:27.587Z",
                "periodEnd": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 5,
                "createdByUserName": "Sample Text Data",
                "orderId": 5,
                "orderName": "Sample Text Data",
                "parentBillRunId": 17,
                "parentBillRunName": "Sample Text Data",
                "scheduleId": 14,
                "billRunSettings": "Sample Text Data"
            }
        ]
    }
}
GETBillRun/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
View Sample Response
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": 24,
                "billRunName": "Sample Text Data",
                "billRunScheduleStatusTypeId": 18,
                "billRunScheduleStatusTypeName": "Sample Text Data",
                "accountId": 1,
                "accountName": "Sample Text Data",
                "periodStart": "2021-04-26T15:25:27.587Z",
                "periodEnd": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 17,
                "createdByUserName": "Sample Text Data",
                "orderId": 20,
                "orderName": "Sample Text Data",
                "parentBillRunId": 22,
                "parentBillRunName": "Sample Text Data",
                "scheduleId": 10,
                "billRunSettings": "Sample Text Data"
            }
        ]
    }
}
GETBillRun/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
View Sample Response
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": 17,
                "billRunName": "Sample Text Data",
                "billRunScheduleStatusTypeId": 22,
                "billRunScheduleStatusTypeName": "Sample Text Data",
                "accountId": 1,
                "accountName": "Sample Text Data",
                "periodStart": "2021-04-26T15:25:27.587Z",
                "periodEnd": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 3,
                "createdByUserName": "Sample Text Data",
                "orderId": 23,
                "orderName": "Sample Text Data",
                "parentBillRunId": 9,
                "parentBillRunName": "Sample Text Data",
                "scheduleId": 9,
                "billRunSettings": "Sample Text Data"
            }
        ]
    }
}
GETBillRun/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
View Sample Response
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": 26,
                "billRunName": "Sample Text Data",
                "billRunScheduleStatusTypeId": 7,
                "billRunScheduleStatusTypeName": "Sample Text Data",
                "accountId": 10,
                "accountName": "Sample Text Data",
                "periodStart": "2021-04-26T15:25:27.587Z",
                "periodEnd": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 2,
                "createdByUserName": "Sample Text Data",
                "orderId": 6,
                "orderName": "Sample Text Data",
                "parentBillRunId": 27,
                "parentBillRunName": "Sample Text Data",
                "scheduleId": 4,
                "billRunSettings": "Sample Text Data"
            }
        ]
    }
}
GETBillRun/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
View Sample Response
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": 24,
                "billRunScheduleStatusTypeName": "Sample Text Data",
                "accountId": 13,
                "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": 15,
                "orderName": "Sample Text Data",
                "parentBillRunId": 6,
                "parentBillRunName": "Sample Text Data",
                "scheduleId": 27,
                "billRunSettings": "Sample Text Data"
            }
        ]
    }
}
GETBillRun/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}
View Sample Response
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": 7,
        "billRunName": "Sample Text Data",
        "billRunScheduleStatusTypeId": 10,
        "billRunScheduleStatusTypeName": "Sample Text Data",
        "accountId": 16,
        "accountName": "Sample Text Data",
        "periodStart": "2021-04-26T15:25:27.587Z",
        "periodEnd": "2021-04-26T15:25:27.587Z",
        "createdByUserId": 5,
        "createdByUserName": "Sample Text Data",
        "orderId": 21,
        "orderName": "Sample Text Data",
        "parentBillRunId": 1,
        "parentBillRunName": "Sample Text Data",
        "scheduleId": 2,
        "billRunSettings": "Sample Text Data"
    }
}
GETBillRun/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}
View Sample Response
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": 21,
        "billRunName": "Sample Text Data",
        "billRunScheduleStatusTypeId": 1,
        "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": 3,
        "createdByUserName": "Sample Text Data",
        "orderId": 10,
        "orderName": "Sample Text Data",
        "parentBillRunId": 23,
        "parentBillRunName": "Sample Text Data",
        "scheduleId": 13,
        "billRunSettings": "Sample Text Data"
    }
}
GETBillRun/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}
View Sample Response
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": 5,
        "billRunName": "Sample Text Data",
        "billRunScheduleStatusTypeId": 24,
        "billRunScheduleStatusTypeName": "Sample Text Data",
        "accountId": 12,
        "accountName": "Sample Text Data",
        "periodStart": "2021-04-26T15:25:27.587Z",
        "periodEnd": "2021-04-26T15:25:27.587Z",
        "createdByUserId": 21,
        "createdByUserName": "Sample Text Data",
        "orderId": 26,
        "orderName": "Sample Text Data",
        "parentBillRunId": 3,
        "parentBillRunName": "Sample Text Data",
        "scheduleId": 10,
        "billRunSettings": "Sample Text Data"
    }
}
GETBillRun/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}
View Sample Response
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": 9,
        "billRunName": "Sample Text Data",
        "billRunScheduleStatusTypeId": 0,
        "billRunScheduleStatusTypeName": "Sample Text Data",
        "accountId": 23,
        "accountName": "Sample Text Data",
        "periodStart": "2021-04-26T15:25:27.587Z",
        "periodEnd": "2021-04-26T15:25:27.587Z",
        "createdByUserId": 25,
        "createdByUserName": "Sample Text Data",
        "orderId": 17,
        "orderName": "Sample Text Data",
        "parentBillRunId": 19,
        "parentBillRunName": "Sample Text Data",
        "scheduleId": 23,
        "billRunSettings": "Sample Text Data"
    }
}
GETBillRun/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}
View Sample Response
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": 4,
        "billRunName": "Sample Text Data",
        "billRunScheduleStatusTypeId": 5,
        "billRunScheduleStatusTypeName": "Sample Text Data",
        "accountId": 14,
        "accountName": "Sample Text Data",
        "periodStart": "2021-04-26T15:25:27.587Z",
        "periodEnd": "2021-04-26T15:25:27.587Z",
        "createdByUserId": 13,
        "createdByUserName": "Sample Text Data",
        "orderId": 4,
        "orderName": "Sample Text Data",
        "parentBillRunId": 23,
        "parentBillRunName": "Sample Text Data",
        "scheduleId": 26,
        "billRunSettings": "Sample Text Data"
    }
}
POSTBillRun/Schedule/
Create a new instance of the BillRunSchedule object.
Create a new instance of the BillRunSchedule object.
POST BillRun/Schedule/

{
    "billRunId": 19,
    "billRunScheduleStatusTypeId": 14,
    "accountId": 18,
    "periodStart": "2021-04-26T15:25:27.587Z",
    "periodEnd": "2021-04-26T15:25:27.587Z",
    "createdByUserId": 16,
    "orderId": 7,
    "parentBillRunId": 24,
    "scheduleId": 23,
    "billRunSettings": "Sample Text Data"
}
View Sample Response
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": 3,
                "billRunName": "Sample Text Data",
                "billRunScheduleStatusTypeId": 1,
                "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": 21,
                "createdByUserName": "Sample Text Data",
                "orderId": 8,
                "orderName": "Sample Text Data",
                "parentBillRunId": 3,
                "parentBillRunName": "Sample Text Data",
                "scheduleId": 18,
                "billRunSettings": "Sample Text Data"
            }
        ]
    }
}
POSTBillRun/Schedule/OneTime
Create a new One Time BillRunSchedule object.
Create a new One Time BillRunSchedule object.
POST BillRun/Schedule/OneTime

{
    "billRunId": 5,
    "billRunScheduleStatusTypeId": 6,
    "accountId": 6,
    "periodStart": "2021-04-26T15:25:27.587Z",
    "periodEnd": "2021-04-26T15:25:27.587Z",
    "createdByUserId": 17,
    "orderId": 3,
    "parentBillRunId": 22,
    "scheduleId": 0,
    "billRunSettings": "Sample Text Data"
}
View Sample Response
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": 9,
                "billRunName": "Sample Text Data",
                "billRunScheduleStatusTypeId": 10,
                "billRunScheduleStatusTypeName": "Sample Text Data",
                "accountId": 14,
                "accountName": "Sample Text Data",
                "periodStart": "2021-04-26T15:25:27.587Z",
                "periodEnd": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 23,
                "createdByUserName": "Sample Text Data",
                "orderId": 26,
                "orderName": "Sample Text Data",
                "parentBillRunId": 5,
                "parentBillRunName": "Sample Text Data",
                "scheduleId": 5,
                "billRunSettings": "Sample Text Data"
            }
        ]
    }
}
POSTBillRun/Schedule/OneTime
Create a new One Time BillRunSchedule object.
Create a new One Time BillRunSchedule object.
POST BillRun/Schedule/OneTime

{
    "billRunId": 23,
    "billRunScheduleStatusTypeId": 24,
    "accountId": 4,
    "periodStart": "2021-04-26T15:25:27.587Z",
    "periodEnd": "2021-04-26T15:25:27.587Z",
    "createdByUserId": 27,
    "orderId": 0,
    "parentBillRunId": 27,
    "scheduleId": 11,
    "billRunSettings": "Sample Text Data"
}
View Sample Response
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": 9,
                "billRunName": "Sample Text Data",
                "billRunScheduleStatusTypeId": 21,
                "billRunScheduleStatusTypeName": "Sample Text Data",
                "accountId": 16,
                "accountName": "Sample Text Data",
                "periodStart": "2021-04-26T15:25:27.587Z",
                "periodEnd": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 20,
                "createdByUserName": "Sample Text Data",
                "orderId": 14,
                "orderName": "Sample Text Data",
                "parentBillRunId": 1,
                "parentBillRunName": "Sample Text Data",
                "scheduleId": 9,
                "billRunSettings": "Sample Text Data"
            }
        ]
    }
}
POSTBillRun/Schedule/OneTime
Create a new One Time BillRunSchedule object.
Create a new One Time BillRunSchedule object.
POST BillRun/Schedule/OneTime

{
    "billRunId": 3,
    "billRunScheduleStatusTypeId": 3,
    "accountId": 6,
    "periodStart": "2021-04-26T15:25:27.587Z",
    "periodEnd": "2021-04-26T15:25:27.587Z",
    "createdByUserId": 14,
    "orderId": 6,
    "parentBillRunId": 9,
    "scheduleId": 4,
    "billRunSettings": "Sample Text Data"
}
View Sample Response
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": 13,
                "billRunName": "Sample Text Data",
                "billRunScheduleStatusTypeId": 22,
                "billRunScheduleStatusTypeName": "Sample Text Data",
                "accountId": 17,
                "accountName": "Sample Text Data",
                "periodStart": "2021-04-26T15:25:27.587Z",
                "periodEnd": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 0,
                "createdByUserName": "Sample Text Data",
                "orderId": 25,
                "orderName": "Sample Text Data",
                "parentBillRunId": 22,
                "parentBillRunName": "Sample Text Data",
                "scheduleId": 7,
                "billRunSettings": "Sample Text Data"
            }
        ]
    }
}
POSTBillRun/Schedule/OneTime
Create a new One Time BillRunSchedule object.
Create a new One Time BillRunSchedule object.
POST BillRun/Schedule/OneTime

{
    "billRunId": 0,
    "billRunScheduleStatusTypeId": 14,
    "accountId": 14,
    "periodStart": "2021-04-26T15:25:27.587Z",
    "periodEnd": "2021-04-26T15:25:27.587Z",
    "createdByUserId": 8,
    "orderId": 22,
    "parentBillRunId": 2,
    "scheduleId": 3,
    "billRunSettings": "Sample Text Data"
}
View Sample Response
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": 10,
                "billRunName": "Sample Text Data",
                "billRunScheduleStatusTypeId": 27,
                "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": 5,
                "createdByUserName": "Sample Text Data",
                "orderId": 19,
                "orderName": "Sample Text Data",
                "parentBillRunId": 25,
                "parentBillRunName": "Sample Text Data",
                "scheduleId": 4,
                "billRunSettings": "Sample Text Data"
            }
        ]
    }
}
POSTBillRun/Schedule/Recurring
Create a new Recurring BillRunSchedule object.
Create a new Recurring BillRunSchedule object.
POST BillRun/Schedule/Recurring

{
    "billRunId": 21,
    "billRunScheduleStatusTypeId": 9,
    "accountId": 22,
    "periodStart": "2021-04-26T15:25:27.587Z",
    "periodEnd": "2021-04-26T15:25:27.587Z",
    "createdByUserId": 8,
    "orderId": 5,
    "parentBillRunId": 10,
    "scheduleId": 21,
    "billRunSettings": "Sample Text Data"
}
View Sample Response
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": 4,
                "billRunScheduleStatusTypeName": "Sample Text Data",
                "accountId": 12,
                "accountName": "Sample Text Data",
                "periodStart": "2021-04-26T15:25:27.587Z",
                "periodEnd": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 16,
                "createdByUserName": "Sample Text Data",
                "orderId": 8,
                "orderName": "Sample Text Data",
                "parentBillRunId": 25,
                "parentBillRunName": "Sample Text Data",
                "scheduleId": 1,
                "billRunSettings": "Sample Text Data"
            }
        ]
    }
}
POSTBillRun/Schedule/Recurring
Create a new Recurring BillRunSchedule object.
Create a new Recurring BillRunSchedule object.
POST BillRun/Schedule/Recurring

{
    "billRunId": 13,
    "billRunScheduleStatusTypeId": 3,
    "accountId": 7,
    "periodStart": "2021-04-26T15:25:27.587Z",
    "periodEnd": "2021-04-26T15:25:27.587Z",
    "createdByUserId": 14,
    "orderId": 5,
    "parentBillRunId": 0,
    "scheduleId": 16,
    "billRunSettings": "Sample Text Data"
}
View Sample Response
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": 17,
                "billRunName": "Sample Text Data",
                "billRunScheduleStatusTypeId": 27,
                "billRunScheduleStatusTypeName": "Sample Text Data",
                "accountId": 9,
                "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": 8,
                "orderName": "Sample Text Data",
                "parentBillRunId": 9,
                "parentBillRunName": "Sample Text Data",
                "scheduleId": 13,
                "billRunSettings": "Sample Text Data"
            }
        ]
    }
}
POSTBillRun/Schedule/Recurring
Create a new Recurring BillRunSchedule object.
Create a new Recurring BillRunSchedule object.
POST BillRun/Schedule/Recurring

{
    "billRunId": 5,
    "billRunScheduleStatusTypeId": 2,
    "accountId": 0,
    "periodStart": "2021-04-26T15:25:27.587Z",
    "periodEnd": "2021-04-26T15:25:27.587Z",
    "createdByUserId": 10,
    "orderId": 14,
    "parentBillRunId": 14,
    "scheduleId": 7,
    "billRunSettings": "Sample Text Data"
}
View Sample Response
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": 17,
                "billRunName": "Sample Text Data",
                "billRunScheduleStatusTypeId": 9,
                "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": 2,
                "createdByUserName": "Sample Text Data",
                "orderId": 10,
                "orderName": "Sample Text Data",
                "parentBillRunId": 10,
                "parentBillRunName": "Sample Text Data",
                "scheduleId": 27,
                "billRunSettings": "Sample Text Data"
            }
        ]
    }
}
POSTBillRun/Schedule/Recurring
Create a new Recurring BillRunSchedule object.
Create a new Recurring BillRunSchedule object.
POST BillRun/Schedule/Recurring

{
    "billRunId": 14,
    "billRunScheduleStatusTypeId": 5,
    "accountId": 26,
    "periodStart": "2021-04-26T15:25:27.587Z",
    "periodEnd": "2021-04-26T15:25:27.587Z",
    "createdByUserId": 24,
    "orderId": 13,
    "parentBillRunId": 11,
    "scheduleId": 17,
    "billRunSettings": "Sample Text Data"
}
View Sample Response
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": 6,
                "billRunName": "Sample Text Data",
                "billRunScheduleStatusTypeId": 21,
                "billRunScheduleStatusTypeName": "Sample Text Data",
                "accountId": 5,
                "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": 18,
                "orderName": "Sample Text Data",
                "parentBillRunId": 14,
                "parentBillRunName": "Sample Text Data",
                "scheduleId": 18,
                "billRunSettings": "Sample Text Data"
            }
        ]
    }
}
POSTBillRun/Schedule/{id}/Cancel
Cancel an existing BillRunSchedule based on the {id} provided.
{id}Unique identifier for the BillRunSchedule object.
POSTBillRun/Schedule/{id}/Cancel
Cancel an existing BillRunSchedule based on the {id} provided.
{id}Unique identifier for the BillRunSchedule object.
POSTBillRun/Schedule/{id}/Cancel
Cancel an existing BillRunSchedule based on the {id} provided.
{id}Unique identifier for the BillRunSchedule object.
POSTBillRun/Schedule/{id}/Cancel
Cancel an existing BillRunSchedule based on the {id} provided.
{id}Unique identifier for the BillRunSchedule object.
POSTBillRun/Schedule/{id}/Cancel
Cancel an existing BillRunSchedule based on the {id} provided.
{id}Unique identifier for the BillRunSchedule object.
PUTBillRun/Schedule/{id}
Update an existing instance of the BillRunSchedule object.
Update an existing instance of the BillRunSchedule object.
PUT BillRun/Schedule/{id}

{
    "identity": 1,
    "billRunId": 11,
    "billRunScheduleStatusTypeId": 4,
    "accountId": 22,
    "periodStart": "2021-04-26T15:25:27.587Z",
    "periodEnd": "2021-04-26T15:25:27.587Z",
    "createdByUserId": 15,
    "orderId": 12,
    "parentBillRunId": 23,
    "scheduleId": 13,
    "billRunSettings": "Sample Text Data"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "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": 9,
                "billRunName": "Sample Text Data",
                "billRunScheduleStatusTypeId": 7,
                "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": 25,
                "createdByUserName": "Sample Text Data",
                "orderId": 10,
                "orderName": "Sample Text Data",
                "parentBillRunId": 26,
                "parentBillRunName": "Sample Text Data",
                "scheduleId": 2,
                "billRunSettings": "Sample Text Data"
            }
        ]
    }
}