TAG LINE
SMALL TITLE

Account / Service

(API Version v4)


An Account Service is a billable line item of a Package that has been assigned to an account.


What can you do with AccountService?


Properties

Property Details
identity
READ-ONLY
"identity": "Hello World"
Type: String
This is the unique numeric identifier for the AccountService
serviceId
"serviceId": 16
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": 7
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": 17
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": 20
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": 27
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": 11
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": 3
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


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 AccountService object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v4/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/v4/Account/Service/{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": "accountService"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v4/Account/Service/
Retrieve all of the AccountService objects.
Retrieve all of the AccountService objects.
GET api/v4/Account/Service/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "serviceId": 4,
            "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": 12,
            "amount": 1,
            "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": 1,
            "addOnPackageFrequencyName": "Sample Text Data",
            "id": "Sample Text Data"
        }
    ]
}
GETapi/v4/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/v4/Account/Service/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,
                "serviceId": 5,
                "serviceName": "Sample Text Data",
                "accountId": 22,
                "accountName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "accountPackageId": "Sample Text Data",
                "accountPackageName": "Sample Text Data",
                "name": "Sample Text Data",
                "usageBillDay": 9,
                "amount": 13,
                "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": 13,
                "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": 5,
                "addOnPackageFrequencyName": "Sample Text Data",
                "id": "Sample Text Data"
            }
        ]
    }
}
GETapi/v4/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/v4/Account/Service/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,
                "serviceId": 1,
                "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": 20,
                "amount": 13,
                "updated": "2021-04-26T15:25:27.587Z",
                "effective": "2021-04-26T15:25:27.587Z",
                "posted": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 3,
                "createdByUserName": "Sample Text Data",
                "updatedByUserId": 18,
                "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": 16,
                "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
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETapi/v4/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/v4/Account/Service/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "serviceId": 25,
        "serviceName": "Sample Text Data",
        "accountId": 6,
        "accountName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "accountPackageId": "Sample Text Data",
        "accountPackageName": "Sample Text Data",
        "name": "Sample Text Data",
        "usageBillDay": 9,
        "amount": 4,
        "updated": "2021-04-26T15:25:27.587Z",
        "effective": "2021-04-26T15:25:27.587Z",
        "posted": "2021-04-26T15:25:27.587Z",
        "createdByUserId": 18,
        "createdByUserName": "Sample Text Data",
        "updatedByUserId": 11,
        "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": 0,
        "addOnPackageFrequencyName": "Sample Text Data",
        "id": "Sample Text Data"
    }
}
GETapi/v4/Account/Service/{id}/Current
Returns the most recent status of the AccountService.
{id}Unique identifier for the AccountService object.
GETapi/v4/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/v4/Account/Service/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "serviceId": 3,
        "serviceName": "Sample Text Data",
        "accountId": 25,
        "accountName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "accountPackageId": "Sample Text Data",
        "accountPackageName": "Sample Text Data",
        "name": "Sample Text Data",
        "usageBillDay": 23,
        "amount": 9,
        "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": 25,
        "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": 18,
        "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
                    }
                ]
            }
        }
    }
}
PATCHapi/v4/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/v4/Account/Service/{id}

{
    "details": {},
    "accountServices": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "serviceId": 13,
                "accountId": 4,
                "accountPackageId": "Sample Text Data",
                "name": "Sample Text Data",
                "amount": 17,
                "updated": "2021-04-26T15:25:27.587Z",
                "effective": "2021-04-26T15:25:27.587Z",
                "posted": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 23,
                "updatedByUserId": 0,
                "effectiveCancel": "2021-04-26T15:25:27.587Z",
                "addOnPackageFrequencyId": 17,
                "id": "Sample Text Data"
            }
        ]
    }
}
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": "accountService",
                "instance": {
                    "identity": 1,
                    "serviceId": 24,
                    "serviceName": "Sample Text Data",
                    "accountId": 14,
                    "accountName": "Sample Text Data",
                    "created": "2021-04-26T15:25:27.587Z",
                    "accountPackageId": "Sample Text Data",
                    "accountPackageName": "Sample Text Data",
                    "name": "Sample Text Data",
                    "usageBillDay": 3,
                    "amount": 14,
                    "updated": "2021-04-26T15:25:27.587Z",
                    "effective": "2021-04-26T15:25:27.587Z",
                    "posted": "2021-04-26T15:25:27.587Z",
                    "createdByUserId": 2,
                    "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": 3,
                    "addOnPackageFrequencyName": "Sample Text Data",
                    "id": "Sample Text Data"
                }
            }
        ]
    }
}
POSTapi/v4/Account/Service/
Create a new instance of the AccountService object.
Create a new instance of the AccountService object.
POST api/v4/Account/Service/

{
    "serviceId": 10,
    "accountId": 27,
    "accountPackageId": "Sample Text Data",
    "name": "Sample Text Data",
    "amount": 3,
    "updated": "2021-04-26T15:25:27.587Z",
    "effective": "2021-04-26T15:25:27.587Z",
    "posted": "2021-04-26T15:25:27.587Z",
    "createdByUserId": 0,
    "updatedByUserId": 20,
    "effectiveCancel": "2021-04-26T15:25:27.587Z",
    "addOnPackageFrequencyId": 17,
    "id": "Sample Text Data"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "serviceId": 15,
                "serviceName": "Sample Text Data",
                "accountId": 3,
                "accountName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "accountPackageId": "Sample Text Data",
                "accountPackageName": "Sample Text Data",
                "name": "Sample Text Data",
                "usageBillDay": 12,
                "amount": 9,
                "updated": "2021-04-26T15:25:27.587Z",
                "effective": "2021-04-26T15:25:27.587Z",
                "posted": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 19,
                "createdByUserName": "Sample Text Data",
                "updatedByUserId": 19,
                "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": 16,
                "addOnPackageFrequencyName": "Sample Text Data",
                "id": "Sample Text Data"
            }
        ]
    }
}
POSTapi/v4/Account/Service/Search
Retreive a list of AccountService objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of AccountService objects based on search criteria.
POST api/v4/Account/Service/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 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",
            "usageBillDay": 18,
            "amount": 27,
            "updated": "2021-04-26T15:25:27.587Z",
            "effective": "2021-04-26T15:25:27.587Z",
            "posted": "2021-04-26T15:25:27.587Z",
            "createdByUserId": 16,
            "createdByUserName": "Sample Text Data",
            "updatedByUserId": 8,
            "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": 2,
            "addOnPackageFrequencyName": "Sample Text Data",
            "id": "Sample Text Data"
        }
    ]
}
PUTapi/v4/Account/Service/{id}
Update an existing instance of the AccountService object.
Update an existing instance of the AccountService object.
PUT api/v4/Account/Service/{id}

{
    "identity": 1,
    "serviceId": 14,
    "accountId": 4,
    "accountPackageId": "Sample Text Data",
    "name": "Sample Text Data",
    "amount": 12,
    "updated": "2021-04-26T15:25:27.587Z",
    "effective": "2021-04-26T15:25:27.587Z",
    "posted": "2021-04-26T15:25:27.587Z",
    "createdByUserId": 23,
    "updatedByUserId": 18,
    "effectiveCancel": "2021-04-26T15:25:27.587Z",
    "addOnPackageFrequencyId": 10,
    "id": "Sample Text Data"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "serviceId": 11,
                "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": 24,
                "amount": 6,
                "updated": "2021-04-26T15:25:27.587Z",
                "effective": "2021-04-26T15:25:27.587Z",
                "posted": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 25,
                "createdByUserName": "Sample Text Data",
                "updatedByUserId": 13,
                "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": 26,
                "addOnPackageFrequencyName": "Sample Text Data",
                "id": "Sample Text Data"
            }
        ]
    }
}