TAG LINE
SMALL TITLE
An Account Service is a billable line item of a Package that has been assigned to an account.
identity READ-ONLY | "identity": "Hello World" Type: String This is the unique numeric identifier for the AccountService |
serviceId | "serviceId": 21 Type: Number Unique identifier for the associated Service object. |
serviceName | "serviceName": "Sample Name" Type: String The name of the object associated with the serviceId property. |
accountId | "accountId": 15 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. |
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. |
accountPackageId | "accountPackageId": "Hello World" Type: String Unique identifier for the associated AccountPackage object. |
accountPackageName | "accountPackageName": "Sample Name" Type: String The name of the object associated with the accountPackageId property. |
name | "name": "Hello World" Type: String This is the name assigned to the Service typically inherited from the product catalog. |
usageBillDay READ-ONLY | "usageBillDay": 21 Type: Number Day of the month in which usage associated to this service is billed. Inherited from the Service in the product catalog. |
amount | "amount": 14 Type: Number The quantity of this service within its associated package. |
updated | "updated": "2021-04-26T15:25:27.587Z" Type: Date Date and time values are specified in the ISO 8601 format. |
effective | "effective": "2021-04-26T15:25:27.587Z" Type: Date The effective date when this account service becomes billable. Date and time values are specified in the ISO 8601 format. |
posted | "posted": "2021-04-26T15:25:27.587Z" Type: Date Date and time values are specified in the ISO 8601 format. |
createdByUserId | "createdByUserId": 1 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. |
updatedByUserId | "updatedByUserId": 25 Type: Number Unique identifier for the associated User object. |
updatedByUserName | "updatedByUserName": "Sample Name" Type: String The name of the object associated with the updatedByUserId property. |
effectiveCancel | "effectiveCancel": "2021-04-26T15:25:27.587Z" Type: Date The date when this account service will be cancelled. Date and time values are specified in the ISO 8601 format. |
usageNextBill READ-ONLY | "usageNextBill": "2021-04-26T15:25:27.587Z" Type: Date The date when this account service will have its related usage billed. Date and time values are specified in the ISO 8601 format. |
usageFinalBill READ-ONLY | "usageFinalBill": "2021-04-26T15:25:27.587Z" Type: Date The date when this account service had its final related usage billed. Date and time values are specified in the ISO 8601 format. |
finalBill READ-ONLY | "finalBill": "2021-04-26T15:25:27.587Z" Type: Date The date when this account service had its final related recurring and one time charges billed. Date and time values are specified in the ISO 8601 format. |
lastBilled READ-ONLY | "lastBilled": "2021-04-26T15:25:27.587Z" Type: Date The date when this account service's related recurring and one time charges were last billed. Date and time values are specified in the ISO 8601 format. |
lastUsageBilled READ-ONLY | "lastUsageBilled": "2021-04-26T15:25:27.587Z" Type: Date The date when this account service's related usage was last billed. Date and time values are specified in the ISO 8601 format. |
addOnPackageFrequencyId | "addOnPackageFrequencyId": 15 Type: Number Unique identifier for the associated PackageFrequency object. |
addOnPackageFrequencyName | "addOnPackageFrequencyName": "Sample Name" Type: String The name of the object associated with the addOnPackageFrequencyId property. |
id | "id": "Hello World" Type: String |
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:
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 AccountService object.
Standard PATCH objects:
DataFlow PATCH objects:
| DELETE | api/v3/Account/Service/{id} |
| Delete an instance of the AccountService 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 AccountService object. |
Delete an instance of the AccountService object. DELETE api/v3/Account/Service/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "accountService"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | api/v3/Account/Service/ |
| Retrieve all of the AccountService objects. | |
Retrieve all of the AccountService objects. GET api/v3/Account/Service/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"serviceId": 17,
"serviceName": "Sample Text Data",
"accountId": 26,
"accountName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"accountPackageId": "Sample Text Data",
"accountPackageName": "Sample Text Data",
"name": "Sample Text Data",
"usageBillDay": 15,
"amount": 4,
"updated": "2021-04-26T15:25:27.587Z",
"effective": "2021-04-26T15:25:27.587Z",
"posted": "2021-04-26T15:25:27.587Z",
"createdByUserId": 10,
"createdByUserName": "Sample Text Data",
"updatedByUserId": 17,
"updatedByUserName": "Sample Text Data",
"effectiveCancel": "2021-04-26T15:25:27.587Z",
"usageNextBill": "2021-04-26T15:25:27.587Z",
"usageFinalBill": "2021-04-26T15:25:27.587Z",
"finalBill": "2021-04-26T15:25:27.587Z",
"lastBilled": "2021-04-26T15:25:27.587Z",
"lastUsageBilled": "2021-04-26T15:25:27.587Z",
"addOnPackageFrequencyId": 22,
"addOnPackageFrequencyName": "Sample Text Data",
"id": "Sample Text Data"
}
]
} | |
| GET | api/v3/Account/Service/Paged |
| Retrieve all of the AccountService 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 AccountService objects in a paged fashion. GET api/v3/Account/Service/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,
"serviceId": 16,
"serviceName": "Sample Text Data",
"accountId": 0,
"accountName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"accountPackageId": "Sample Text Data",
"accountPackageName": "Sample Text Data",
"name": "Sample Text Data",
"usageBillDay": 18,
"amount": 13,
"updated": "2021-04-26T15:25:27.587Z",
"effective": "2021-04-26T15:25:27.587Z",
"posted": "2021-04-26T15:25:27.587Z",
"createdByUserId": 8,
"createdByUserName": "Sample Text Data",
"updatedByUserId": 10,
"updatedByUserName": "Sample Text Data",
"effectiveCancel": "2021-04-26T15:25:27.587Z",
"usageNextBill": "2021-04-26T15:25:27.587Z",
"usageFinalBill": "2021-04-26T15:25:27.587Z",
"finalBill": "2021-04-26T15:25:27.587Z",
"lastBilled": "2021-04-26T15:25:27.587Z",
"lastUsageBilled": "2021-04-26T15:25:27.587Z",
"addOnPackageFrequencyId": 23,
"addOnPackageFrequencyName": "Sample Text Data",
"id": "Sample Text Data"
}
]
}
} | |
| GET | api/v3/Account/Service/Paged/Detail |
| Retrieve all of the AccountService 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 AccountService objects in a paged fashion with all object details. GET api/v3/Account/Service/Paged/Detail HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"serviceId": 14,
"serviceName": "Sample Text Data",
"accountId": 2,
"accountName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"accountPackageId": "Sample Text Data",
"accountPackageName": "Sample Text Data",
"name": "Sample Text Data",
"usageBillDay": 4,
"amount": 24,
"updated": "2021-04-26T15:25:27.587Z",
"effective": "2021-04-26T15:25:27.587Z",
"posted": "2021-04-26T15:25:27.587Z",
"createdByUserId": 24,
"createdByUserName": "Sample Text Data",
"updatedByUserId": 3,
"updatedByUserName": "Sample Text Data",
"effectiveCancel": "2021-04-26T15:25:27.587Z",
"usageNextBill": "2021-04-26T15:25:27.587Z",
"usageFinalBill": "2021-04-26T15:25:27.587Z",
"finalBill": "2021-04-26T15:25:27.587Z",
"lastBilled": "2021-04-26T15:25:27.587Z",
"lastUsageBilled": "2021-04-26T15:25:27.587Z",
"addOnPackageFrequencyId": 7,
"addOnPackageFrequencyName": "Sample Text Data",
"id": "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
}
]
}
}
}
]
}
} | |
| GET | api/v3/Account/Service/{id} |
| Retrieve an instance of the AccountService object by its ID. | |
| {id} | Unique identifier for the AccountService object. |
Retrieve an instance of the AccountService object by its ID. GET api/v3/Account/Service/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"serviceId": 5,
"serviceName": "Sample Text Data",
"accountId": 23,
"accountName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"accountPackageId": "Sample Text Data",
"accountPackageName": "Sample Text Data",
"name": "Sample Text Data",
"usageBillDay": 17,
"amount": 8,
"updated": "2021-04-26T15:25:27.587Z",
"effective": "2021-04-26T15:25:27.587Z",
"posted": "2021-04-26T15:25:27.587Z",
"createdByUserId": 11,
"createdByUserName": "Sample Text Data",
"updatedByUserId": 0,
"updatedByUserName": "Sample Text Data",
"effectiveCancel": "2021-04-26T15:25:27.587Z",
"usageNextBill": "2021-04-26T15:25:27.587Z",
"usageFinalBill": "2021-04-26T15:25:27.587Z",
"finalBill": "2021-04-26T15:25:27.587Z",
"lastBilled": "2021-04-26T15:25:27.587Z",
"lastUsageBilled": "2021-04-26T15:25:27.587Z",
"addOnPackageFrequencyId": 11,
"addOnPackageFrequencyName": "Sample Text Data",
"id": "Sample Text Data"
}
} | |
| GET | api/v3/Account/Service/{id}/Current |
| Returns the most recent status of the AccountService. | |
| {id} | Unique identifier for the AccountService object. |
| GET | api/v3/Account/Service/{id}/Detail |
| Retrieve deep detail of the AccountService 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 AccountService object. |
Retrieve deep detail of the AccountService object by its ID. GET api/v3/Account/Service/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"serviceId": 3,
"serviceName": "Sample Text Data",
"accountId": 27,
"accountName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"accountPackageId": "Sample Text Data",
"accountPackageName": "Sample Text Data",
"name": "Sample Text Data",
"usageBillDay": 15,
"amount": 25,
"updated": "2021-04-26T15:25:27.587Z",
"effective": "2021-04-26T15:25:27.587Z",
"posted": "2021-04-26T15:25:27.587Z",
"createdByUserId": 0,
"createdByUserName": "Sample Text Data",
"updatedByUserId": 3,
"updatedByUserName": "Sample Text Data",
"effectiveCancel": "2021-04-26T15:25:27.587Z",
"usageNextBill": "2021-04-26T15:25:27.587Z",
"usageFinalBill": "2021-04-26T15:25:27.587Z",
"finalBill": "2021-04-26T15:25:27.587Z",
"lastBilled": "2021-04-26T15:25:27.587Z",
"lastUsageBilled": "2021-04-26T15:25:27.587Z",
"addOnPackageFrequencyId": 10,
"addOnPackageFrequencyName": "Sample Text Data",
"id": "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
}
]
}
}
}
} | |
| PATCH | api/v3/Account/Service/{id} |
| Update or Add the AccountService 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 AccountService object. |
Update or Add the AccountService object and optionally make changes to any child objects. PATCH api/v3/Account/Service/{id}
{
"details": {},
"accountServices": {
"items": [
{
"patchType": "create",
"patchClientId": 1,
"serviceId": 5,
"accountId": 25,
"accountPackageId": "Sample Text Data",
"name": "Sample Text Data",
"amount": 0,
"updated": "2021-04-26T15:25:27.587Z",
"effective": "2021-04-26T15:25:27.587Z",
"posted": "2021-04-26T15:25:27.587Z",
"createdByUserId": 3,
"updatedByUserId": 19,
"effectiveCancel": "2021-04-26T15:25:27.587Z",
"addOnPackageFrequencyId": 0,
"id": "Sample Text Data"
}
]
}
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "patch",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"action": "created",
"dtoTypeKey": "accountService",
"instance": {
"identity": 1,
"serviceId": 26,
"serviceName": "Sample Text Data",
"accountId": 1,
"accountName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"accountPackageId": "Sample Text Data",
"accountPackageName": "Sample Text Data",
"name": "Sample Text Data",
"usageBillDay": 8,
"amount": 1,
"updated": "2021-04-26T15:25:27.587Z",
"effective": "2021-04-26T15:25:27.587Z",
"posted": "2021-04-26T15:25:27.587Z",
"createdByUserId": 23,
"createdByUserName": "Sample Text Data",
"updatedByUserId": 16,
"updatedByUserName": "Sample Text Data",
"effectiveCancel": "2021-04-26T15:25:27.587Z",
"usageNextBill": "2021-04-26T15:25:27.587Z",
"usageFinalBill": "2021-04-26T15:25:27.587Z",
"finalBill": "2021-04-26T15:25:27.587Z",
"lastBilled": "2021-04-26T15:25:27.587Z",
"lastUsageBilled": "2021-04-26T15:25:27.587Z",
"addOnPackageFrequencyId": 23,
"addOnPackageFrequencyName": "Sample Text Data",
"id": "Sample Text Data"
}
}
]
}
} | |
| POST | api/v3/Account/Service/ |
| Create a new instance of the AccountService object. | |
Create a new instance of the AccountService object. POST api/v3/Account/Service/
{
"serviceId": 0,
"accountId": 0,
"accountPackageId": "Sample Text Data",
"name": "Sample Text Data",
"amount": 27,
"updated": "2021-04-26T15:25:27.587Z",
"effective": "2021-04-26T15:25:27.587Z",
"posted": "2021-04-26T15:25:27.587Z",
"createdByUserId": 17,
"updatedByUserId": 22,
"effectiveCancel": "2021-04-26T15:25:27.587Z",
"addOnPackageFrequencyId": 21,
"id": "Sample Text Data"
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"serviceId": 22,
"serviceName": "Sample Text Data",
"accountId": 24,
"accountName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"accountPackageId": "Sample Text Data",
"accountPackageName": "Sample Text Data",
"name": "Sample Text Data",
"usageBillDay": 24,
"amount": 10,
"updated": "2021-04-26T15:25:27.587Z",
"effective": "2021-04-26T15:25:27.587Z",
"posted": "2021-04-26T15:25:27.587Z",
"createdByUserId": 9,
"createdByUserName": "Sample Text Data",
"updatedByUserId": 4,
"updatedByUserName": "Sample Text Data",
"effectiveCancel": "2021-04-26T15:25:27.587Z",
"usageNextBill": "2021-04-26T15:25:27.587Z",
"usageFinalBill": "2021-04-26T15:25:27.587Z",
"finalBill": "2021-04-26T15:25:27.587Z",
"lastBilled": "2021-04-26T15:25:27.587Z",
"lastUsageBilled": "2021-04-26T15:25:27.587Z",
"addOnPackageFrequencyId": 9,
"addOnPackageFrequencyName": "Sample Text Data",
"id": "Sample Text Data"
}
]
}
} | |
| PUT | api/v3/Account/Service/{id} |
| Update an existing instance of the AccountService object. | |
Update an existing instance of the AccountService object. PUT api/v3/Account/Service/{id}
{
"identity": 1,
"serviceId": 4,
"accountId": 20,
"accountPackageId": "Sample Text Data",
"name": "Sample Text Data",
"amount": 18,
"updated": "2021-04-26T15:25:27.587Z",
"effective": "2021-04-26T15:25:27.587Z",
"posted": "2021-04-26T15:25:27.587Z",
"createdByUserId": 9,
"updatedByUserId": 5,
"effectiveCancel": "2021-04-26T15:25:27.587Z",
"addOnPackageFrequencyId": 5,
"id": "Sample Text Data"
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"serviceId": 14,
"serviceName": "Sample Text Data",
"accountId": 19,
"accountName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"accountPackageId": "Sample Text Data",
"accountPackageName": "Sample Text Data",
"name": "Sample Text Data",
"usageBillDay": 15,
"amount": 18,
"updated": "2021-04-26T15:25:27.587Z",
"effective": "2021-04-26T15:25:27.587Z",
"posted": "2021-04-26T15:25:27.587Z",
"createdByUserId": 10,
"createdByUserName": "Sample Text Data",
"updatedByUserId": 22,
"updatedByUserName": "Sample Text Data",
"effectiveCancel": "2021-04-26T15:25:27.587Z",
"usageNextBill": "2021-04-26T15:25:27.587Z",
"usageFinalBill": "2021-04-26T15:25:27.587Z",
"finalBill": "2021-04-26T15:25:27.587Z",
"lastBilled": "2021-04-26T15:25:27.587Z",
"lastUsageBilled": "2021-04-26T15:25:27.587Z",
"addOnPackageFrequencyId": 12,
"addOnPackageFrequencyName": "Sample Text Data",
"id": "Sample Text Data"
}
]
}
} | |