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