TAG LINE
TAG LINE
SMALL TITLE
id | "id": "Hello World" Type: String |
accountId | "accountId": 1 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": 11 Type: Number |
packageFrequencyName | "packageFrequencyName": "Hello World" Type: String |
termId | "termId": 26 Type: Number |
termName | "termName": "Hello World" Type: String |
createdByUserId | "createdByUserId": 1 Type: Number |
createdByUserName | "createdByUserName": "Hello World" Type: String |
billDay | "billDay": 23 Type: Number |
inheritedBillDay | "inheritedBillDay": 18 Type: Number |
updatedByUserId | "updatedByUserId": 20 Type: Number |
updatedByUserName | "updatedByUserName": "Hello World" Type: String |
usageBillDay | "usageBillDay": 15 Type: Number |
inheritedUsageBillDay | "inheritedUsageBillDay": 4 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": 16 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": 25 Type: Number |
accountProductCodeName | "accountProductCodeName": "Hello World" Type: String |
packageCategoryId | "packageCategoryId": 21 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": 18 Type: Number |
accountUsageInvoicerName | "accountUsageInvoicerName": "Hello World" Type: String |
accountTaxSettingAccountId | "accountTaxSettingAccountId": 24 Type: Number |
accountTaxSettingName | "accountTaxSettingName": "Hello World" Type: String |
packageId | "packageId": 19 Type: Number |
packageName | "packageName": "Hello World" Type: String |
packageFrequencyFrequency | "packageFrequencyFrequency": 13 Type: Number |
packageFrequencyIsActive | "packageFrequencyIsActive": true Type: Boolean |
frequencyTypeId | "frequencyTypeId": 18 Type: Number |
frequencyTypeName | "frequencyTypeName": "Hello World" Type: String |
billGroupId | "billGroupId": 11 Type: Number |
billGroupName | "billGroupName": "Hello World" Type: String |
postPaid | "postPaid": true Type: Boolean |
billingActivationTypeId | "billingActivationTypeId": 22 Type: Number |
| GET | api/v5/Account/Package/View/ |
| Retrieve all of the ViewAccountPackage objects. | |
Retrieve all of the ViewAccountPackage objects. GET api/v5/Account/Package/View/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"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": 1,
"packageFrequencyName": "Sample Text Data",
"termId": 24,
"termName": "Sample Text Data",
"createdByUserId": 22,
"createdByUserName": "Sample Text Data",
"billDay": 19,
"inheritedBillDay": 1,
"updatedByUserId": 14,
"updatedByUserName": "Sample Text Data",
"usageBillDay": 20,
"inheritedUsageBillDay": 17,
"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": 2,
"accountProductCodeName": "Sample Text Data",
"packageCategoryId": 14,
"packageCategoryName": "Sample Text Data",
"accountEffectiveCancel": "2021-04-26T15:25:27.587Z",
"accountInvoicerAccountId": 2,
"accountInvoicerName": "Sample Text Data",
"accountUsageInvoicerAccountId": 15,
"accountUsageInvoicerName": "Sample Text Data",
"accountTaxSettingAccountId": 4,
"accountTaxSettingName": "Sample Text Data",
"packageId": 12,
"packageName": "Sample Text Data",
"packageFrequencyFrequency": 7,
"packageFrequencyIsActive": true,
"frequencyTypeId": 7,
"frequencyTypeName": "Sample Text Data",
"billGroupId": 6,
"billGroupName": "Sample Text Data",
"postPaid": true,
"billingActivationTypeId": 6
}
]
} | |
| GET | api/v5/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/v5/Account/Package/View/Paged 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": 27,
"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": 16,
"packageFrequencyName": "Sample Text Data",
"termId": 7,
"termName": "Sample Text Data",
"createdByUserId": 17,
"createdByUserName": "Sample Text Data",
"billDay": 22,
"inheritedBillDay": 19,
"updatedByUserId": 6,
"updatedByUserName": "Sample Text Data",
"usageBillDay": 12,
"inheritedUsageBillDay": 0,
"activation": "2021-04-26T15:25:27.587Z",
"finalBill": "2021-04-26T15:25:27.587Z",
"lastBilled": "2021-04-26T15:25:27.587Z",
"accountSharePlanId": 16,
"lastUsageBilled": "2021-04-26T15:25:27.587Z",
"accountProductCodeId": 9,
"accountProductCodeName": "Sample Text Data",
"packageCategoryId": 22,
"packageCategoryName": "Sample Text Data",
"accountEffectiveCancel": "2021-04-26T15:25:27.587Z",
"accountInvoicerAccountId": 5,
"accountInvoicerName": "Sample Text Data",
"accountUsageInvoicerAccountId": 0,
"accountUsageInvoicerName": "Sample Text Data",
"accountTaxSettingAccountId": 2,
"accountTaxSettingName": "Sample Text Data",
"packageId": 11,
"packageName": "Sample Text Data",
"packageFrequencyFrequency": 20,
"packageFrequencyIsActive": true,
"frequencyTypeId": 4,
"frequencyTypeName": "Sample Text Data",
"billGroupId": 2,
"billGroupName": "Sample Text Data",
"postPaid": true,
"billingActivationTypeId": 22
}
]
}
} | |
| GET | api/v5/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/v5/Account/Package/View/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"id": "Sample Text Data",
"accountId": 17,
"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": 2,
"packageFrequencyName": "Sample Text Data",
"termId": 22,
"termName": "Sample Text Data",
"createdByUserId": 20,
"createdByUserName": "Sample Text Data",
"billDay": 1,
"inheritedBillDay": 22,
"updatedByUserId": 1,
"updatedByUserName": "Sample Text Data",
"usageBillDay": 21,
"inheritedUsageBillDay": 26,
"activation": "2021-04-26T15:25:27.587Z",
"finalBill": "2021-04-26T15:25:27.587Z",
"lastBilled": "2021-04-26T15:25:27.587Z",
"accountSharePlanId": 22,
"lastUsageBilled": "2021-04-26T15:25:27.587Z",
"accountProductCodeId": 14,
"accountProductCodeName": "Sample Text Data",
"packageCategoryId": 5,
"packageCategoryName": "Sample Text Data",
"accountEffectiveCancel": "2021-04-26T15:25:27.587Z",
"accountInvoicerAccountId": 19,
"accountInvoicerName": "Sample Text Data",
"accountUsageInvoicerAccountId": 26,
"accountUsageInvoicerName": "Sample Text Data",
"accountTaxSettingAccountId": 1,
"accountTaxSettingName": "Sample Text Data",
"packageId": 21,
"packageName": "Sample Text Data",
"packageFrequencyFrequency": 18,
"packageFrequencyIsActive": true,
"frequencyTypeId": 22,
"frequencyTypeName": "Sample Text Data",
"billGroupId": 27,
"billGroupName": "Sample Text Data",
"postPaid": true,
"billingActivationTypeId": 7
}
} | |