TAG LINE
SMALL TITLE

Account / Package

(API Version v4)


What can you do with ViewAccountPackage?


Properties

Property Details
id
"id": "Hello World"
Type: String
accountId
"accountId": 2
Type: Number
accountName
"accountName": "Hello World"
Type: String
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.
nextBill
"nextBill": "2021-04-26T15:25:27.587Z"
Type: Date
Date and time values are specified in the ISO 8601 format.
name
"name": "Hello World"
Type: String
lastStatusChanged
"lastStatusChanged": "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.
updated
"updated": "2021-04-26T15:25:27.587Z"
Type: Date
Date and time values are specified in the ISO 8601 format.
effectiveCancel
"effectiveCancel": "2021-04-26T15:25:27.587Z"
Type: Date
Date and time values are specified in the ISO 8601 format.
inheritedEffectiveCancel
"inheritedEffectiveCancel": "2021-04-26T15:25:27.587Z"
Type: Date
Date and time values are specified in the ISO 8601 format.
packageFrequencyId
"packageFrequencyId": 9
Type: Number
packageFrequencyName
"packageFrequencyName": "Hello World"
Type: String
termId
"termId": 23
Type: Number
termName
"termName": "Hello World"
Type: String
createdByUserId
"createdByUserId": 0
Type: Number
createdByUserName
"createdByUserName": "Hello World"
Type: String
billDay
"billDay": 11
Type: Number
inheritedBillDay
"inheritedBillDay": 11
Type: Number
updatedByUserId
"updatedByUserId": 7
Type: Number
updatedByUserName
"updatedByUserName": "Hello World"
Type: String
usageBillDay
"usageBillDay": 4
Type: Number
inheritedUsageBillDay
"inheritedUsageBillDay": 1
Type: Number
activation
"activation": "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.
accountSharePlanId
"accountSharePlanId": 10
Type: Number
lastUsageBilled
"lastUsageBilled": "2021-04-26T15:25:27.587Z"
Type: Date
Date and time values are specified in the ISO 8601 format.
accountProductCodeId
"accountProductCodeId": 11
Type: Number
accountProductCodeName
"accountProductCodeName": "Hello World"
Type: String
packageCategoryId
"packageCategoryId": 20
Type: Number
packageCategoryName
"packageCategoryName": "Hello World"
Type: String
accountEffectiveCancel
"accountEffectiveCancel": "2021-04-26T15:25:27.587Z"
Type: Date
Date and time values are specified in the ISO 8601 format.
accountInvoicerAccountId
"accountInvoicerAccountId": 24
Type: Number
accountInvoicerName
"accountInvoicerName": "Hello World"
Type: String
accountUsageInvoicerAccountId
"accountUsageInvoicerAccountId": 4
Type: Number
accountUsageInvoicerName
"accountUsageInvoicerName": "Hello World"
Type: String
accountTaxSettingAccountId
"accountTaxSettingAccountId": 7
Type: Number
accountTaxSettingName
"accountTaxSettingName": "Hello World"
Type: String
packageId
"packageId": 9
Type: Number
packageName
"packageName": "Hello World"
Type: String
packageFrequencyFrequency
"packageFrequencyFrequency": 21
Type: Number
packageFrequencyIsActive
"packageFrequencyIsActive": true
Type: Boolean
frequencyTypeId
"frequencyTypeId": 16
Type: Number
frequencyTypeName
"frequencyTypeName": "Hello World"
Type: String
billGroupId
"billGroupId": 26
Type: Number
billGroupName
"billGroupName": "Hello World"
Type: String
postPaid
"postPaid": true
Type: Boolean


End Points

GETapi/v4/Account/Package/View/
Retrieve all of the ViewAccountPackage objects.
Retrieve all of the ViewAccountPackage objects.
GET api/v4/Account/Package/View/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "id": "Sample Text Data",
            "accountId": 23,
            "accountName": "Sample Text Data",
            "created": "2021-04-26T15:25:27.587Z",
            "nextBill": "2021-04-26T15:25:27.587Z",
            "name": "Sample Text Data",
            "lastStatusChanged": "2021-04-26T15:25:27.587Z",
            "effective": "2021-04-26T15:25:27.587Z",
            "updated": "2021-04-26T15:25:27.587Z",
            "effectiveCancel": "2021-04-26T15:25:27.587Z",
            "inheritedEffectiveCancel": "2021-04-26T15:25:27.587Z",
            "packageFrequencyId": 26,
            "packageFrequencyName": "Sample Text Data",
            "termId": 22,
            "termName": "Sample Text Data",
            "createdByUserId": 15,
            "createdByUserName": "Sample Text Data",
            "billDay": 15,
            "inheritedBillDay": 24,
            "updatedByUserId": 27,
            "updatedByUserName": "Sample Text Data",
            "usageBillDay": 22,
            "inheritedUsageBillDay": 25,
            "activation": "2021-04-26T15:25:27.587Z",
            "finalBill": "2021-04-26T15:25:27.587Z",
            "lastBilled": "2021-04-26T15:25:27.587Z",
            "accountSharePlanId": 7,
            "lastUsageBilled": "2021-04-26T15:25:27.587Z",
            "accountProductCodeId": 26,
            "accountProductCodeName": "Sample Text Data",
            "packageCategoryId": 8,
            "packageCategoryName": "Sample Text Data",
            "accountEffectiveCancel": "2021-04-26T15:25:27.587Z",
            "accountInvoicerAccountId": 4,
            "accountInvoicerName": "Sample Text Data",
            "accountUsageInvoicerAccountId": 25,
            "accountUsageInvoicerName": "Sample Text Data",
            "accountTaxSettingAccountId": 5,
            "accountTaxSettingName": "Sample Text Data",
            "packageId": 10,
            "packageName": "Sample Text Data",
            "packageFrequencyFrequency": 19,
            "packageFrequencyIsActive": true,
            "frequencyTypeId": 9,
            "frequencyTypeName": "Sample Text Data",
            "billGroupId": 2,
            "billGroupName": "Sample Text Data",
            "postPaid": true
        }
    ]
}
GETapi/v4/Account/Package/View/Paged
Retrieve all of the ViewAccountPackage 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 ViewAccountPackage objects in a paged fashion.
GET api/v4/Account/Package/View/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": [
            {
                "id": "Sample Text Data",
                "accountId": 20,
                "accountName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "nextBill": "2021-04-26T15:25:27.587Z",
                "name": "Sample Text Data",
                "lastStatusChanged": "2021-04-26T15:25:27.587Z",
                "effective": "2021-04-26T15:25:27.587Z",
                "updated": "2021-04-26T15:25:27.587Z",
                "effectiveCancel": "2021-04-26T15:25:27.587Z",
                "inheritedEffectiveCancel": "2021-04-26T15:25:27.587Z",
                "packageFrequencyId": 4,
                "packageFrequencyName": "Sample Text Data",
                "termId": 3,
                "termName": "Sample Text Data",
                "createdByUserId": 19,
                "createdByUserName": "Sample Text Data",
                "billDay": 1,
                "inheritedBillDay": 24,
                "updatedByUserId": 10,
                "updatedByUserName": "Sample Text Data",
                "usageBillDay": 26,
                "inheritedUsageBillDay": 12,
                "activation": "2021-04-26T15:25:27.587Z",
                "finalBill": "2021-04-26T15:25:27.587Z",
                "lastBilled": "2021-04-26T15:25:27.587Z",
                "accountSharePlanId": 13,
                "lastUsageBilled": "2021-04-26T15:25:27.587Z",
                "accountProductCodeId": 16,
                "accountProductCodeName": "Sample Text Data",
                "packageCategoryId": 23,
                "packageCategoryName": "Sample Text Data",
                "accountEffectiveCancel": "2021-04-26T15:25:27.587Z",
                "accountInvoicerAccountId": 7,
                "accountInvoicerName": "Sample Text Data",
                "accountUsageInvoicerAccountId": 18,
                "accountUsageInvoicerName": "Sample Text Data",
                "accountTaxSettingAccountId": 8,
                "accountTaxSettingName": "Sample Text Data",
                "packageId": 14,
                "packageName": "Sample Text Data",
                "packageFrequencyFrequency": 18,
                "packageFrequencyIsActive": true,
                "frequencyTypeId": 8,
                "frequencyTypeName": "Sample Text Data",
                "billGroupId": 10,
                "billGroupName": "Sample Text Data",
                "postPaid": true
            }
        ]
    }
}
GETapi/v4/Account/Package/View/{id}
Retrieve an instance of the ViewAccountPackage object by its ID.
{id}Unique identifier for the ViewAccountPackage object.
Retrieve an instance of the ViewAccountPackage object by its ID.
GET api/v4/Account/Package/View/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "id": "Sample Text Data",
        "accountId": 1,
        "accountName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "nextBill": "2021-04-26T15:25:27.587Z",
        "name": "Sample Text Data",
        "lastStatusChanged": "2021-04-26T15:25:27.587Z",
        "effective": "2021-04-26T15:25:27.587Z",
        "updated": "2021-04-26T15:25:27.587Z",
        "effectiveCancel": "2021-04-26T15:25:27.587Z",
        "inheritedEffectiveCancel": "2021-04-26T15:25:27.587Z",
        "packageFrequencyId": 5,
        "packageFrequencyName": "Sample Text Data",
        "termId": 6,
        "termName": "Sample Text Data",
        "createdByUserId": 25,
        "createdByUserName": "Sample Text Data",
        "billDay": 4,
        "inheritedBillDay": 7,
        "updatedByUserId": 21,
        "updatedByUserName": "Sample Text Data",
        "usageBillDay": 20,
        "inheritedUsageBillDay": 25,
        "activation": "2021-04-26T15:25:27.587Z",
        "finalBill": "2021-04-26T15:25:27.587Z",
        "lastBilled": "2021-04-26T15:25:27.587Z",
        "accountSharePlanId": 26,
        "lastUsageBilled": "2021-04-26T15:25:27.587Z",
        "accountProductCodeId": 1,
        "accountProductCodeName": "Sample Text Data",
        "packageCategoryId": 4,
        "packageCategoryName": "Sample Text Data",
        "accountEffectiveCancel": "2021-04-26T15:25:27.587Z",
        "accountInvoicerAccountId": 7,
        "accountInvoicerName": "Sample Text Data",
        "accountUsageInvoicerAccountId": 5,
        "accountUsageInvoicerName": "Sample Text Data",
        "accountTaxSettingAccountId": 13,
        "accountTaxSettingName": "Sample Text Data",
        "packageId": 13,
        "packageName": "Sample Text Data",
        "packageFrequencyFrequency": 4,
        "packageFrequencyIsActive": true,
        "frequencyTypeId": 14,
        "frequencyTypeName": "Sample Text Data",
        "billGroupId": 11,
        "billGroupName": "Sample Text Data",
        "postPaid": true
    }
}
POSTapi/v4/Account/Package/View/Search
Retreive a list of ViewAccountPackage 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 ViewAccountPackage objects based on search criteria.
POST api/v4/Account/Package/View/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": [
        {
            "id": "Sample Text Data",
            "accountId": 6,
            "accountName": "Sample Text Data",
            "created": "2021-04-26T15:25:27.587Z",
            "nextBill": "2021-04-26T15:25:27.587Z",
            "name": "Sample Text Data",
            "lastStatusChanged": "2021-04-26T15:25:27.587Z",
            "effective": "2021-04-26T15:25:27.587Z",
            "updated": "2021-04-26T15:25:27.587Z",
            "effectiveCancel": "2021-04-26T15:25:27.587Z",
            "inheritedEffectiveCancel": "2021-04-26T15:25:27.587Z",
            "packageFrequencyId": 25,
            "packageFrequencyName": "Sample Text Data",
            "termId": 8,
            "termName": "Sample Text Data",
            "createdByUserId": 4,
            "createdByUserName": "Sample Text Data",
            "billDay": 4,
            "inheritedBillDay": 14,
            "updatedByUserId": 15,
            "updatedByUserName": "Sample Text Data",
            "usageBillDay": 17,
            "inheritedUsageBillDay": 21,
            "activation": "2021-04-26T15:25:27.587Z",
            "finalBill": "2021-04-26T15:25:27.587Z",
            "lastBilled": "2021-04-26T15:25:27.587Z",
            "accountSharePlanId": 15,
            "lastUsageBilled": "2021-04-26T15:25:27.587Z",
            "accountProductCodeId": 0,
            "accountProductCodeName": "Sample Text Data",
            "packageCategoryId": 25,
            "packageCategoryName": "Sample Text Data",
            "accountEffectiveCancel": "2021-04-26T15:25:27.587Z",
            "accountInvoicerAccountId": 8,
            "accountInvoicerName": "Sample Text Data",
            "accountUsageInvoicerAccountId": 18,
            "accountUsageInvoicerName": "Sample Text Data",
            "accountTaxSettingAccountId": 22,
            "accountTaxSettingName": "Sample Text Data",
            "packageId": 27,
            "packageName": "Sample Text Data",
            "packageFrequencyFrequency": 13,
            "packageFrequencyIsActive": true,
            "frequencyTypeId": 16,
            "frequencyTypeName": "Sample Text Data",
            "billGroupId": 14,
            "billGroupName": "Sample Text Data",
            "postPaid": true
        }
    ]
}