TAG LINE
SMALL TITLE

Account / Service / Current

(API Version v4)


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": 5
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": 17
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
usageBillDay
"usageBillDay": 0
Type: Number
amount
"amount": 16
Type: Number
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
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": 15
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": 0
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
Date and time values are specified in the ISO 8601 format.
usageNextBill
"usageNextBill": "2021-04-26T15:25:27.587Z"
Type: Date
Date and time values are specified in the ISO 8601 format.
usageFinalBill
"usageFinalBill": "2021-04-26T15:25:27.587Z"
Type: Date
Date and time values are specified in the ISO 8601 format.
finalBill
"finalBill": "2021-04-26T15:25:27.587Z"
Type: Date
Date and time values are specified in the ISO 8601 format.
lastBilled
"lastBilled": "2021-04-26T15:25:27.587Z"
Type: Date
Date and time values are specified in the ISO 8601 format.
lastUsageBilled
"lastUsageBilled": "2021-04-26T15:25:27.587Z"
Type: Date
Date and time values are specified in the ISO 8601 format.
addOnPackageFrequencyId
"addOnPackageFrequencyId": 6
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


End Points

GETapi/v4/Account/Service/Current/
Retrieve all of the AccountService objects.
Retrieve all of the AccountService objects.
GET api/v4/Account/Service/Current/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "serviceId": 19,
            "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": 27,
            "amount": 20,
            "updated": "2021-04-26T15:25:27.587Z",
            "effective": "2021-04-26T15:25:27.587Z",
            "posted": "2021-04-26T15:25:27.587Z",
            "createdByUserId": 5,
            "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": 21,
            "addOnPackageFrequencyName": "Sample Text Data",
            "id": "Sample Text Data"
        }
    ]
}
GETapi/v4/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 api/v4/Account/Service/Current/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": 3,
                "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": 14,
                "amount": 27,
                "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": 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": 6,
                "addOnPackageFrequencyName": "Sample Text Data",
                "id": "Sample Text Data"
            }
        ]
    }
}
GETapi/v4/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 api/v4/Account/Service/Current/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "serviceId": 17,
        "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": 13,
        "amount": 8,
        "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": 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": 11,
        "addOnPackageFrequencyName": "Sample Text Data",
        "id": "Sample Text Data"
    }
}
POSTapi/v4/Account/Service/Current/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/Current/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": 27,
            "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": 5,
            "amount": 17,
            "updated": "2021-04-26T15:25:27.587Z",
            "effective": "2021-04-26T15:25:27.587Z",
            "posted": "2021-04-26T15:25:27.587Z",
            "createdByUserId": 27,
            "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": 19,
            "addOnPackageFrequencyName": "Sample Text Data",
            "id": "Sample Text Data"
        }
    ]
}