TAG LINE
TAG LINE
SMALL TITLE
Represents a linking between Services contained within a Package.
identity READ-ONLY | "identity": 26 Type: Number This is the unique numeric identifier for the PackageService |
packageId | "packageId": 27 Type: Number Unique identifier for the associated Package object. |
packageName | "packageName": "Sample Name" Type: String The name of the object associated with the packageId property. |
serviceId | "serviceId": 17 Type: Number Unique identifier for the associated Service object. |
serviceName | "serviceName": "Sample Name" Type: String The name of the object associated with the serviceId property. |
defaultInstances | "defaultInstances": 8 Type: Number Default quantity of services to be added when a Package is added to an Account. |
minimumInstances | "minimumInstances": 5 Type: Number Minimum quantity of services that need to be active in a Package assigned to an Account. |
maximumInstances | "maximumInstances": 0 Type: Number Maximum quantity of services that can be active in a Package assigned to an Account. |
termId | "termId": 19 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. |
isUsageBucketSharePlanPackageService | "isUsageBucketSharePlanPackageService": true Type: Boolean TBC. |
usageClassDynamicId | "usageClassDynamicId": 16 Type: Number Unique identifier for the associated UsageClassDynamic object. |
usageClassDynamicName | "usageClassDynamicName": "Sample Name" Type: String The name of the object associated with the usageClassDynamicId 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. |
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. |
| GET | Package/Service/ |
| Retrieve all of the PackageService objects. | |
Retrieve all of the PackageService objects. GET Package/Service/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"packageId": 10,
"packageName": "Sample Text Data",
"serviceId": 16,
"serviceName": "Sample Text Data",
"defaultInstances": 17,
"minimumInstances": 10,
"maximumInstances": 16,
"termId": 16,
"termName": "Sample Text Data",
"isUsageBucketSharePlanPackageService": true,
"usageClassDynamicId": 8,
"usageClassDynamicName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z"
}
]
} | |
| GET | Package/Service/Paged |
| Retrieve all of the PackageService 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 PackageService objects in a paged fashion. GET Package/Service/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,
"packageId": 22,
"packageName": "Sample Text Data",
"serviceId": 22,
"serviceName": "Sample Text Data",
"defaultInstances": 23,
"minimumInstances": 4,
"maximumInstances": 14,
"termId": 27,
"termName": "Sample Text Data",
"isUsageBucketSharePlanPackageService": true,
"usageClassDynamicId": 10,
"usageClassDynamicName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z"
}
]
}
} | |
| GET | Package/Service/Paged/Detail |
| Retrieve all of the PackageService 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 PackageService objects in a paged fashion with all object details. GET Package/Service/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,
"packageId": 14,
"packageName": "Sample Text Data",
"serviceId": 15,
"serviceName": "Sample Text Data",
"defaultInstances": 14,
"minimumInstances": 18,
"maximumInstances": 27,
"termId": 12,
"termName": "Sample Text Data",
"isUsageBucketSharePlanPackageService": true,
"usageClassDynamicId": 23,
"usageClassDynamicName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z",
"details": {
"pricePlans": [
{
"identity": 4,
"packageServiceId": 91,
"packageFrequencyId": 58,
"packageFrequencyName": "Sample Text Data",
"packageCurrencyId": 68,
"priceBookId": 5,
"priceBookName": "Sample Text Data",
"generalLedgerId": 70,
"generalLedgerName": "Sample Text Data",
"serviceTaxCategoryId": 46,
"serviceTaxCategoryName": "Sample Text Data",
"isTaxInclusive": true,
"packageId": 64,
"packageName": "Sample Text Data",
"serviceId": 0,
"serviceName": "Sample Text Data",
"packageFrequencyPackageCurrencyIsActive": true,
"currencyId": 38,
"currencyName": "Sample Text Data",
"currencyCode": "Sample Text Data",
"countingRuleId": 42,
"countingRuleName": "Sample Text Data"
}
],
"usageBuckets": [
{
"identity": 25,
"name": "Sample Text Data",
"prorate": true,
"isInfiniteLastTier": true,
"isThresholdPerAccountService": true,
"usageBucketRefillTypeId": 30,
"usageBucketRefillTypeName": "Sample Text Data",
"refillFrequency": 16,
"refillFrequencyTypeId": 36,
"refillFrequencyTypeName": "Sample Text Data",
"expireAfterFrequency": 94,
"expireAfterFrequencyTypeId": 8,
"expireAfterFrequencyTypeName": "Sample Text Data",
"expireAfterRecurrence": 70,
"isAssociatedWithSharePlan": true,
"accountPackageActivation": true,
"overageUsageRatePlanId": 98,
"isSharedAcrossPackage": true,
"overageUsageRatePlanName": "Sample Text Data",
"isBytesInBinaryUnit": true,
"usageBucketBaseUnitId": 57,
"usageBucketBaseUnitName": "Sample Text Data",
"details": {
"tiers": [
{
"identity": 84,
"usageBucketId": 52,
"usageBucketName": "Sample Text Data",
"threshold": 66.94,
"flatCharge": 18.71,
"usageUnitId": 20,
"usageUnitName": "Sample Text Data",
"packageFrequencyId": 27,
"packageFrequencyName": "Sample Text Data",
"packageServiceId": 51,
"currencyId": 43,
"currencyName": "Sample Text Data",
"money": 51.31,
"priceBookId": 56,
"priceBookName": "Sample Text Data",
"tierOverride": true
}
],
"contributions": [
{
"identity": 67,
"usageBucketSharePlanParticipationId": 93,
"usageBucketId": 62,
"usageBucketName": "Sample Text Data",
"isContributing": true,
"contributingAmount": 10.85,
"contributingUsageUnitId": 18,
"contributingUsageUnitName": "Sample Text Data",
"moneyCurrencyId": 25,
"serviceId": 15,
"serviceName": "Sample Text Data",
"packageId": 60,
"packageName": "Sample Text Data"
}
],
"usageBucketNotifications": [
{
"identity": 78,
"usageBucketServiceId": 48,
"emailConfigurationId": 39,
"emailConfigurationName": "Sample Text Data",
"webhookConfigurationId": 53,
"webhookConfigurationName": "Sample Text Data",
"thresholdPercent": 89,
"details": {
"emailConfiguration": {
"identity": 99,
"name": "Sample Text Data",
"eventSubscriptionId": 51,
"eventSubscriptionName": "Sample Text Data",
"emailTemplateId": 50,
"emailTemplateName": "Sample Text Data",
"details": {
"emailToAddresses": [
{
"identity": 71,
"emailConfigurationId": 90,
"emailConfigurationName": "Sample Text Data",
"userId": 73,
"userName": "Sample Text Data",
"contactTypeTypeId": 87,
"contactTypeTypeName": "Sample Text Data",
"email": "Sample Text Data"
}
]
}
},
"webhookConfiguration": {
"identity": 79,
"name": "Sample Text Data",
"url": "Sample Text Data",
"requestVerb": "Sample Text Data",
"webhookTemplateId": 98,
"webhookTemplateName": "Sample Text Data",
"keyValuePairAuthorizationTokenKey": "Sample Text Data",
"keyValuePairAuthorizationTokenValue": "Sample Text Data",
"eventSubscriptionId": 52,
"eventSubscriptionName": "Sample Text Data",
"webhookAuthorizationTypeId": 61,
"webhookAuthorizationTypeName": "Sample Text Data",
"oAuthUsername": "Sample Text Data",
"oAuthPassword": "Sample Text Data",
"oAuthClientId": "Sample Text Data",
"oAuthAuthorizationURL": "Sample Text Data",
"hasCredentialsSet": true,
"webhookFormatTypeId": 80,
"webhookFormatTypeName": "Sample Text Data",
"oAuthClientSecret": "Sample Text Data"
}
}
}
],
"usageBucketBase": [
{
"identity": 49,
"name": "Sample Text Data",
"start": "2021-04-26T15:25:27.587Z",
"end": "2021-04-26T15:25:27.587Z",
"retired": true,
"usageBucketBaseUnitId": 60,
"usageBucketBaseUnitName": "Sample Text Data"
}
]
}
}
]
}
}
]
}
} | |
| GET | Package/Service/{id} |
| Retrieve an instance of the PackageService object by its ID. | |
| {id} | Unique identifier for the PackageService object. |
Retrieve an instance of the PackageService object by its ID. GET Package/Service/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"packageId": 15,
"packageName": "Sample Text Data",
"serviceId": 7,
"serviceName": "Sample Text Data",
"defaultInstances": 16,
"minimumInstances": 7,
"maximumInstances": 27,
"termId": 3,
"termName": "Sample Text Data",
"isUsageBucketSharePlanPackageService": true,
"usageClassDynamicId": 26,
"usageClassDynamicName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z"
}
} | |
| GET | Package/Service/{id}/Detail |
| Retrieve deep detail of the PackageService 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 PackageService object. |
Retrieve deep detail of the PackageService object by its ID. GET Package/Service/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"packageId": 13,
"packageName": "Sample Text Data",
"serviceId": 3,
"serviceName": "Sample Text Data",
"defaultInstances": 12,
"minimumInstances": 20,
"maximumInstances": 26,
"termId": 19,
"termName": "Sample Text Data",
"isUsageBucketSharePlanPackageService": true,
"usageClassDynamicId": 15,
"usageClassDynamicName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z",
"details": {
"pricePlans": [
{
"identity": 4,
"packageServiceId": 91,
"packageFrequencyId": 58,
"packageFrequencyName": "Sample Text Data",
"packageCurrencyId": 68,
"priceBookId": 5,
"priceBookName": "Sample Text Data",
"generalLedgerId": 70,
"generalLedgerName": "Sample Text Data",
"serviceTaxCategoryId": 46,
"serviceTaxCategoryName": "Sample Text Data",
"isTaxInclusive": true,
"packageId": 64,
"packageName": "Sample Text Data",
"serviceId": 0,
"serviceName": "Sample Text Data",
"packageFrequencyPackageCurrencyIsActive": true,
"currencyId": 38,
"currencyName": "Sample Text Data",
"currencyCode": "Sample Text Data",
"countingRuleId": 42,
"countingRuleName": "Sample Text Data"
}
],
"usageBuckets": [
{
"identity": 25,
"name": "Sample Text Data",
"prorate": true,
"isInfiniteLastTier": true,
"isThresholdPerAccountService": true,
"usageBucketRefillTypeId": 30,
"usageBucketRefillTypeName": "Sample Text Data",
"refillFrequency": 16,
"refillFrequencyTypeId": 36,
"refillFrequencyTypeName": "Sample Text Data",
"expireAfterFrequency": 94,
"expireAfterFrequencyTypeId": 8,
"expireAfterFrequencyTypeName": "Sample Text Data",
"expireAfterRecurrence": 70,
"isAssociatedWithSharePlan": true,
"accountPackageActivation": true,
"overageUsageRatePlanId": 98,
"isSharedAcrossPackage": true,
"overageUsageRatePlanName": "Sample Text Data",
"isBytesInBinaryUnit": true,
"usageBucketBaseUnitId": 57,
"usageBucketBaseUnitName": "Sample Text Data",
"details": {
"tiers": [
{
"identity": 84,
"usageBucketId": 52,
"usageBucketName": "Sample Text Data",
"threshold": 66.94,
"flatCharge": 18.71,
"usageUnitId": 20,
"usageUnitName": "Sample Text Data",
"packageFrequencyId": 27,
"packageFrequencyName": "Sample Text Data",
"packageServiceId": 51,
"currencyId": 43,
"currencyName": "Sample Text Data",
"money": 51.31,
"priceBookId": 56,
"priceBookName": "Sample Text Data",
"tierOverride": true
}
],
"contributions": [
{
"identity": 67,
"usageBucketSharePlanParticipationId": 93,
"usageBucketId": 62,
"usageBucketName": "Sample Text Data",
"isContributing": true,
"contributingAmount": 10.85,
"contributingUsageUnitId": 18,
"contributingUsageUnitName": "Sample Text Data",
"moneyCurrencyId": 25,
"serviceId": 15,
"serviceName": "Sample Text Data",
"packageId": 60,
"packageName": "Sample Text Data"
}
],
"usageBucketNotifications": [
{
"identity": 78,
"usageBucketServiceId": 48,
"emailConfigurationId": 39,
"emailConfigurationName": "Sample Text Data",
"webhookConfigurationId": 53,
"webhookConfigurationName": "Sample Text Data",
"thresholdPercent": 89,
"details": {
"emailConfiguration": {
"identity": 99,
"name": "Sample Text Data",
"eventSubscriptionId": 51,
"eventSubscriptionName": "Sample Text Data",
"emailTemplateId": 50,
"emailTemplateName": "Sample Text Data",
"details": {
"emailToAddresses": [
{
"identity": 71,
"emailConfigurationId": 90,
"emailConfigurationName": "Sample Text Data",
"userId": 73,
"userName": "Sample Text Data",
"contactTypeTypeId": 87,
"contactTypeTypeName": "Sample Text Data",
"email": "Sample Text Data"
}
]
}
},
"webhookConfiguration": {
"identity": 79,
"name": "Sample Text Data",
"url": "Sample Text Data",
"requestVerb": "Sample Text Data",
"webhookTemplateId": 98,
"webhookTemplateName": "Sample Text Data",
"keyValuePairAuthorizationTokenKey": "Sample Text Data",
"keyValuePairAuthorizationTokenValue": "Sample Text Data",
"eventSubscriptionId": 52,
"eventSubscriptionName": "Sample Text Data",
"webhookAuthorizationTypeId": 61,
"webhookAuthorizationTypeName": "Sample Text Data",
"oAuthUsername": "Sample Text Data",
"oAuthPassword": "Sample Text Data",
"oAuthClientId": "Sample Text Data",
"oAuthAuthorizationURL": "Sample Text Data",
"hasCredentialsSet": true,
"webhookFormatTypeId": 80,
"webhookFormatTypeName": "Sample Text Data",
"oAuthClientSecret": "Sample Text Data"
}
}
}
],
"usageBucketBase": [
{
"identity": 49,
"name": "Sample Text Data",
"start": "2021-04-26T15:25:27.587Z",
"end": "2021-04-26T15:25:27.587Z",
"retired": true,
"usageBucketBaseUnitId": 60,
"usageBucketBaseUnitName": "Sample Text Data"
}
]
}
}
]
}
}
} | |