Bill Run

(API Version v7)

A Bill Run is used to execute billing on a set of Bill Groups. There are multiple different options that can be selected on what should be included as actions of the Bill Run.

What can you do with BillRun?

DELETE BillRun/{id}
Delete an instance of the BillRun object.
GET BillRun/
Retrieve all of the BillRun objects.
GET BillRun/Paged
Retrieve all of the BillRun objects in a paged fashion.
GET BillRun/Paged/Detail
Retrieve all of the BillRun objects in a paged fashion with all object details.
GET BillRun/{id}
Retrieve an instance of the BillRun object by its ID.
GET BillRun/{id}/Detail
Retrieve deep detail of the BillRun object by its ID.
PATCH BillRun/{id}
Update or Add the BillRun object and optionally make changes to any child objects.
POST BillRun/
Create a new instance of the BillRun object.
PUT BillRun/{id}
Update an existing instance of the BillRun object.

Properties

Property Details

identity READ-ONLY	"identity": 12 Type: Number This is the unique numeric identifier for the BillRun
billPeriodEnd	"billPeriodEnd": "2021-04-26T15:25:27.587Z" Type: Date The end date to look for billable transactions. Date and time values are specified in the ISO 8601 format.
billPeriodStart	"billPeriodStart": "2021-04-26T15:25:27.587Z" Type: Date The start date to look for billable transactions. Date and time values are specified in the ISO 8601 format.
ownerId READ-ONLY	"ownerId": 7 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.
runBilling	"runBilling": true Type: Boolean Whether or not to calculate recurring and one-time charges as part of this Bill Run.
name	"name": "First of the Month Invoice Delivery" Type: String User defined name given to the Bill Run.
runDelivery	"runDelivery": true Type: Boolean Whether or not to deliver invoices as part of this Bill Run.
runRenderInvoice	"runRenderInvoice": true Type: Boolean Whether or not to generate a rendered PDF version of invoices as part of this Bill Run.
runPaymentTerm	"runPaymentTerm": true Type: Boolean Whether or not to execute Dunning Rules as part of this Bill Run.
runBillUsage	"runBillUsage": true Type: Boolean Whether or not calculate usage charges as part of this Bill Run.
enabled READ-ONLY	"enabled": true Type: Boolean Whether or not Bill Run is enabled within the system to run.
runPaymentRetryTerms	"runPaymentRetryTerms": true Type: Boolean Whether or not to execute payment retries as part of this Bill Run.
collectionTypeId	"collectionTypeId": 20 Type: Number Unique identifier for the associated CollectionType object.
collectionTypeName	"collectionTypeName": "Sample Name" Type: String The name of the object associated with the collectionTypeId property.
runInvoicing	"runInvoicing": true Type: Boolean Whether or not to generate invoice data and assign an invoice number as part of this Bill Run.
currencyExchangeId	"currencyExchangeId": 1 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.
runContract	"runContract": true Type: Boolean Whether or not to run Contract Enforcement rules as part of this Bill Run.
posting	"posting": "2021-04-26T15:25:27.587Z" Type: Date Specify the accounting posting date associated with this Bill Run. Date and time values are specified in the ISO 8601 format.
billRunStatusTypeId	"billRunStatusTypeId": 3 Type: Number Unique identifier for the associated BillRunStatusType object.
billRunStatusTypeName	"billRunStatusTypeName": "Sample Name" Type: String The name of the object associated with the billRunStatusTypeId property.
runPayment	"runPayment": true Type: Boolean Whether or not to run Collections as part of this Bill Run.
billRunTypeId	"billRunTypeId": 5 Type: Number Unique identifier for the associated BillRunType object.
billRunTypeName	"billRunTypeName": "Sample Name" Type: String The name of the object associated with the billRunTypeId property.
runInvoicingContract	"runInvoicingContract": true Type: Boolean Whether or not to run Invoice Top-up as part of this Bill Run.

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call. Below you will find the child objects that can be updated as part of PATCH operations for the BillRun object.

Standard PATCH objects:

billGroup - attach, detach
billRunSchedule - create, update, delete

DataFlow PATCH objects:

billRun - create, update, delete
billGroup - attach, detach
billRunSchedule - create, update, delete

End Points

DELETE	BillRun/{id}
Delete an instance of the BillRun object. Upon successful delete, this API will return a record of all of the related 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 BillRun object.
Delete an instance of the BillRun object. DELETE BillRun/{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": "billRun" }, { "lhsId": 2, "rhsId": 2, "action": "detached", "dtoTypeKey": "sampleObjectConnector" }, { "foreignKeyIdentity": 2, "action": "deleted", "dtoTypeKey": "sampleObject" } ] } }

Retrieve all of the BillRun objects.

GET BillRun/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "billPeriodEnd": "2021-04-26T15:25:27.587Z",
            "billPeriodStart": "2021-04-26T15:25:27.587Z",
            "ownerId": 15,
            "ownerName": "Sample Text Data",
            "runBilling": true,
            "name": "First of the Month Invoice Delivery",
            "runDelivery": true,
            "runRenderInvoice": true,
            "runPaymentTerm": true,
            "runBillUsage": true,
            "enabled": true,
            "runPaymentRetryTerms": true,
            "collectionTypeId": 22,
            "collectionTypeName": "Sample Text Data",
            "runInvoicing": true,
            "currencyExchangeId": 13,
            "currencyExchangeName": "Sample Text Data",
            "runContract": true,
            "posting": "2021-04-26T15:25:27.587Z",
            "billRunStatusTypeId": 3,
            "billRunStatusTypeName": "Sample Text Data",
            "runPayment": true,
            "billRunTypeId": 9,
            "billRunTypeName": "Sample Text Data",
            "runInvoicingContract": true
        }
    ]
}

Retrieve all of the BillRun 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 BillRun objects in a paged fashion.

GET BillRun/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,
                "billPeriodEnd": "2021-04-26T15:25:27.587Z",
                "billPeriodStart": "2021-04-26T15:25:27.587Z",
                "ownerId": 18,
                "ownerName": "Sample Text Data",
                "runBilling": true,
                "name": "First of the Month Invoice Delivery",
                "runDelivery": true,
                "runRenderInvoice": true,
                "runPaymentTerm": true,
                "runBillUsage": true,
                "enabled": true,
                "runPaymentRetryTerms": true,
                "collectionTypeId": 4,
                "collectionTypeName": "Sample Text Data",
                "runInvoicing": true,
                "currencyExchangeId": 0,
                "currencyExchangeName": "Sample Text Data",
                "runContract": true,
                "posting": "2021-04-26T15:25:27.587Z",
                "billRunStatusTypeId": 14,
                "billRunStatusTypeName": "Sample Text Data",
                "runPayment": true,
                "billRunTypeId": 9,
                "billRunTypeName": "Sample Text Data",
                "runInvoicingContract": true
            }
        ]
    }
}

Retrieve all of the BillRun objects in a paged fashion with all object details. 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.

Retrieve all of the BillRun objects in a paged fashion with all object details.

GET BillRun/Paged/Detail

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,
                "billPeriodEnd": "2021-04-26T15:25:27.587Z",
                "billPeriodStart": "2021-04-26T15:25:27.587Z",
                "ownerId": 22,
                "ownerName": "Sample Text Data",
                "runBilling": true,
                "name": "First of the Month Invoice Delivery",
                "runDelivery": true,
                "runRenderInvoice": true,
                "runPaymentTerm": true,
                "runBillUsage": true,
                "enabled": true,
                "runPaymentRetryTerms": true,
                "collectionTypeId": 18,
                "collectionTypeName": "Sample Text Data",
                "runInvoicing": true,
                "currencyExchangeId": 15,
                "currencyExchangeName": "Sample Text Data",
                "runContract": true,
                "posting": "2021-04-26T15:25:27.587Z",
                "billRunStatusTypeId": 6,
                "billRunStatusTypeName": "Sample Text Data",
                "runPayment": true,
                "billRunTypeId": 13,
                "billRunTypeName": "Sample Text Data",
                "runInvoicingContract": true,
                "details": {
                    "groups": [
                        {
                            "identity": 94,
                            "name": "Sample Text Data",
                            "advanceInvoiceDays": 67,
                            "billDay": 66,
                            "invoiceDateProcessTypeId": 14,
                            "invoiceDateProcessTypeName": "Sample Text Data",
                            "invoiceCloseThresholdAmount": 7.1,
                            "usageBillingTypeId": 90,
                            "usageBillingTypeName": "Sample Text Data",
                            "invoiceDueDateTypeId": 19,
                            "invoiceDueDateTypeName": "Sample Text Data",
                            "usageBillDay": 90,
                            "invoiceDeliveryId": 5,
                            "invoiceDeliveryName": "Sample Text Data"
                        }
                    ],
                    "schedules": [
                        {
                            "identity": 31,
                            "created": "2021-04-26T15:25:27.587Z",
                            "start": "2021-04-26T15:25:27.587Z",
                            "complete": "2021-04-26T15:25:27.587Z",
                            "billRunId": 66,
                            "billRunName": "Sample Text Data",
                            "billRunScheduleStatusTypeId": 38,
                            "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": 49,
                            "createdByUserName": "Sample Text Data",
                            "orderId": 76,
                            "parentBillRunId": 50,
                            "parentBillRunName": "Sample Text Data",
                            "scheduleId": 19,
                            "scheduleName": "Sample Text Data",
                            "billRunSettings": "Sample Text Data"
                        }
                    ],
                    "recentSchedules": [
                        {
                            "identity": 22,
                            "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": 37,
                            "billRunScheduleStatusTypeName": "Sample Text Data",
                            "accountId": 51,
                            "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": 47,
                            "parentBillRunId": 17,
                            "parentBillRunName": "Sample Text Data",
                            "scheduleId": 49,
                            "scheduleName": "Sample Text Data",
                            "billRunSettings": "Sample Text Data"
                        }
                    ]
                }
            }
        ]
    }
}

GET	BillRun/{id}
Retrieve an instance of the BillRun object by its ID.
{id}	Unique identifier for the BillRun object.
Retrieve an instance of the BillRun object by its ID. GET BillRun/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "billPeriodEnd": "2021-04-26T15:25:27.587Z", "billPeriodStart": "2021-04-26T15:25:27.587Z", "ownerId": 20, "ownerName": "Sample Text Data", "runBilling": true, "name": "First of the Month Invoice Delivery", "runDelivery": true, "runRenderInvoice": true, "runPaymentTerm": true, "runBillUsage": true, "enabled": true, "runPaymentRetryTerms": true, "collectionTypeId": 9, "collectionTypeName": "Sample Text Data", "runInvoicing": true, "currencyExchangeId": 17, "currencyExchangeName": "Sample Text Data", "runContract": true, "posting": "2021-04-26T15:25:27.587Z", "billRunStatusTypeId": 3, "billRunStatusTypeName": "Sample Text Data", "runPayment": true, "billRunTypeId": 23, "billRunTypeName": "Sample Text Data", "runInvoicingContract": true } }

GET	BillRun/{id}/Detail
Retrieve deep detail of the BillRun 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 BillRun object.
Retrieve deep detail of the BillRun object by its ID. GET BillRun/{id}/Detail View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "billPeriodEnd": "2021-04-26T15:25:27.587Z", "billPeriodStart": "2021-04-26T15:25:27.587Z", "ownerId": 12, "ownerName": "Sample Text Data", "runBilling": true, "name": "First of the Month Invoice Delivery", "runDelivery": true, "runRenderInvoice": true, "runPaymentTerm": true, "runBillUsage": true, "enabled": true, "runPaymentRetryTerms": true, "collectionTypeId": 12, "collectionTypeName": "Sample Text Data", "runInvoicing": true, "currencyExchangeId": 9, "currencyExchangeName": "Sample Text Data", "runContract": true, "posting": "2021-04-26T15:25:27.587Z", "billRunStatusTypeId": 14, "billRunStatusTypeName": "Sample Text Data", "runPayment": true, "billRunTypeId": 13, "billRunTypeName": "Sample Text Data", "runInvoicingContract": true, "details": { "groups": [ { "identity": 94, "name": "Sample Text Data", "advanceInvoiceDays": 67, "billDay": 66, "invoiceDateProcessTypeId": 14, "invoiceDateProcessTypeName": "Sample Text Data", "invoiceCloseThresholdAmount": 7.1, "usageBillingTypeId": 90, "usageBillingTypeName": "Sample Text Data", "invoiceDueDateTypeId": 19, "invoiceDueDateTypeName": "Sample Text Data", "usageBillDay": 90, "invoiceDeliveryId": 5, "invoiceDeliveryName": "Sample Text Data" } ], "schedules": [ { "identity": 31, "created": "2021-04-26T15:25:27.587Z", "start": "2021-04-26T15:25:27.587Z", "complete": "2021-04-26T15:25:27.587Z", "billRunId": 66, "billRunName": "Sample Text Data", "billRunScheduleStatusTypeId": 38, "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": 49, "createdByUserName": "Sample Text Data", "orderId": 76, "parentBillRunId": 50, "parentBillRunName": "Sample Text Data", "scheduleId": 19, "scheduleName": "Sample Text Data", "billRunSettings": "Sample Text Data" } ], "recentSchedules": [ { "identity": 22, "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": 37, "billRunScheduleStatusTypeName": "Sample Text Data", "accountId": 51, "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": 47, "parentBillRunId": 17, "parentBillRunName": "Sample Text Data", "scheduleId": 49, "scheduleName": "Sample Text Data", "billRunSettings": "Sample Text Data" } ] } } }

PATCH	BillRun/{id}
Update or Add the BillRun object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.
{id}	Unique identifier for the BillRun object.
Update or Add the BillRun object and optionally make changes to any child objects. PATCH BillRun/{id} { "details": {}, "billRuns": { "items": [ { "patchType": "create", "patchClientId": 1, "billPeriodEnd": "2021-04-26T15:25:27.587Z", "billPeriodStart": "2021-04-26T15:25:27.587Z", "runBilling": true, "name": "First of the Month Invoice Delivery", "runDelivery": true, "runRenderInvoice": true, "runPaymentTerm": true, "runBillUsage": true, "runPaymentRetryTerms": true, "collectionTypeId": 2, "runInvoicing": true, "currencyExchangeId": 9, "runContract": true, "posting": "2021-04-26T15:25:27.587Z", "billRunStatusTypeId": 14, "runPayment": true, "billRunTypeId": 26, "runInvoicingContract": true } ] } } View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "patch", "results": { "totalCount": 1, "items": [ { "identity": 1, "action": "created", "dtoTypeKey": "billRun", "instance": { "identity": 1, "billPeriodEnd": "2021-04-26T15:25:27.587Z", "billPeriodStart": "2021-04-26T15:25:27.587Z", "ownerId": 6, "ownerName": "Sample Text Data", "runBilling": true, "name": "First of the Month Invoice Delivery", "runDelivery": true, "runRenderInvoice": true, "runPaymentTerm": true, "runBillUsage": true, "enabled": true, "runPaymentRetryTerms": true, "collectionTypeId": 8, "collectionTypeName": "Sample Text Data", "runInvoicing": true, "currencyExchangeId": 27, "currencyExchangeName": "Sample Text Data", "runContract": true, "posting": "2021-04-26T15:25:27.587Z", "billRunStatusTypeId": 4, "billRunStatusTypeName": "Sample Text Data", "runPayment": true, "billRunTypeId": 19, "billRunTypeName": "Sample Text Data", "runInvoicingContract": true } } ] } }

Create a new instance of the BillRun object.

POST BillRun/

{
    "billPeriodEnd": "2021-04-26T15:25:27.587Z",
    "billPeriodStart": "2021-04-26T15:25:27.587Z",
    "runBilling": true,
    "name": "First of the Month Invoice Delivery",
    "runDelivery": true,
    "runRenderInvoice": true,
    "runPaymentTerm": true,
    "runBillUsage": true,
    "runPaymentRetryTerms": true,
    "collectionTypeId": 5,
    "runInvoicing": true,
    "currencyExchangeId": 8,
    "runContract": true,
    "posting": "2021-04-26T15:25:27.587Z",
    "billRunStatusTypeId": 4,
    "runPayment": true,
    "billRunTypeId": 18,
    "runInvoicingContract": true
}

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "billPeriodEnd": "2021-04-26T15:25:27.587Z",
                "billPeriodStart": "2021-04-26T15:25:27.587Z",
                "ownerId": 11,
                "ownerName": "Sample Text Data",
                "runBilling": true,
                "name": "First of the Month Invoice Delivery",
                "runDelivery": true,
                "runRenderInvoice": true,
                "runPaymentTerm": true,
                "runBillUsage": true,
                "enabled": true,
                "runPaymentRetryTerms": true,
                "collectionTypeId": 10,
                "collectionTypeName": "Sample Text Data",
                "runInvoicing": true,
                "currencyExchangeId": 19,
                "currencyExchangeName": "Sample Text Data",
                "runContract": true,
                "posting": "2021-04-26T15:25:27.587Z",
                "billRunStatusTypeId": 2,
                "billRunStatusTypeName": "Sample Text Data",
                "runPayment": true,
                "billRunTypeId": 4,
                "billRunTypeName": "Sample Text Data",
                "runInvoicingContract": true
            }
        ]
    }
}

Update an existing instance of the BillRun object.

PUT BillRun/{id}

{
    "identity": 1,
    "billPeriodEnd": "2021-04-26T15:25:27.587Z",
    "billPeriodStart": "2021-04-26T15:25:27.587Z",
    "runBilling": true,
    "name": "First of the Month Invoice Delivery",
    "runDelivery": true,
    "runRenderInvoice": true,
    "runPaymentTerm": true,
    "runBillUsage": true,
    "runPaymentRetryTerms": true,
    "collectionTypeId": 15,
    "runInvoicing": true,
    "currencyExchangeId": 5,
    "runContract": true,
    "posting": "2021-04-26T15:25:27.587Z",
    "billRunStatusTypeId": 24,
    "runPayment": true,
    "billRunTypeId": 17,
    "runInvoicingContract": true
}

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "billPeriodEnd": "2021-04-26T15:25:27.587Z",
                "billPeriodStart": "2021-04-26T15:25:27.587Z",
                "ownerId": 2,
                "ownerName": "Sample Text Data",
                "runBilling": true,
                "name": "First of the Month Invoice Delivery",
                "runDelivery": true,
                "runRenderInvoice": true,
                "runPaymentTerm": true,
                "runBillUsage": true,
                "enabled": true,
                "runPaymentRetryTerms": true,
                "collectionTypeId": 3,
                "collectionTypeName": "Sample Text Data",
                "runInvoicing": true,
                "currencyExchangeId": 4,
                "currencyExchangeName": "Sample Text Data",
                "runContract": true,
                "posting": "2021-04-26T15:25:27.587Z",
                "billRunStatusTypeId": 23,
                "billRunStatusTypeName": "Sample Text Data",
                "runPayment": true,
                "billRunTypeId": 21,
                "billRunTypeName": "Sample Text Data",
                "runInvoicingContract": true
            }
        ]
    }
}