TAG LINE
TAG LINE
SMALL TITLE
This object contains all the information associated with a Package that has been assigned to an Account.
identity READ-ONLY | "identity": "Hello World" Type: String This is the unique numeric identifier for the AccountPackage |
accountId | "accountId": 20 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. |
nextBill READ-ONLY | "nextBill": "2021-04-26T15:25:27.587Z" Type: Date The date in which this account will be billed next. Date and time values are specified in the ISO 8601 format. |
name | "name": "Hello World" Type: String The name of the Account Package. |
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 The start date on when this Account Package is to have its charge calculated. 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 The date in which this Account Package should be cancelled. Date and time values are specified in the ISO 8601 format. |
packageFrequencyId | "packageFrequencyId": 23 Type: Number Unique identifier for the associated PackageFrequency object. |
packageFrequencyName | "packageFrequencyName": "Sample Name" Type: String The name of the object associated with the packageFrequencyId property. |
termId | "termId": 10 Type: Number Unique identifier for the associated Term object. |
termName | "termName": "Sample Name" Type: String The name of the object associated with the termId property. |
createdByUserId READ-ONLY | "createdByUserId": 19 Type: Number Unique identifier for the associated User object. |
createdByUserName READ-ONLY | "createdByUserName": "Sample Name" Type: String The name of the object associated with the createdByUserId property. |
billDay | "billDay": 7 Type: Number If this Account Package is to be billed on a different day than the account's bill day. |
updatedByUserId READ-ONLY | "updatedByUserId": 7 Type: Number Unique identifier for the associated User object. |
updatedByUserName READ-ONLY | "updatedByUserName": "Sample Name" Type: String The name of the object associated with the updatedByUserId property. |
usageBillDay | "usageBillDay": 7 Type: Number If this Account Package is to have it's usage billed on a different day than the account's usage bill day. |
activation | "activation": "2021-04-26T15:25:27.587Z" Type: Date Date and time values are specified in the ISO 8601 format. |
finalBill READ-ONLY | "finalBill": "2021-04-26T15:25:27.587Z" Type: Date The date when this Account Package had it's final bill generated. Applies to Account Packages that have been cancelled. Date and time values are specified in the ISO 8601 format. |
lastBilled READ-ONLY | "lastBilled": "2021-04-26T15:25:27.587Z" Type: Date The date when this Account Package was last billed. Date and time values are specified in the ISO 8601 format. |
accountSharePlanId | "accountSharePlanId": 8 Type: Number Unique identifier for the associated AccountSharePlan object. |
accountSharePlanName | "accountSharePlanName": "Sample Name" Type: String The name of the object associated with the accountSharePlanId property. |
lastUsageBilled READ-ONLY | "lastUsageBilled": "2021-04-26T15:25:27.587Z" Type: Date The date when this Account Package's usage was last billed. Date and time values are specified in the ISO 8601 format. |
accountProductCodeId | "accountProductCodeId": 0 Type: Number Unique identifier for the associated AccountProductCode object. |
accountProductCodeName | "accountProductCodeName": "Sample Name" Type: String The name of the object associated with the accountProductCodeId property. |
packageCategoryId | "packageCategoryId": 19 Type: Number Unique identifier for the associated PackageCategory object. |
packageCategoryName | "packageCategoryName": "Sample Name" Type: String The name of the object associated with the packageCategoryId property. |
chargeRecurringIfUsage READ-ONLY | "chargeRecurringIfUsage": true Type: Boolean This is an inherited field from the Package that has been added to the account. |
updatedByPortalUserId READ-ONLY | "updatedByPortalUserId": 24 Type: Number If this Account Package has been updated by the end customer in the LogiSense customer portal, then this ID represents that User. Unique identifier for the associated PortalUser object. |
updatedByPortalUserName READ-ONLY | "updatedByPortalUserName": "Sample Name" Type: String The name of the object associated with the updatedByPortalUserId property. |
pendingBillDay | "pendingBillDay": 26 Type: Number |
pendingUsageBillDay | "pendingUsageBillDay": 15 Type: Number |
billCancelOptionTypeId | "billCancelOptionTypeId": 15 Type: Number Unique identifier for the associated BillCancelOptionType object. |
billCancelOptionTypeName | "billCancelOptionTypeName": "Sample Name" Type: String The name of the object associated with the billCancelOptionTypeId property. |
waiveEarlyTerminationFee | "waiveEarlyTerminationFee": true Type: Boolean |
billingActivationTypeId | "billingActivationTypeId": 13 Type: Number Unique identifier for the associated BillingActivationType object. |
billingActivationTypeName | "billingActivationTypeName": "Sample Name" Type: String The name of the object associated with the billingActivationTypeId property. |
quantity | "quantity": 15 Type: Number |
isQuantityAllowed | "isQuantityAllowed": true Type: Boolean |
importLastBilled | "importLastBilled": "2021-04-26T15:25:27.587Z" Type: Date Date and time values are specified in the ISO 8601 format. |
priceBookId | "priceBookId": 24 Type: Number Unique identifier for the associated PriceBook object. |
priceBookName | "priceBookName": "Sample Name" Type: String The name of the object associated with the priceBookId property. |
id | "id": "Hello World" Type: String |
The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.
PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the AccountPackage object.
Standard PATCH objects:
DataFlow PATCH objects:
| DELETE | Account/Package/{id} |
| Delete an instance of the AccountPackage object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the AccountPackage object. |
Delete an instance of the AccountPackage object. DELETE Account/Package/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "accountPackage"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| DELETE | Account/Package/{id}/CancelSetting |
| Delete a CancelSetting object from the AccountPackage. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the AccountPackage object. |
| {cancelsettingId} | Unique identifier for the CancelSetting object sent down in the body of the request in JSON format.{
"details": {
"items": [
{
"identity": 1
}
]
}
} |
Delete a CancelSetting object from the AccountPackage. DELETE Account/Package/{id}/CancelSettingHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "accountPackage"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | Account/Package/ |
| Retrieve all of the AccountPackage objects. | |
Retrieve all of the AccountPackage objects. GET Account/Package/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"accountId": 21,
"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",
"packageFrequencyId": 7,
"packageFrequencyName": "Sample Text Data",
"termId": 4,
"termName": "Sample Text Data",
"createdByUserId": 24,
"createdByUserName": "Sample Text Data",
"billDay": 7,
"updatedByUserId": 9,
"updatedByUserName": "Sample Text Data",
"usageBillDay": 7,
"activation": "2021-04-26T15:25:27.587Z",
"finalBill": "2021-04-26T15:25:27.587Z",
"lastBilled": "2021-04-26T15:25:27.587Z",
"accountSharePlanId": 26,
"accountSharePlanName": "Sample Text Data",
"lastUsageBilled": "2021-04-26T15:25:27.587Z",
"accountProductCodeId": 1,
"accountProductCodeName": "Sample Text Data",
"packageCategoryId": 27,
"packageCategoryName": "Sample Text Data",
"chargeRecurringIfUsage": true,
"updatedByPortalUserId": 6,
"updatedByPortalUserName": "Sample Text Data",
"pendingBillDay": 27,
"pendingUsageBillDay": 23,
"billCancelOptionTypeId": 17,
"billCancelOptionTypeName": "Sample Text Data",
"waiveEarlyTerminationFee": true,
"billingActivationTypeId": 11,
"billingActivationTypeName": "Sample Text Data",
"quantity": 13,
"isQuantityAllowed": true,
"importLastBilled": "2021-04-26T15:25:27.587Z",
"priceBookId": 16,
"priceBookName": "Sample Text Data",
"id": "Sample Text Data"
}
]
} | |
| GET | Account/Package/Paged |
| Retrieve all of the AccountPackage 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 AccountPackage objects in a paged fashion. GET Account/Package/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"accountId": 24,
"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",
"packageFrequencyId": 0,
"packageFrequencyName": "Sample Text Data",
"termId": 4,
"termName": "Sample Text Data",
"createdByUserId": 2,
"createdByUserName": "Sample Text Data",
"billDay": 7,
"updatedByUserId": 2,
"updatedByUserName": "Sample Text Data",
"usageBillDay": 7,
"activation": "2021-04-26T15:25:27.587Z",
"finalBill": "2021-04-26T15:25:27.587Z",
"lastBilled": "2021-04-26T15:25:27.587Z",
"accountSharePlanId": 5,
"accountSharePlanName": "Sample Text Data",
"lastUsageBilled": "2021-04-26T15:25:27.587Z",
"accountProductCodeId": 19,
"accountProductCodeName": "Sample Text Data",
"packageCategoryId": 9,
"packageCategoryName": "Sample Text Data",
"chargeRecurringIfUsage": true,
"updatedByPortalUserId": 24,
"updatedByPortalUserName": "Sample Text Data",
"pendingBillDay": 9,
"pendingUsageBillDay": 1,
"billCancelOptionTypeId": 7,
"billCancelOptionTypeName": "Sample Text Data",
"waiveEarlyTerminationFee": true,
"billingActivationTypeId": 19,
"billingActivationTypeName": "Sample Text Data",
"quantity": 3,
"isQuantityAllowed": true,
"importLastBilled": "2021-04-26T15:25:27.587Z",
"priceBookId": 26,
"priceBookName": "Sample Text Data",
"id": "Sample Text Data"
}
]
}
} | |
| GET | Account/Package/Paged/Detail |
| Retrieve all of the AccountPackage objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
Retrieve all of the AccountPackage objects in a paged fashion with all object details. GET Account/Package/Paged/Detail HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"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",
"packageFrequencyId": 23,
"packageFrequencyName": "Sample Text Data",
"termId": 12,
"termName": "Sample Text Data",
"createdByUserId": 17,
"createdByUserName": "Sample Text Data",
"billDay": 7,
"updatedByUserId": 20,
"updatedByUserName": "Sample Text Data",
"usageBillDay": 7,
"activation": "2021-04-26T15:25:27.587Z",
"finalBill": "2021-04-26T15:25:27.587Z",
"lastBilled": "2021-04-26T15:25:27.587Z",
"accountSharePlanId": 4,
"accountSharePlanName": "Sample Text Data",
"lastUsageBilled": "2021-04-26T15:25:27.587Z",
"accountProductCodeId": 15,
"accountProductCodeName": "Sample Text Data",
"packageCategoryId": 17,
"packageCategoryName": "Sample Text Data",
"chargeRecurringIfUsage": true,
"updatedByPortalUserId": 19,
"updatedByPortalUserName": "Sample Text Data",
"pendingBillDay": 24,
"pendingUsageBillDay": 9,
"billCancelOptionTypeId": 19,
"billCancelOptionTypeName": "Sample Text Data",
"waiveEarlyTerminationFee": true,
"billingActivationTypeId": 12,
"billingActivationTypeName": "Sample Text Data",
"quantity": 12,
"isQuantityAllowed": true,
"importLastBilled": "2021-04-26T15:25:27.587Z",
"priceBookId": 12,
"priceBookName": "Sample Text Data",
"id": "Sample Text Data",
"details": {
"sampleSingleObject": {
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
},
"sampleMultipleObjects": {
"totalCount": 1,
"items": [
{
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
}
]
}
}
}
]
}
} | |
| GET | Account/Package/{id} |
| Retrieve an instance of the AccountPackage object by its ID. | |
| {id} | Unique identifier for the AccountPackage object. |
Retrieve an instance of the AccountPackage object by its ID. GET Account/Package/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"accountId": 9,
"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",
"packageFrequencyId": 17,
"packageFrequencyName": "Sample Text Data",
"termId": 8,
"termName": "Sample Text Data",
"createdByUserId": 8,
"createdByUserName": "Sample Text Data",
"billDay": 7,
"updatedByUserId": 16,
"updatedByUserName": "Sample Text Data",
"usageBillDay": 7,
"activation": "2021-04-26T15:25:27.587Z",
"finalBill": "2021-04-26T15:25:27.587Z",
"lastBilled": "2021-04-26T15:25:27.587Z",
"accountSharePlanId": 2,
"accountSharePlanName": "Sample Text Data",
"lastUsageBilled": "2021-04-26T15:25:27.587Z",
"accountProductCodeId": 16,
"accountProductCodeName": "Sample Text Data",
"packageCategoryId": 3,
"packageCategoryName": "Sample Text Data",
"chargeRecurringIfUsage": true,
"updatedByPortalUserId": 7,
"updatedByPortalUserName": "Sample Text Data",
"pendingBillDay": 18,
"pendingUsageBillDay": 16,
"billCancelOptionTypeId": 21,
"billCancelOptionTypeName": "Sample Text Data",
"waiveEarlyTerminationFee": true,
"billingActivationTypeId": 9,
"billingActivationTypeName": "Sample Text Data",
"quantity": 17,
"isQuantityAllowed": true,
"importLastBilled": "2021-04-26T15:25:27.587Z",
"priceBookId": 19,
"priceBookName": "Sample Text Data",
"id": "Sample Text Data"
}
} | |
| GET | Account/Package/{id}/Detail |
| Retrieve deep detail of the AccountPackage object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the AccountPackage object. |
Retrieve deep detail of the AccountPackage object by its ID. GET Account/Package/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"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",
"packageFrequencyId": 12,
"packageFrequencyName": "Sample Text Data",
"termId": 22,
"termName": "Sample Text Data",
"createdByUserId": 21,
"createdByUserName": "Sample Text Data",
"billDay": 7,
"updatedByUserId": 15,
"updatedByUserName": "Sample Text Data",
"usageBillDay": 7,
"activation": "2021-04-26T15:25:27.587Z",
"finalBill": "2021-04-26T15:25:27.587Z",
"lastBilled": "2021-04-26T15:25:27.587Z",
"accountSharePlanId": 26,
"accountSharePlanName": "Sample Text Data",
"lastUsageBilled": "2021-04-26T15:25:27.587Z",
"accountProductCodeId": 19,
"accountProductCodeName": "Sample Text Data",
"packageCategoryId": 18,
"packageCategoryName": "Sample Text Data",
"chargeRecurringIfUsage": true,
"updatedByPortalUserId": 11,
"updatedByPortalUserName": "Sample Text Data",
"pendingBillDay": 7,
"pendingUsageBillDay": 23,
"billCancelOptionTypeId": 25,
"billCancelOptionTypeName": "Sample Text Data",
"waiveEarlyTerminationFee": true,
"billingActivationTypeId": 22,
"billingActivationTypeName": "Sample Text Data",
"quantity": 26,
"isQuantityAllowed": true,
"importLastBilled": "2021-04-26T15:25:27.587Z",
"priceBookId": 20,
"priceBookName": "Sample Text Data",
"id": "Sample Text Data",
"details": {
"sampleSingleObject": {
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
},
"sampleMultipleObjects": {
"totalCount": 1,
"items": [
{
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
}
]
}
}
}
} | |
| GET | Account/Package/{id}/HasBucketedUsage |
| Retrieve all of the HasBucketedUsage objects for the specified AccountPackage. | |
| {id} | Unique identifier for the AccountPackage object. |
Retrieve all of the HasBucketedUsage objects for the specified AccountPackage. GET Account/Package/{id}/HasBucketedUsageHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"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",
"packageFrequencyId": 1,
"packageFrequencyName": "Sample Text Data",
"termId": 4,
"termName": "Sample Text Data",
"createdByUserId": 2,
"createdByUserName": "Sample Text Data",
"billDay": 7,
"updatedByUserId": 15,
"updatedByUserName": "Sample Text Data",
"usageBillDay": 7,
"activation": "2021-04-26T15:25:27.587Z",
"finalBill": "2021-04-26T15:25:27.587Z",
"lastBilled": "2021-04-26T15:25:27.587Z",
"accountSharePlanId": 16,
"accountSharePlanName": "Sample Text Data",
"lastUsageBilled": "2021-04-26T15:25:27.587Z",
"accountProductCodeId": 3,
"accountProductCodeName": "Sample Text Data",
"packageCategoryId": 2,
"packageCategoryName": "Sample Text Data",
"chargeRecurringIfUsage": true,
"updatedByPortalUserId": 23,
"updatedByPortalUserName": "Sample Text Data",
"pendingBillDay": 5,
"pendingUsageBillDay": 20,
"billCancelOptionTypeId": 23,
"billCancelOptionTypeName": "Sample Text Data",
"waiveEarlyTerminationFee": true,
"billingActivationTypeId": 8,
"billingActivationTypeName": "Sample Text Data",
"quantity": 7,
"isQuantityAllowed": true,
"importLastBilled": "2021-04-26T15:25:27.587Z",
"priceBookId": 24,
"priceBookName": "Sample Text Data",
"id": "Sample Text Data"
}
} | |
| PATCH | Account/Package/{id} |
| Update or Add the AccountPackage object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array. | |
| {id} | Unique identifier for the AccountPackage object. |
Update or Add the AccountPackage object and optionally make changes to any child objects. PATCH Account/Package/{id}
{
"details": {},
"accountPackages": {
"items": [
{
"patchType": "create",
"patchClientId": 1,
"accountId": 19,
"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",
"packageFrequencyId": 14,
"termId": 17,
"billDay": 7,
"usageBillDay": 7,
"activation": "2021-04-26T15:25:27.587Z",
"accountSharePlanId": 0,
"accountProductCodeId": 22,
"packageCategoryId": 27,
"pendingBillDay": 17,
"pendingUsageBillDay": 6,
"billCancelOptionTypeId": 5,
"waiveEarlyTerminationFee": true,
"billingActivationTypeId": 0,
"quantity": 25,
"isQuantityAllowed": true,
"importLastBilled": "2021-04-26T15:25:27.587Z",
"priceBookId": 1,
"id": "Sample Text Data"
}
]
}
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "patch",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"action": "created",
"dtoTypeKey": "accountPackage",
"instance": {
"identity": 1,
"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",
"packageFrequencyId": 16,
"packageFrequencyName": "Sample Text Data",
"termId": 23,
"termName": "Sample Text Data",
"createdByUserId": 18,
"createdByUserName": "Sample Text Data",
"billDay": 7,
"updatedByUserId": 7,
"updatedByUserName": "Sample Text Data",
"usageBillDay": 7,
"activation": "2021-04-26T15:25:27.587Z",
"finalBill": "2021-04-26T15:25:27.587Z",
"lastBilled": "2021-04-26T15:25:27.587Z",
"accountSharePlanId": 19,
"accountSharePlanName": "Sample Text Data",
"lastUsageBilled": "2021-04-26T15:25:27.587Z",
"accountProductCodeId": 9,
"accountProductCodeName": "Sample Text Data",
"packageCategoryId": 6,
"packageCategoryName": "Sample Text Data",
"chargeRecurringIfUsage": true,
"updatedByPortalUserId": 24,
"updatedByPortalUserName": "Sample Text Data",
"pendingBillDay": 20,
"pendingUsageBillDay": 17,
"billCancelOptionTypeId": 2,
"billCancelOptionTypeName": "Sample Text Data",
"waiveEarlyTerminationFee": true,
"billingActivationTypeId": 13,
"billingActivationTypeName": "Sample Text Data",
"quantity": 15,
"isQuantityAllowed": true,
"importLastBilled": "2021-04-26T15:25:27.587Z",
"priceBookId": 1,
"priceBookName": "Sample Text Data",
"id": "Sample Text Data"
}
}
]
}
} | |
| POST | Account/Package/ |
| Create a new instance of the AccountPackage object. | |
Create a new instance of the AccountPackage object. POST Account/Package/
{
"accountId": 11,
"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",
"packageFrequencyId": 10,
"termId": 11,
"billDay": 7,
"usageBillDay": 7,
"activation": "2021-04-26T15:25:27.587Z",
"accountSharePlanId": 10,
"accountProductCodeId": 13,
"packageCategoryId": 0,
"pendingBillDay": 14,
"pendingUsageBillDay": 21,
"billCancelOptionTypeId": 0,
"waiveEarlyTerminationFee": true,
"billingActivationTypeId": 16,
"quantity": 15,
"isQuantityAllowed": true,
"importLastBilled": "2021-04-26T15:25:27.587Z",
"priceBookId": 18,
"id": "Sample Text Data"
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"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",
"packageFrequencyId": 13,
"packageFrequencyName": "Sample Text Data",
"termId": 13,
"termName": "Sample Text Data",
"createdByUserId": 25,
"createdByUserName": "Sample Text Data",
"billDay": 7,
"updatedByUserId": 7,
"updatedByUserName": "Sample Text Data",
"usageBillDay": 7,
"activation": "2021-04-26T15:25:27.587Z",
"finalBill": "2021-04-26T15:25:27.587Z",
"lastBilled": "2021-04-26T15:25:27.587Z",
"accountSharePlanId": 14,
"accountSharePlanName": "Sample Text Data",
"lastUsageBilled": "2021-04-26T15:25:27.587Z",
"accountProductCodeId": 17,
"accountProductCodeName": "Sample Text Data",
"packageCategoryId": 18,
"packageCategoryName": "Sample Text Data",
"chargeRecurringIfUsage": true,
"updatedByPortalUserId": 22,
"updatedByPortalUserName": "Sample Text Data",
"pendingBillDay": 18,
"pendingUsageBillDay": 20,
"billCancelOptionTypeId": 25,
"billCancelOptionTypeName": "Sample Text Data",
"waiveEarlyTerminationFee": true,
"billingActivationTypeId": 11,
"billingActivationTypeName": "Sample Text Data",
"quantity": 4,
"isQuantityAllowed": true,
"importLastBilled": "2021-04-26T15:25:27.587Z",
"priceBookId": 19,
"priceBookName": "Sample Text Data",
"id": "Sample Text Data"
}
]
}
} | |
| POST | Account/Package/FromCatalog |
| Adds an AccountPackage to the Account and inherits all of the Package properties from the product catalog. | |
| POST | Account/Package/{id}/CancelSetting |
| Create a new instance of a CancelSetting object that belongs to the AccountPackage. | |
| {id} | Unique identifier for the AccountPackage object. |
Create a new instance of a CancelSetting object that belongs to the AccountPackage. POST Account/Package/{id}/CancelSetting
{
"accountId": 3,
"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",
"packageFrequencyId": 14,
"termId": 21,
"billDay": 7,
"usageBillDay": 7,
"activation": "2021-04-26T15:25:27.587Z",
"accountSharePlanId": 23,
"accountProductCodeId": 24,
"packageCategoryId": 4,
"pendingBillDay": 14,
"pendingUsageBillDay": 10,
"billCancelOptionTypeId": 20,
"waiveEarlyTerminationFee": true,
"billingActivationTypeId": 21,
"quantity": 5,
"isQuantityAllowed": true,
"importLastBilled": "2021-04-26T15:25:27.587Z",
"priceBookId": 8,
"id": "Sample Text Data"
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"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",
"packageFrequencyId": 7,
"packageFrequencyName": "Sample Text Data",
"termId": 19,
"termName": "Sample Text Data",
"createdByUserId": 3,
"createdByUserName": "Sample Text Data",
"billDay": 7,
"updatedByUserId": 13,
"updatedByUserName": "Sample Text Data",
"usageBillDay": 7,
"activation": "2021-04-26T15:25:27.587Z",
"finalBill": "2021-04-26T15:25:27.587Z",
"lastBilled": "2021-04-26T15:25:27.587Z",
"accountSharePlanId": 14,
"accountSharePlanName": "Sample Text Data",
"lastUsageBilled": "2021-04-26T15:25:27.587Z",
"accountProductCodeId": 16,
"accountProductCodeName": "Sample Text Data",
"packageCategoryId": 14,
"packageCategoryName": "Sample Text Data",
"chargeRecurringIfUsage": true,
"updatedByPortalUserId": 15,
"updatedByPortalUserName": "Sample Text Data",
"pendingBillDay": 15,
"pendingUsageBillDay": 19,
"billCancelOptionTypeId": 15,
"billCancelOptionTypeName": "Sample Text Data",
"waiveEarlyTerminationFee": true,
"billingActivationTypeId": 26,
"billingActivationTypeName": "Sample Text Data",
"quantity": 26,
"isQuantityAllowed": true,
"importLastBilled": "2021-04-26T15:25:27.587Z",
"priceBookId": 17,
"priceBookName": "Sample Text Data",
"id": "Sample Text Data"
}
]
}
} | |
| PUT | Account/Package/{id} |
| Update an existing instance of the AccountPackage object. | |
Update an existing instance of the AccountPackage object. PUT Account/Package/{id}
{
"identity": 1,
"accountId": 19,
"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",
"packageFrequencyId": 27,
"termId": 10,
"billDay": 7,
"usageBillDay": 7,
"activation": "2021-04-26T15:25:27.587Z",
"accountSharePlanId": 6,
"accountProductCodeId": 17,
"packageCategoryId": 0,
"pendingBillDay": 2,
"pendingUsageBillDay": 25,
"billCancelOptionTypeId": 26,
"waiveEarlyTerminationFee": true,
"billingActivationTypeId": 26,
"quantity": 12,
"isQuantityAllowed": true,
"importLastBilled": "2021-04-26T15:25:27.587Z",
"priceBookId": 20,
"id": "Sample Text Data"
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"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",
"packageFrequencyId": 27,
"packageFrequencyName": "Sample Text Data",
"termId": 18,
"termName": "Sample Text Data",
"createdByUserId": 14,
"createdByUserName": "Sample Text Data",
"billDay": 7,
"updatedByUserId": 22,
"updatedByUserName": "Sample Text Data",
"usageBillDay": 7,
"activation": "2021-04-26T15:25:27.587Z",
"finalBill": "2021-04-26T15:25:27.587Z",
"lastBilled": "2021-04-26T15:25:27.587Z",
"accountSharePlanId": 11,
"accountSharePlanName": "Sample Text Data",
"lastUsageBilled": "2021-04-26T15:25:27.587Z",
"accountProductCodeId": 27,
"accountProductCodeName": "Sample Text Data",
"packageCategoryId": 24,
"packageCategoryName": "Sample Text Data",
"chargeRecurringIfUsage": true,
"updatedByPortalUserId": 4,
"updatedByPortalUserName": "Sample Text Data",
"pendingBillDay": 0,
"pendingUsageBillDay": 6,
"billCancelOptionTypeId": 13,
"billCancelOptionTypeName": "Sample Text Data",
"waiveEarlyTerminationFee": true,
"billingActivationTypeId": 25,
"billingActivationTypeName": "Sample Text Data",
"quantity": 7,
"isQuantityAllowed": true,
"importLastBilled": "2021-04-26T15:25:27.587Z",
"priceBookId": 0,
"priceBookName": "Sample Text Data",
"id": "Sample Text Data"
}
]
}
} | |
| PUT | Account/Package/{id}/CancelSetting |
| Update an existing instance of a CancelSetting object that belongs to the AccountPackage. | |
| {id} | Unique identifier for the AccountPackage object. |
Update an existing instance of a CancelSetting object that belongs to the AccountPackage. PUT Account/Package/{id}/CancelSetting
{
"identity": 1,
"accountId": 26,
"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",
"packageFrequencyId": 26,
"termId": 19,
"billDay": 7,
"usageBillDay": 7,
"activation": "2021-04-26T15:25:27.587Z",
"accountSharePlanId": 9,
"accountProductCodeId": 18,
"packageCategoryId": 6,
"pendingBillDay": 20,
"pendingUsageBillDay": 9,
"billCancelOptionTypeId": 4,
"waiveEarlyTerminationFee": true,
"billingActivationTypeId": 27,
"quantity": 8,
"isQuantityAllowed": true,
"importLastBilled": "2021-04-26T15:25:27.587Z",
"priceBookId": 19,
"id": "Sample Text Data"
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"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",
"packageFrequencyId": 11,
"packageFrequencyName": "Sample Text Data",
"termId": 24,
"termName": "Sample Text Data",
"createdByUserId": 2,
"createdByUserName": "Sample Text Data",
"billDay": 7,
"updatedByUserId": 1,
"updatedByUserName": "Sample Text Data",
"usageBillDay": 7,
"activation": "2021-04-26T15:25:27.587Z",
"finalBill": "2021-04-26T15:25:27.587Z",
"lastBilled": "2021-04-26T15:25:27.587Z",
"accountSharePlanId": 26,
"accountSharePlanName": "Sample Text Data",
"lastUsageBilled": "2021-04-26T15:25:27.587Z",
"accountProductCodeId": 18,
"accountProductCodeName": "Sample Text Data",
"packageCategoryId": 4,
"packageCategoryName": "Sample Text Data",
"chargeRecurringIfUsage": true,
"updatedByPortalUserId": 22,
"updatedByPortalUserName": "Sample Text Data",
"pendingBillDay": 7,
"pendingUsageBillDay": 4,
"billCancelOptionTypeId": 11,
"billCancelOptionTypeName": "Sample Text Data",
"waiveEarlyTerminationFee": true,
"billingActivationTypeId": 13,
"billingActivationTypeName": "Sample Text Data",
"quantity": 27,
"isQuantityAllowed": true,
"importLastBilled": "2021-04-26T15:25:27.587Z",
"priceBookId": 27,
"priceBookName": "Sample Text Data",
"id": "Sample Text Data"
}
]
}
} | |