TAG LINE
TAG LINE
SMALL TITLE
Represents a frequency in which a Package can be sold.
identity READ-ONLY | "identity": 1 Type: Number This is the unique numeric identifier for the PackageFrequency |
frequency | "frequency": 7 Type: Number Number representing how often this package bills. |
isActive | "isActive": true Type: Boolean Whether or not this Package Frequency is active. |
packageId | "packageId": 15 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. |
frequencyTypeId | "frequencyTypeId": 10 Type: Number Unique identifier for the associated FrequencyType object. |
frequencyTypeName | "frequencyTypeName": "Sample Name" Type: String The name of the object associated with the frequencyTypeId property. |
termId | "termId": 4 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. |
sku | "sku": "SKU-123-FOO" Type: String A user defined SKU identifier for this Package Frequency. |
name | "name": "Monthly Gold Package" Type: String A user defined name for the Package Frequency. |
isUsageBucketSharePlanPackageFrequency | "isUsageBucketSharePlanPackageFrequency": false Type: Boolean A user defined name for the Package Frequency. |
countingRuleId | "countingRuleId": 2 Type: Number Unique identifier for the associated CountingRule object. |
countingRuleName | "countingRuleName": "Sample Name" Type: String The name of the object associated with the countingRuleId 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. |
id | "id": 26 Type: Number |
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. Below you will find the child objects that can be updated as part of PATCH operations for the PackageFrequency object.
Standard PATCH objects:
DataFlow PATCH objects:
DELETE | Package/Frequency/{id} |
Delete an instance of the PackageFrequency object. Upon successful delete, this API will return a record of all of the related 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 PackageFrequency object. |
Delete an instance of the PackageFrequency object. DELETE Package/Frequency/{id} HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "delete", "results": { "totalCount": 4, "items": [ { "identity": 1, "action": "deleted", "dtoTypeKey": "packageFrequency" }, { "lhsId": 2, "rhsId": 2, "action": "detached", "dtoTypeKey": "sampleObjectConnector" }, { "foreignKeyIdentity": 2, "action": "deleted", "dtoTypeKey": "sampleObject" } ] } } |
GET | Package/Frequency/ |
Retrieve all of the PackageFrequency objects. | |
Retrieve all of the PackageFrequency objects. GET Package/Frequency/ HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "totalCount": 1, "items": [ { "identity": 1, "frequency": 15, "isActive": true, "packageId": 2, "packageName": "Sample Text Data", "frequencyTypeId": 7, "frequencyTypeName": "Sample Text Data", "termId": 24, "termName": "Sample Text Data", "sku": "SKU-123-FOO", "name": "Monthly Gold Package", "isUsageBucketSharePlanPackageFrequency": false, "countingRuleId": 1, "countingRuleName": "Sample Text Data", "created": "2021-04-26T15:25:27.587Z", "updated": "2021-04-26T15:25:27.587Z", "id": 4 } ] } |
GET | Package/Frequency/AvailableFor/Package/{id}/Currency/{currencyId} |
Retrieve the PackageFrequency objects for the specified Package and Currency | |
{id} | Unique identifier for the Package object. |
{currencyId} | Unique identifier for the Currency object. |
GET | Package/Frequency/Paged |
Retrieve all of the PackageFrequency 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 PackageFrequency objects in a paged fashion. GET Package/Frequency/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, "frequency": 12, "isActive": true, "packageId": 8, "packageName": "Sample Text Data", "frequencyTypeId": 9, "frequencyTypeName": "Sample Text Data", "termId": 16, "termName": "Sample Text Data", "sku": "SKU-123-FOO", "name": "Monthly Gold Package", "isUsageBucketSharePlanPackageFrequency": false, "countingRuleId": 5, "countingRuleName": "Sample Text Data", "created": "2021-04-26T15:25:27.587Z", "updated": "2021-04-26T15:25:27.587Z", "id": 15 } ] } } |
GET | Package/Frequency/Paged/Detail |
Retrieve all of the PackageFrequency 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 PackageFrequency objects in a paged fashion with all object details. GET Package/Frequency/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, "frequency": 14, "isActive": true, "packageId": 1, "packageName": "Sample Text Data", "frequencyTypeId": 14, "frequencyTypeName": "Sample Text Data", "termId": 3, "termName": "Sample Text Data", "sku": "SKU-123-FOO", "name": "Monthly Gold Package", "isUsageBucketSharePlanPackageFrequency": false, "countingRuleId": 10, "countingRuleName": "Sample Text Data", "created": "2021-04-26T15:25:27.587Z", "updated": "2021-04-26T15:25:27.587Z", "id": 13, "details": { "pricePlans": [ { "identity": 2, "packageServiceId": 51, "packageFrequencyId": 87, "packageFrequencyName": "Sample Text Data", "packageCurrencyId": 88, "priceBookId": 54, "priceBookName": "Sample Text Data", "generalLedgerId": 46, "generalLedgerName": "Sample Text Data", "serviceTaxCategoryId": 32, "serviceTaxCategoryName": "Sample Text Data", "isTaxInclusive": true, "packageId": 90, "packageName": "Sample Text Data", "serviceId": 73, "serviceName": "Sample Text Data", "packageFrequencyPackageCurrencyIsActive": true, "currencyId": 34, "currencyName": "Sample Text Data", "currencyCode": "Sample Text Data", "countingRuleId": 5, "countingRuleName": "Sample Text Data", "details": { "recurringPrices": [ { "identity": 19, "packageServicePricePlanId": 21, "serviceStatusTypeId": 76, "serviceStatusTypeName": "Sample Text Data", "amount": 98.23, "pricePlanTierTypeId": 50, "pricePlanTierTypeName": "Sample Text Data", "details": { "identity": 53, "amount": 90.47, "threshold": 63, "packageServiceRecurringPriceId": 28 } } ], "transitionPrices": [ { "identity": 4, "amount": 8.73, "packageServicePricePlanId": 14, "serviceTransitionId": 65, "serviceTransitionName": "Sample Text Data", "chargeServiceId": 81, "chargeServiceName": "Sample Text Data", "transitionDuration": 93, "frequencyTypeId": 67, "frequencyTypeName": "Sample Text Data", "transitionDurationPenaltyAmount": 91.98, "transitionLimit": 45 } ], "currentRatePlan": { "identity": 27, "name": "Sample Text Data", "displayName": "Sample Text Data", "start": "2021-04-26T15:25:27.587Z" }, "nonRecurringPrices": [ { "identity": 37, "packageServicePricePlanId": 91, "pricePlanTierTypeId": 50, "pricePlanTierTypeName": "Sample Text Data", "amount": 1.33, "details": { "tiers": [ { "identity": 65, "packageServiceNonRecurringPriceId": 36, "amount": 63.49, "threshold": 94 } ] } } ], "packageServiceDiscounts": [ { "identity": 35, "packageServicePricePlanId": 67, "discountName": "Sample Text Data", "discountStart": "2021-04-26T15:25:27.587Z", "discountEnd": "2021-04-26T15:25:27.587Z", "isProrated": true, "generalLedgerId": 48, "generalLedgerName": "Sample Text Data", "appliedOrder": 26, "isActive": true, "isFreeTrial": true, "isNegativeAllowed": true, "details": { "packageServiceStatusDiscounts": [ { "identity": 69, "packageServiceDiscountId": 90, "serviceStatusTypeId": 25, "serviceStatusTypeName": "Sample Text Data", "discountPromoCodeCurrencyId": 33, "discountId": 91, "details": { "discountAmounts": [ { "identity": 39, "discountId": 3, "discountTypeId": 39, "discountTypeName": "Sample Text Data", "frequency": 91, "frequencyTypeId": 54, "frequencyTypeName": "Sample Text Data", "amount": 11.89, "appliedOrder": 19 } ] } } ] } } ] } } ], "currentRatePlan": { "identity": 1, "name": "Sample Text Data", "displayName": "Sample Text Data", "start": "2021-04-26T15:25:27.587Z" }, "currencies": [ { "identity": 75, "isActive": true, "packageFrequencyId": 85, "packageFrequencyName": "Sample Text Data", "packageCurrencyId": 1, "created": "2021-04-26T15:25:27.587Z", "updated": "2021-04-26T15:25:27.587Z", "priceBookId": 65, "priceBookName": "Sample Text Data", "currencyId": 94, "currencyName": "Sample Text Data", "currencyCode": "Sample Text Data" } ], "usageBucketTiers": [ { "identity": 41, "usageBucketId": 65, "usageBucketName": "Sample Text Data", "threshold": 4.13, "flatCharge": 12.25, "usageUnitId": 62, "usageUnitName": "Sample Text Data", "packageFrequencyId": 33, "packageFrequencyName": "Sample Text Data", "packageServiceId": 67, "currencyId": 67, "currencyName": "Sample Text Data", "priceBookId": 5, "priceBookName": "Sample Text Data", "tierOverride": true } ], "moneyBuckets": [ { "identity": 93, "usageBucketId": 10, "usageBucketName": "Sample Text Data", "usageUnitId": 28, "usageUnitName": "Sample Text Data", "packageFrequencyId": 77, "packageFrequencyName": "Sample Text Data", "packageServiceId": 46, "currencyId": 48, "currencyName": "Sample Text Data", "money": 72.68, "priceBookId": 93, "priceBookName": "Sample Text Data", "tierOverride": true } ] } } ] } } |
GET | Package/Frequency/{id} |
Retrieve an instance of the PackageFrequency object by its ID. | |
{id} | Unique identifier for the PackageFrequency object. |
Retrieve an instance of the PackageFrequency object by its ID. GET Package/Frequency/{id} HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "frequency": 27, "isActive": true, "packageId": 3, "packageName": "Sample Text Data", "frequencyTypeId": 11, "frequencyTypeName": "Sample Text Data", "termId": 5, "termName": "Sample Text Data", "sku": "SKU-123-FOO", "name": "Monthly Gold Package", "isUsageBucketSharePlanPackageFrequency": false, "countingRuleId": 12, "countingRuleName": "Sample Text Data", "created": "2021-04-26T15:25:27.587Z", "updated": "2021-04-26T15:25:27.587Z", "id": 18 } } |
GET | Package/Frequency/{id}/Detail |
Retrieve deep detail of the PackageFrequency 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 PackageFrequency object. |
Retrieve deep detail of the PackageFrequency object by its ID. GET Package/Frequency/{id}/Detail HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "frequency": 14, "isActive": true, "packageId": 10, "packageName": "Sample Text Data", "frequencyTypeId": 8, "frequencyTypeName": "Sample Text Data", "termId": 1, "termName": "Sample Text Data", "sku": "SKU-123-FOO", "name": "Monthly Gold Package", "isUsageBucketSharePlanPackageFrequency": false, "countingRuleId": 15, "countingRuleName": "Sample Text Data", "created": "2021-04-26T15:25:27.587Z", "updated": "2021-04-26T15:25:27.587Z", "id": 4, "details": { "pricePlans": [ { "identity": 2, "packageServiceId": 51, "packageFrequencyId": 87, "packageFrequencyName": "Sample Text Data", "packageCurrencyId": 88, "priceBookId": 54, "priceBookName": "Sample Text Data", "generalLedgerId": 46, "generalLedgerName": "Sample Text Data", "serviceTaxCategoryId": 32, "serviceTaxCategoryName": "Sample Text Data", "isTaxInclusive": true, "packageId": 90, "packageName": "Sample Text Data", "serviceId": 73, "serviceName": "Sample Text Data", "packageFrequencyPackageCurrencyIsActive": true, "currencyId": 34, "currencyName": "Sample Text Data", "currencyCode": "Sample Text Data", "countingRuleId": 5, "countingRuleName": "Sample Text Data", "details": { "recurringPrices": [ { "identity": 19, "packageServicePricePlanId": 21, "serviceStatusTypeId": 76, "serviceStatusTypeName": "Sample Text Data", "amount": 98.23, "pricePlanTierTypeId": 50, "pricePlanTierTypeName": "Sample Text Data", "details": { "identity": 53, "amount": 90.47, "threshold": 63, "packageServiceRecurringPriceId": 28 } } ], "transitionPrices": [ { "identity": 4, "amount": 8.73, "packageServicePricePlanId": 14, "serviceTransitionId": 65, "serviceTransitionName": "Sample Text Data", "chargeServiceId": 81, "chargeServiceName": "Sample Text Data", "transitionDuration": 93, "frequencyTypeId": 67, "frequencyTypeName": "Sample Text Data", "transitionDurationPenaltyAmount": 91.98, "transitionLimit": 45 } ], "currentRatePlan": { "identity": 27, "name": "Sample Text Data", "displayName": "Sample Text Data", "start": "2021-04-26T15:25:27.587Z" }, "nonRecurringPrices": [ { "identity": 37, "packageServicePricePlanId": 91, "pricePlanTierTypeId": 50, "pricePlanTierTypeName": "Sample Text Data", "amount": 1.33, "details": { "tiers": [ { "identity": 65, "packageServiceNonRecurringPriceId": 36, "amount": 63.49, "threshold": 94 } ] } } ], "packageServiceDiscounts": [ { "identity": 35, "packageServicePricePlanId": 67, "discountName": "Sample Text Data", "discountStart": "2021-04-26T15:25:27.587Z", "discountEnd": "2021-04-26T15:25:27.587Z", "isProrated": true, "generalLedgerId": 48, "generalLedgerName": "Sample Text Data", "appliedOrder": 26, "isActive": true, "isFreeTrial": true, "isNegativeAllowed": true, "details": { "packageServiceStatusDiscounts": [ { "identity": 69, "packageServiceDiscountId": 90, "serviceStatusTypeId": 25, "serviceStatusTypeName": "Sample Text Data", "discountPromoCodeCurrencyId": 33, "discountId": 91, "details": { "discountAmounts": [ { "identity": 39, "discountId": 3, "discountTypeId": 39, "discountTypeName": "Sample Text Data", "frequency": 91, "frequencyTypeId": 54, "frequencyTypeName": "Sample Text Data", "amount": 11.89, "appliedOrder": 19 } ] } } ] } } ] } } ], "currentRatePlan": { "identity": 1, "name": "Sample Text Data", "displayName": "Sample Text Data", "start": "2021-04-26T15:25:27.587Z" }, "currencies": [ { "identity": 75, "isActive": true, "packageFrequencyId": 85, "packageFrequencyName": "Sample Text Data", "packageCurrencyId": 1, "created": "2021-04-26T15:25:27.587Z", "updated": "2021-04-26T15:25:27.587Z", "priceBookId": 65, "priceBookName": "Sample Text Data", "currencyId": 94, "currencyName": "Sample Text Data", "currencyCode": "Sample Text Data" } ], "usageBucketTiers": [ { "identity": 41, "usageBucketId": 65, "usageBucketName": "Sample Text Data", "threshold": 4.13, "flatCharge": 12.25, "usageUnitId": 62, "usageUnitName": "Sample Text Data", "packageFrequencyId": 33, "packageFrequencyName": "Sample Text Data", "packageServiceId": 67, "currencyId": 67, "currencyName": "Sample Text Data", "priceBookId": 5, "priceBookName": "Sample Text Data", "tierOverride": true } ], "moneyBuckets": [ { "identity": 93, "usageBucketId": 10, "usageBucketName": "Sample Text Data", "usageUnitId": 28, "usageUnitName": "Sample Text Data", "packageFrequencyId": 77, "packageFrequencyName": "Sample Text Data", "packageServiceId": 46, "currencyId": 48, "currencyName": "Sample Text Data", "money": 72.68, "priceBookId": 93, "priceBookName": "Sample Text Data", "tierOverride": true } ] } } } |
PATCH | Package/Frequency/{id} |
Update or Add the PackageFrequency 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 PackageFrequency object. |
Update or Add the PackageFrequency object and optionally make changes to any child objects. PATCH Package/Frequency/{id} { "details": {}, "packageFrequencys": { "items": [ { "patchType": "create", "patchClientId": 1, "frequency": 0, "isActive": true, "packageId": 26, "frequencyTypeId": 19, "termId": 13, "sku": "SKU-123-FOO", "name": "Monthly Gold Package", "isUsageBucketSharePlanPackageFrequency": false, "countingRuleId": 17, "updated": "2021-04-26T15:25:27.587Z", "id": 19 } ] } } HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "patch", "results": { "totalCount": 1, "items": [ { "identity": 1, "action": "created", "dtoTypeKey": "packageFrequency", "instance": { "identity": 1, "frequency": 19, "isActive": true, "packageId": 2, "packageName": "Sample Text Data", "frequencyTypeId": 12, "frequencyTypeName": "Sample Text Data", "termId": 19, "termName": "Sample Text Data", "sku": "SKU-123-FOO", "name": "Monthly Gold Package", "isUsageBucketSharePlanPackageFrequency": false, "countingRuleId": 26, "countingRuleName": "Sample Text Data", "created": "2021-04-26T15:25:27.587Z", "updated": "2021-04-26T15:25:27.587Z", "id": 8 } } ] } } |
POST | Package/Frequency/ |
Create a new instance of the PackageFrequency object. | |
Create a new instance of the PackageFrequency object. POST Package/Frequency/ { "frequency": 24, "isActive": true, "packageId": 8, "frequencyTypeId": 24, "termId": 2, "sku": "SKU-123-FOO", "name": "Monthly Gold Package", "isUsageBucketSharePlanPackageFrequency": false, "countingRuleId": 0, "updated": "2021-04-26T15:25:27.587Z", "id": 10 } HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "create", "results": { "totalCount": 1, "items": [ { "identity": 1, "frequency": 4, "isActive": true, "packageId": 16, "packageName": "Sample Text Data", "frequencyTypeId": 21, "frequencyTypeName": "Sample Text Data", "termId": 13, "termName": "Sample Text Data", "sku": "SKU-123-FOO", "name": "Monthly Gold Package", "isUsageBucketSharePlanPackageFrequency": false, "countingRuleId": 11, "countingRuleName": "Sample Text Data", "created": "2021-04-26T15:25:27.587Z", "updated": "2021-04-26T15:25:27.587Z", "id": 11 } ] } } |
PUT | Package/Frequency/{id} |
Update an existing instance of the PackageFrequency object. | |
Update an existing instance of the PackageFrequency object. PUT Package/Frequency/{id} { "identity": 1, "frequency": 25, "isActive": true, "packageId": 15, "frequencyTypeId": 1, "termId": 5, "sku": "SKU-123-FOO", "name": "Monthly Gold Package", "isUsageBucketSharePlanPackageFrequency": false, "countingRuleId": 24, "updated": "2021-04-26T15:25:27.587Z", "id": 25 } HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "update", "results": { "totalCount": 1, "items": [ { "identity": 1, "frequency": 15, "isActive": true, "packageId": 15, "packageName": "Sample Text Data", "frequencyTypeId": 21, "frequencyTypeName": "Sample Text Data", "termId": 23, "termName": "Sample Text Data", "sku": "SKU-123-FOO", "name": "Monthly Gold Package", "isUsageBucketSharePlanPackageFrequency": false, "countingRuleId": 13, "countingRuleName": "Sample Text Data", "created": "2021-04-26T15:25:27.587Z", "updated": "2021-04-26T15:25:27.587Z", "id": 25 } ] } } |