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