TAG LINE
SMALL TITLE

Bill Group / Account Exclude

(API Version v2)


This is a linking entity that specifies which Accounts should not be included in this Bill Group. This is used in scenarios where an account needs to be removed from a Bill Group temporarily to run invoicing.


What can you do with BillGroupAccountExclude?


Properties

Property Details
identity
READ-ONLY
"identity": 2
Type: Number
This is the unique numeric identifier for the BillGroupAccountExclude
billGroupId
"billGroupId": 13
Type: Number
Unique identifier for the associated BillGroup object.
billGroupName
"billGroupName": "Sample Name"
Type: String
The name of the object associated with the billGroupId property.
accountId
"accountId": 23
Type: Number
Unique identifier for the associated Account object.
accountName
"accountName": "Sample Name"
Type: String
The name of the object associated with the accountId 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:

  • billGroupId
  • accountId

End Points

DELETEapi/v2/BillGroup/AccountExclude/{id}
Delete an instance of the BillGroupAccountExclude 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 BillGroupAccountExclude object.
Delete an instance of the BillGroupAccountExclude object.
DELETE api/v2/BillGroup/AccountExclude/{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": "billGroupAccountExclude"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v2/BillGroup/AccountExclude/
Retrieve all of the BillGroupAccountExclude objects.
Retrieve all of the BillGroupAccountExclude objects.
GET api/v2/BillGroup/AccountExclude/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "billGroupId": 16,
            "billGroupName": "Sample Text Data",
            "accountId": 25,
            "accountName": "Sample Text Data"
        }
    ]
}
GETapi/v2/BillGroup/AccountExclude/Paged
Retrieve all of the BillGroupAccountExclude 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 BillGroupAccountExclude objects in a paged fashion.
GET api/v2/BillGroup/AccountExclude/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,
                "billGroupId": 7,
                "billGroupName": "Sample Text Data",
                "accountId": 16,
                "accountName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v2/BillGroup/AccountExclude/{id}
Retrieve an instance of the BillGroupAccountExclude object by its ID.
{id}Unique identifier for the BillGroupAccountExclude object.
Retrieve an instance of the BillGroupAccountExclude object by its ID.
GET api/v2/BillGroup/AccountExclude/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "billGroupId": 22,
        "billGroupName": "Sample Text Data",
        "accountId": 7,
        "accountName": "Sample Text Data"
    }
}
POSTapi/v2/BillGroup/AccountExclude/
Create a new instance of the BillGroupAccountExclude object.
Create a new instance of the BillGroupAccountExclude object.
POST api/v2/BillGroup/AccountExclude/

{
    "billGroupId": 9,
    "accountId": 10
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "billGroupId": 23,
                "billGroupName": "Sample Text Data",
                "accountId": 24,
                "accountName": "Sample Text Data"
            }
        ]
    }
}
PUTapi/v2/BillGroup/AccountExclude/{id}
Update an existing instance of the BillGroupAccountExclude object.
Update an existing instance of the BillGroupAccountExclude object.
PUT api/v2/BillGroup/AccountExclude/{id}

{
    "identity": 1,
    "billGroupId": 15,
    "accountId": 3
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "billGroupId": 24,
                "billGroupName": "Sample Text Data",
                "accountId": 7,
                "accountName": "Sample Text Data"
            }
        ]
    }
}