TAG LINE
SMALL TITLE

Bill Group

(API Version v3)


A Bill Group is assigned to an Account to group Accounts together that follow the same billing rules. These details contain configuration such as bill day, invoice delivery method etc.


What can you do with BillGroup?


Properties

Property Details
identity
READ-ONLY
"identity": 22
Type: Number
This is the unique numeric identifier for the BillGroup
name
"name": "First of the Month"
Type: String
User defined name given to the Bill Group.
advanceInvoiceDays
READ-ONLY
"advanceInvoiceDays": 26
Type: Number
System generated.
ownerId
READ-ONLY
"ownerId": 2
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.
billDay
"billDay": 12
Type: Number
The day of the month in which this group should be billed for recurring and one-time charges.
invoiceDateProcessTypeId
"invoiceDateProcessTypeId": 7
Type: Number
Unique identifier for the associated InvoiceDateProcessType object.
invoiceDateProcessTypeName
"invoiceDateProcessTypeName": "Sample Name"
Type: String
The name of the object associated with the invoiceDateProcessTypeId property.
invoiceCloseThresholdAmount
"invoiceCloseThresholdAmount": 2.51
Type: Number
The minimum threshold that the invoice must total before generating an invoice.
usageBillingTypeId
"usageBillingTypeId": 12
Type: Number
Unique identifier for the associated UsageBillingType object.
usageBillingTypeName
"usageBillingTypeName": "Sample Name"
Type: String
The name of the object associated with the usageBillingTypeId property.
invoiceDueDateTypeId
"invoiceDueDateTypeId": 4
Type: Number
Unique identifier for the associated InvoiceDueDateType object.
invoiceDueDateTypeName
"invoiceDueDateTypeName": "Sample Name"
Type: String
The name of the object associated with the invoiceDueDateTypeId property.
usageBillDay
"usageBillDay": 17
Type: Number
The day of the month in which usage associated to this group should be billed.
invoiceDeliveryId
"invoiceDeliveryId": 23
Type: Number
Unique identifier for the associated InvoiceDelivery object.
invoiceDeliveryName
"invoiceDeliveryName": "Sample Name"
Type: String
The name of the object associated with the invoiceDeliveryId property.


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • advanceInvoiceDays
  • billDay
  • invoiceDateProcessTypeId
  • invoiceCloseThresholdAmount
  • usageBillingTypeId
  • invoiceDueDateTypeId
  • usageBillDay
  • invoiceDeliveryId

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 or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the BillGroup object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v3/BillGroup/{id}
Delete an instance of the BillGroup 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 BillGroup object.
Delete an instance of the BillGroup object.
DELETE api/v3/BillGroup/{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": "billGroup"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v3/BillGroup/
Retrieve all of the BillGroup objects.
Retrieve all of the BillGroup objects.
GET api/v3/BillGroup/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "First of the Month",
            "advanceInvoiceDays": 26,
            "ownerId": 10,
            "ownerName": "Sample Text Data",
            "billDay": 17,
            "invoiceDateProcessTypeId": 8,
            "invoiceDateProcessTypeName": "Sample Text Data",
            "invoiceCloseThresholdAmount": 2.51,
            "usageBillingTypeId": 1,
            "usageBillingTypeName": "Sample Text Data",
            "invoiceDueDateTypeId": 0,
            "invoiceDueDateTypeName": "Sample Text Data",
            "usageBillDay": 21,
            "invoiceDeliveryId": 17,
            "invoiceDeliveryName": "Sample Text Data"
        }
    ]
}
GETapi/v3/BillGroup/Paged
Retrieve all of the BillGroup 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 BillGroup objects in a paged fashion.
GET api/v3/BillGroup/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,
                "name": "First of the Month",
                "advanceInvoiceDays": 16,
                "ownerId": 0,
                "ownerName": "Sample Text Data",
                "billDay": 8,
                "invoiceDateProcessTypeId": 25,
                "invoiceDateProcessTypeName": "Sample Text Data",
                "invoiceCloseThresholdAmount": 2.51,
                "usageBillingTypeId": 14,
                "usageBillingTypeName": "Sample Text Data",
                "invoiceDueDateTypeId": 2,
                "invoiceDueDateTypeName": "Sample Text Data",
                "usageBillDay": 24,
                "invoiceDeliveryId": 1,
                "invoiceDeliveryName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v3/BillGroup/Paged/Detail
Retrieve all of the BillGroup 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 BillGroup objects in a paged fashion with all object details.
GET api/v3/BillGroup/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,
                "name": "First of the Month",
                "advanceInvoiceDays": 10,
                "ownerId": 19,
                "ownerName": "Sample Text Data",
                "billDay": 6,
                "invoiceDateProcessTypeId": 5,
                "invoiceDateProcessTypeName": "Sample Text Data",
                "invoiceCloseThresholdAmount": 2.51,
                "usageBillingTypeId": 1,
                "usageBillingTypeName": "Sample Text Data",
                "invoiceDueDateTypeId": 18,
                "invoiceDueDateTypeName": "Sample Text Data",
                "usageBillDay": 3,
                "invoiceDeliveryId": 2,
                "invoiceDeliveryName": "Sample Text Data",
                "details": {
                    "sampleSingleObject": {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    },
                    "sampleMultipleObjects": {
                        "totalCount": 1,
                        "items": [
                            {
                                "identity": 2,
                                "property1": "Sample Text",
                                "property2": "2021-04-26T15:25:29.117Z",
                                "property3": 2
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETapi/v3/BillGroup/{id}
Retrieve an instance of the BillGroup object by its ID.
{id}Unique identifier for the BillGroup object.
Retrieve an instance of the BillGroup object by its ID.
GET api/v3/BillGroup/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "First of the Month",
        "advanceInvoiceDays": 17,
        "ownerId": 4,
        "ownerName": "Sample Text Data",
        "billDay": 13,
        "invoiceDateProcessTypeId": 25,
        "invoiceDateProcessTypeName": "Sample Text Data",
        "invoiceCloseThresholdAmount": 2.51,
        "usageBillingTypeId": 3,
        "usageBillingTypeName": "Sample Text Data",
        "invoiceDueDateTypeId": 16,
        "invoiceDueDateTypeName": "Sample Text Data",
        "usageBillDay": 1,
        "invoiceDeliveryId": 22,
        "invoiceDeliveryName": "Sample Text Data"
    }
}
GETapi/v3/BillGroup/{id}/Detail
Retrieve deep detail of the BillGroup 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 BillGroup object.
Retrieve deep detail of the BillGroup object by its ID.
GET api/v3/BillGroup/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "First of the Month",
        "advanceInvoiceDays": 2,
        "ownerId": 2,
        "ownerName": "Sample Text Data",
        "billDay": 15,
        "invoiceDateProcessTypeId": 12,
        "invoiceDateProcessTypeName": "Sample Text Data",
        "invoiceCloseThresholdAmount": 2.51,
        "usageBillingTypeId": 1,
        "usageBillingTypeName": "Sample Text Data",
        "invoiceDueDateTypeId": 24,
        "invoiceDueDateTypeName": "Sample Text Data",
        "usageBillDay": 5,
        "invoiceDeliveryId": 22,
        "invoiceDeliveryName": "Sample Text Data",
        "details": {
            "sampleSingleObject": {
                "identity": 2,
                "property1": "Sample Text",
                "property2": "2021-04-26T15:25:29.117Z",
                "property3": 2
            },
            "sampleMultipleObjects": {
                "totalCount": 1,
                "items": [
                    {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    }
                ]
            }
        }
    }
}
PATCHapi/v3/BillGroup/{id}
Update or Add the BillGroup 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 BillGroup object.
Update or Add the BillGroup object and optionally make changes to any child objects.
PATCH api/v3/BillGroup/{id}

{
    "details": {},
    "billGroups": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "name": "First of the Month",
                "billDay": 3,
                "invoiceDateProcessTypeId": 7,
                "invoiceCloseThresholdAmount": 2.51,
                "usageBillingTypeId": 27,
                "invoiceDueDateTypeId": 1,
                "usageBillDay": 0,
                "invoiceDeliveryId": 6
            }
        ]
    }
}
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": "billGroup",
                "instance": {
                    "identity": 1,
                    "name": "First of the Month",
                    "advanceInvoiceDays": 7,
                    "ownerId": 12,
                    "ownerName": "Sample Text Data",
                    "billDay": 16,
                    "invoiceDateProcessTypeId": 7,
                    "invoiceDateProcessTypeName": "Sample Text Data",
                    "invoiceCloseThresholdAmount": 2.51,
                    "usageBillingTypeId": 12,
                    "usageBillingTypeName": "Sample Text Data",
                    "invoiceDueDateTypeId": 4,
                    "invoiceDueDateTypeName": "Sample Text Data",
                    "usageBillDay": 8,
                    "invoiceDeliveryId": 5,
                    "invoiceDeliveryName": "Sample Text Data"
                }
            }
        ]
    }
}
POSTapi/v3/BillGroup/
Create a new instance of the BillGroup object.
Create a new instance of the BillGroup object.
POST api/v3/BillGroup/

{
    "name": "First of the Month",
    "billDay": 27,
    "invoiceDateProcessTypeId": 5,
    "invoiceCloseThresholdAmount": 2.51,
    "usageBillingTypeId": 16,
    "invoiceDueDateTypeId": 10,
    "usageBillDay": 8,
    "invoiceDeliveryId": 14
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "First of the Month",
                "advanceInvoiceDays": 7,
                "ownerId": 2,
                "ownerName": "Sample Text Data",
                "billDay": 11,
                "invoiceDateProcessTypeId": 19,
                "invoiceDateProcessTypeName": "Sample Text Data",
                "invoiceCloseThresholdAmount": 2.51,
                "usageBillingTypeId": 19,
                "usageBillingTypeName": "Sample Text Data",
                "invoiceDueDateTypeId": 23,
                "invoiceDueDateTypeName": "Sample Text Data",
                "usageBillDay": 19,
                "invoiceDeliveryId": 12,
                "invoiceDeliveryName": "Sample Text Data"
            }
        ]
    }
}
PUTapi/v3/BillGroup/{id}
Update an existing instance of the BillGroup object.
Update an existing instance of the BillGroup object.
PUT api/v3/BillGroup/{id}

{
    "identity": 1,
    "name": "First of the Month",
    "billDay": 16,
    "invoiceDateProcessTypeId": 24,
    "invoiceCloseThresholdAmount": 2.51,
    "usageBillingTypeId": 0,
    "invoiceDueDateTypeId": 21,
    "usageBillDay": 3,
    "invoiceDeliveryId": 8
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "First of the Month",
                "advanceInvoiceDays": 8,
                "ownerId": 9,
                "ownerName": "Sample Text Data",
                "billDay": 14,
                "invoiceDateProcessTypeId": 20,
                "invoiceDateProcessTypeName": "Sample Text Data",
                "invoiceCloseThresholdAmount": 2.51,
                "usageBillingTypeId": 25,
                "usageBillingTypeName": "Sample Text Data",
                "invoiceDueDateTypeId": 2,
                "invoiceDueDateTypeName": "Sample Text Data",
                "usageBillDay": 18,
                "invoiceDeliveryId": 18,
                "invoiceDeliveryName": "Sample Text Data"
            }
        ]
    }
}