TAG LINE
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": 26 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": 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. |
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. |
amount | "amount": 17 Type: Number The quantity of this service within its associated package. |
updated READ-ONLY | "updated": "2021-04-26T15:25:27.587Z" Type: Date The date time stamp when this record was updated. 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": 10 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": 21 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 | "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 | "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 | "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 | "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 | "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": 18 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. |
billCancelOptionTypeId | "billCancelOptionTypeId": 23 Type: Number Unique identifier for the associated BillCancelOptionType object. |
billCancelOptionTypeName | "billCancelOptionTypeName": "Sample Name" Type: String The name of the object associated with the billCancelOptionTypeId property. |
isTaxInclusive | "isTaxInclusive": true Type: Boolean Determines if the account service is tax inclusive or not. |
serviceTaxCategoryId | "serviceTaxCategoryId": 5 Type: Number Unique identifier for the associated ServiceTaxCategory object. |
serviceTaxCategoryName | "serviceTaxCategoryName": "Sample Name" Type: String The name of the object associated with the serviceTaxCategoryId property. |
importLastUsageBilled | "importLastUsageBilled": "2021-04-26T15:25:27.587Z" Type: Date The date the account service was imported on. Date and time values are specified in the ISO 8601 format. |
id | "id": "Hello World" Type: String |
| GET | Account/Service/Current/ |
| Retrieve all of the AccountService objects. | |
Retrieve all of the AccountService objects. GET Account/Service/Current/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"serviceId": 17,
"serviceName": "Sample Text Data",
"accountId": 20,
"accountName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"accountPackageId": "Sample Text Data",
"accountPackageName": "Sample Text Data",
"name": "Sample Text Data",
"amount": 6,
"updated": "2021-04-26T15:25:27.587Z",
"effective": "2021-04-26T15:25:27.587Z",
"posted": "2021-04-26T15:25:27.587Z",
"createdByUserId": 26,
"createdByUserName": "Sample Text Data",
"updatedByUserId": 12,
"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": 19,
"addOnPackageFrequencyName": "Sample Text Data",
"billCancelOptionTypeId": 17,
"billCancelOptionTypeName": "Sample Text Data",
"isTaxInclusive": true,
"serviceTaxCategoryId": 11,
"serviceTaxCategoryName": "Sample Text Data",
"importLastUsageBilled": "2021-04-26T15:25:27.587Z",
"id": "Sample Text Data"
}
]
} | |
| GET | Account/Service/Current/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 Account/Service/Current/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": 24,
"serviceName": "Sample Text Data",
"accountId": 15,
"accountName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"accountPackageId": "Sample Text Data",
"accountPackageName": "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": 21,
"createdByUserName": "Sample Text Data",
"updatedByUserId": 14,
"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": 4,
"addOnPackageFrequencyName": "Sample Text Data",
"billCancelOptionTypeId": 14,
"billCancelOptionTypeName": "Sample Text Data",
"isTaxInclusive": true,
"serviceTaxCategoryId": 9,
"serviceTaxCategoryName": "Sample Text Data",
"importLastUsageBilled": "2021-04-26T15:25:27.587Z",
"id": "Sample Text Data"
}
]
}
} | |
| GET | Account/Service/Current/{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 Account/Service/Current/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"serviceId": 3,
"serviceName": "Sample Text Data",
"accountId": 16,
"accountName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"accountPackageId": "Sample Text Data",
"accountPackageName": "Sample Text Data",
"name": "Sample Text Data",
"amount": 21,
"updated": "2021-04-26T15:25:27.587Z",
"effective": "2021-04-26T15:25:27.587Z",
"posted": "2021-04-26T15:25:27.587Z",
"createdByUserId": 21,
"createdByUserName": "Sample Text Data",
"updatedByUserId": 20,
"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": 15,
"addOnPackageFrequencyName": "Sample Text Data",
"billCancelOptionTypeId": 20,
"billCancelOptionTypeName": "Sample Text Data",
"isTaxInclusive": true,
"serviceTaxCategoryId": 13,
"serviceTaxCategoryName": "Sample Text Data",
"importLastUsageBilled": "2021-04-26T15:25:27.587Z",
"id": "Sample Text Data"
}
} | |