TAG LINE
TAG LINE
SMALL TITLE
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.
identity READ-ONLY | "identity": 13 Type: Number This is the unique numeric identifier for the BillGroupAccountExclude |
billGroupId | "billGroupId": 3 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": 6 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. |
| DELETE | BillGroup/AccountExclude/{id} |
| Delete an instance of the BillGroupAccountExclude 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 BillGroupAccountExclude object. |
Delete an instance of the BillGroupAccountExclude object. DELETE BillGroup/AccountExclude/{id}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"
}
]
}
} | |
| GET | BillGroup/AccountExclude/ |
| Retrieve all of the BillGroupAccountExclude objects. | |
Retrieve all of the BillGroupAccountExclude objects. GET BillGroup/AccountExclude/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"billGroupId": 6,
"billGroupName": "Sample Text Data",
"accountId": 17,
"accountName": "Sample Text Data"
}
]
} | |
| GET | 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 BillGroup/AccountExclude/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,
"billGroupId": 22,
"billGroupName": "Sample Text Data",
"accountId": 24,
"accountName": "Sample Text Data"
}
]
}
} | |
| GET | 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 BillGroup/AccountExclude/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"billGroupId": 24,
"billGroupName": "Sample Text Data",
"accountId": 5,
"accountName": "Sample Text Data"
}
} | |
| POST | BillGroup/AccountExclude/ |
| Create a new instance of the BillGroupAccountExclude object. | |
Create a new instance of the BillGroupAccountExclude object. POST BillGroup/AccountExclude/
{
"billGroupId": 25,
"accountId": 11
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"billGroupId": 22,
"billGroupName": "Sample Text Data",
"accountId": 19,
"accountName": "Sample Text Data"
}
]
}
} | |
| PUT | BillGroup/AccountExclude/{id} |
| Update an existing instance of the BillGroupAccountExclude object. | |
Update an existing instance of the BillGroupAccountExclude object. PUT BillGroup/AccountExclude/{id}
{
"identity": 1,
"billGroupId": 23,
"accountId": 11
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"billGroupId": 12,
"billGroupName": "Sample Text Data",
"accountId": 24,
"accountName": "Sample Text Data"
}
]
}
} | |