TAG LINE
TAG LINE
SMALL TITLE
Represents Service definition which represents a chargable item that can be attached to a Package.
identity READ-ONLY | "identity": 19 Type: Number This is the unique numeric identifier for the Service |
name | "name": "Activation Fee" Type: String User defined name for the Service. |
ownerId READ-ONLY | "ownerId": 11 Type: Number Unique identifier for the associated Owner object. |
ownerName READ-ONLY | "ownerName": "Sample Name" Type: String The name of the object associated with the ownerId property. |
serviceTypeId | "serviceTypeId": 8 Type: Number Unique identifier for the associated ServiceType object. |
serviceTypeName | "serviceTypeName": "Sample Name" Type: String The name of the object associated with the serviceTypeId property. |
usageFrequency | "usageFrequency": 11 Type: Number The frequency of the usage billing. |
usageFrequencyTypeId | "usageFrequencyTypeId": 24 Type: Number Unique identifier for the associated FrequencyType object. |
usageFrequencyTypeName | "usageFrequencyTypeName": "Sample Name" Type: String The name of the object associated with the usageFrequencyTypeId 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. |
isActive | "isActive": true Type: Boolean Whether or not this Service can be added to a Package. |
isTaxExempt | "isTaxExempt": true Type: Boolean Whether or not this Service is exempt from taxation. |
isTaxInclusive | "isTaxInclusive": true Type: Boolean Whether or not this Service price includes tax. |
generalLedgerId | "generalLedgerId": 5 Type: Number Unique identifier for the associated GeneralLedger object. |
generalLedgerName | "generalLedgerName": "Sample Name" Type: String The name of the object associated with the generalLedgerId property. |
taxCodeId READ-ONLY | "taxCodeId": 12 Type: Number Unique identifier for the associated TaxCode object. |
taxCodeName READ-ONLY | "taxCodeName": "Sample Name" Type: String The name of the object associated with the taxCodeId property. |
serviceTaxCategoryId | "serviceTaxCategoryId": 16 Type: Number Unique identifier for the associated ServiceTaxCategory object. |
serviceTaxCategoryName | "serviceTaxCategoryName": "Sample Name" Type: String The name of the object associated with the serviceTaxCategoryId property. |
defaultServiceStatusTypeId | "defaultServiceStatusTypeId": 12 Type: Number Unique identifier for the associated ServiceStatusType object. |
defaultServiceStatusTypeName | "defaultServiceStatusTypeName": "Sample Name" Type: String The name of the object associated with the defaultServiceStatusTypeId property. |
serviceCategoryId | "serviceCategoryId": 25 Type: Number Unique identifier for the associated ServiceCategory object. |
serviceCategoryName | "serviceCategoryName": "Sample Name" Type: String The name of the object associated with the serviceCategoryId property. |
description | "description": "One time charge for activation" Type: String User defined description for the Service. |
id | "id": 7 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 Service object.
Standard PATCH objects:
DataFlow PATCH objects:
| DELETE | Service/{id} |
| Delete an instance of the Service 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 Service object. |
Delete an instance of the Service object. DELETE Service/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "service"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | Service/ |
| Retrieve all of the Service objects. | |
Retrieve all of the Service objects. GET Service/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Activation Fee",
"ownerId": 26,
"ownerName": "Sample Text Data",
"serviceTypeId": 10,
"serviceTypeName": "Sample Text Data",
"usageFrequency": 27,
"usageFrequencyTypeId": 16,
"usageFrequencyTypeName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"isActive": true,
"isTaxExempt": true,
"isTaxInclusive": true,
"generalLedgerId": 11,
"generalLedgerName": "Sample Text Data",
"taxCodeId": 13,
"taxCodeName": "Sample Text Data",
"serviceTaxCategoryId": 26,
"serviceTaxCategoryName": "Sample Text Data",
"defaultServiceStatusTypeId": 20,
"defaultServiceStatusTypeName": "Sample Text Data",
"serviceCategoryId": 23,
"serviceCategoryName": "Sample Text Data",
"description": "One time charge for activation",
"id": 18
}
]
} | |
| GET | Service/AvailableFor/SharePlans |
| Returns the list of Service objects available for configuration on a Share Plan. | |
Returns the list of Service objects available for configuration on a Share Plan. GET Service/AvailableFor/SharePlans HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Activation Fee",
"ownerId": 23,
"ownerName": "Sample Text Data",
"serviceTypeId": 11,
"serviceTypeName": "Sample Text Data",
"usageFrequency": 18,
"usageFrequencyTypeId": 0,
"usageFrequencyTypeName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"isActive": true,
"isTaxExempt": true,
"isTaxInclusive": true,
"generalLedgerId": 8,
"generalLedgerName": "Sample Text Data",
"taxCodeId": 26,
"taxCodeName": "Sample Text Data",
"serviceTaxCategoryId": 25,
"serviceTaxCategoryName": "Sample Text Data",
"defaultServiceStatusTypeId": 0,
"defaultServiceStatusTypeName": "Sample Text Data",
"serviceCategoryId": 1,
"serviceCategoryName": "Sample Text Data",
"description": "One time charge for activation",
"id": 23
}
]
} | |
| GET | Service/Paged |
| Retrieve all of the Service 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 Service objects in a paged fashion. GET 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,
"name": "Activation Fee",
"ownerId": 3,
"ownerName": "Sample Text Data",
"serviceTypeId": 7,
"serviceTypeName": "Sample Text Data",
"usageFrequency": 15,
"usageFrequencyTypeId": 8,
"usageFrequencyTypeName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"isActive": true,
"isTaxExempt": true,
"isTaxInclusive": true,
"generalLedgerId": 23,
"generalLedgerName": "Sample Text Data",
"taxCodeId": 5,
"taxCodeName": "Sample Text Data",
"serviceTaxCategoryId": 18,
"serviceTaxCategoryName": "Sample Text Data",
"defaultServiceStatusTypeId": 9,
"defaultServiceStatusTypeName": "Sample Text Data",
"serviceCategoryId": 4,
"serviceCategoryName": "Sample Text Data",
"description": "One time charge for activation",
"id": 8
}
]
}
} | |
| GET | Service/Paged/Detail |
| Retrieve all of the Service 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 Service objects in a paged fashion with all object details. GET 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,
"name": "Activation Fee",
"ownerId": 20,
"ownerName": "Sample Text Data",
"serviceTypeId": 12,
"serviceTypeName": "Sample Text Data",
"usageFrequency": 1,
"usageFrequencyTypeId": 14,
"usageFrequencyTypeName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"isActive": true,
"isTaxExempt": true,
"isTaxInclusive": true,
"generalLedgerId": 3,
"generalLedgerName": "Sample Text Data",
"taxCodeId": 12,
"taxCodeName": "Sample Text Data",
"serviceTaxCategoryId": 26,
"serviceTaxCategoryName": "Sample Text Data",
"defaultServiceStatusTypeId": 15,
"defaultServiceStatusTypeName": "Sample Text Data",
"serviceCategoryId": 12,
"serviceCategoryName": "Sample Text Data",
"description": "One time charge for activation",
"id": 9,
"details": {
"usageBuckets": [
{
"identity": 3,
"name": "Sample Text Data",
"prorate": true,
"isInfiniteLastTier": true,
"isThresholdPerAccountService": true,
"usageBucketRefillTypeId": 63,
"usageBucketRefillTypeName": "Sample Text Data",
"refillFrequency": 23,
"refillFrequencyTypeId": 77,
"refillFrequencyTypeName": "Sample Text Data",
"expireAfterFrequency": 49,
"expireAfterFrequencyTypeId": 10,
"expireAfterFrequencyTypeName": "Sample Text Data",
"expireAfterRecurrence": 93,
"isAssociatedWithSharePlan": true,
"accountPackageActivation": true,
"overageUsageRatePlanId": 25,
"isSharedAcrossPackage": true,
"overageUsageRatePlanName": "Sample Text Data",
"isBytesInBinaryUnit": true,
"usageBucketBaseUnitId": 19,
"usageBucketBaseUnitName": "Sample Text Data",
"details": {
"tiers": [
{
"identity": 95,
"usageBucketId": 77,
"usageBucketName": "Sample Text Data",
"threshold": 12.44,
"flatCharge": 25.25,
"usageUnitId": 28,
"usageUnitName": "Sample Text Data",
"packageFrequencyId": 34,
"packageFrequencyName": "Sample Text Data",
"packageServiceId": 28,
"currencyId": 76,
"currencyName": "Sample Text Data",
"money": 14.21,
"priceBookId": 17,
"priceBookName": "Sample Text Data",
"tierOverride": true
}
],
"contributions": [
{
"identity": 39,
"usageBucketSharePlanParticipationId": 83,
"usageBucketId": 4,
"usageBucketName": "Sample Text Data",
"isContributing": true,
"contributingAmount": 32,
"contributingUsageUnitId": 79,
"contributingUsageUnitName": "Sample Text Data",
"moneyCurrencyId": 8,
"serviceId": 52,
"serviceName": "Sample Text Data",
"packageId": 35,
"packageName": "Sample Text Data"
}
],
"usageBucketNotifications": [
{
"identity": 92,
"usageBucketServiceId": 13,
"emailConfigurationId": 73,
"emailConfigurationName": "Sample Text Data",
"webhookConfigurationId": 48,
"webhookConfigurationName": "Sample Text Data",
"thresholdPercent": 26,
"details": {
"emailConfiguration": {
"identity": 88,
"name": "Sample Text Data",
"eventSubscriptionId": 39,
"eventSubscriptionName": "Sample Text Data",
"emailTemplateId": 13,
"emailTemplateName": "Sample Text Data",
"details": {
"emailToAddresses": [
{
"identity": 65,
"emailConfigurationId": 62,
"emailConfigurationName": "Sample Text Data",
"userId": 47,
"userName": "Sample Text Data",
"contactTypeTypeId": 52,
"contactTypeTypeName": "Sample Text Data",
"email": "Sample Text Data"
}
]
}
},
"webhookConfiguration": {
"identity": 94,
"name": "Sample Text Data",
"url": "Sample Text Data",
"requestVerb": "Sample Text Data",
"webhookTemplateId": 85,
"webhookTemplateName": "Sample Text Data",
"keyValuePairAuthorizationTokenKey": "Sample Text Data",
"keyValuePairAuthorizationTokenValue": "Sample Text Data",
"eventSubscriptionId": 67,
"eventSubscriptionName": "Sample Text Data",
"webhookAuthorizationTypeId": 7,
"webhookAuthorizationTypeName": "Sample Text Data",
"oAuthUsername": "Sample Text Data",
"oAuthPassword": "Sample Text Data",
"oAuthClientId": "Sample Text Data",
"oAuthAuthorizationURL": "Sample Text Data",
"hasCredentialsSet": true,
"oAuthClientSecret": "Sample Text Data"
}
}
}
],
"usageBucketBase": [
{
"identity": 4,
"name": "Sample Text Data",
"start": "2021-04-26T15:25:27.587Z",
"end": "2021-04-26T15:25:27.587Z",
"retired": true,
"usageBucketBaseUnitId": 75,
"usageBucketBaseUnitName": "Sample Text Data"
}
]
}
}
],
"servicePricebookSetting": [
{
"identity": 50,
"serviceId": 63,
"serviceName": "Sample Text Data",
"priceBookId": 4,
"priceBookName": "Sample Text Data",
"currencyId": 29,
"currencyName": "Sample Text Data",
"generalLedgerId": 65,
"generalLedgerName": "Sample Text Data",
"serviceTaxCategoryId": 96,
"serviceTaxCategoryName": "Sample Text Data",
"isTaxInclusive": true,
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z",
"currencyCode": "Sample Text Data"
}
]
}
}
]
}
} | |
| GET | Service/{id} |
| Retrieve an instance of the Service object by its ID. | |
| {id} | Unique identifier for the Service object. |
Retrieve an instance of the Service object by its ID. GET Service/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Activation Fee",
"ownerId": 18,
"ownerName": "Sample Text Data",
"serviceTypeId": 22,
"serviceTypeName": "Sample Text Data",
"usageFrequency": 27,
"usageFrequencyTypeId": 11,
"usageFrequencyTypeName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"isActive": true,
"isTaxExempt": true,
"isTaxInclusive": true,
"generalLedgerId": 17,
"generalLedgerName": "Sample Text Data",
"taxCodeId": 26,
"taxCodeName": "Sample Text Data",
"serviceTaxCategoryId": 5,
"serviceTaxCategoryName": "Sample Text Data",
"defaultServiceStatusTypeId": 16,
"defaultServiceStatusTypeName": "Sample Text Data",
"serviceCategoryId": 20,
"serviceCategoryName": "Sample Text Data",
"description": "One time charge for activation",
"id": 11
}
} | |
| GET | Service/{id}/Detail |
| Retrieve deep detail of the Service 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 Service object. |
Retrieve deep detail of the Service object by its ID. GET Service/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Activation Fee",
"ownerId": 16,
"ownerName": "Sample Text Data",
"serviceTypeId": 18,
"serviceTypeName": "Sample Text Data",
"usageFrequency": 13,
"usageFrequencyTypeId": 21,
"usageFrequencyTypeName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"isActive": true,
"isTaxExempt": true,
"isTaxInclusive": true,
"generalLedgerId": 23,
"generalLedgerName": "Sample Text Data",
"taxCodeId": 26,
"taxCodeName": "Sample Text Data",
"serviceTaxCategoryId": 7,
"serviceTaxCategoryName": "Sample Text Data",
"defaultServiceStatusTypeId": 15,
"defaultServiceStatusTypeName": "Sample Text Data",
"serviceCategoryId": 8,
"serviceCategoryName": "Sample Text Data",
"description": "One time charge for activation",
"id": 19,
"details": {
"usageBuckets": [
{
"identity": 3,
"name": "Sample Text Data",
"prorate": true,
"isInfiniteLastTier": true,
"isThresholdPerAccountService": true,
"usageBucketRefillTypeId": 63,
"usageBucketRefillTypeName": "Sample Text Data",
"refillFrequency": 23,
"refillFrequencyTypeId": 77,
"refillFrequencyTypeName": "Sample Text Data",
"expireAfterFrequency": 49,
"expireAfterFrequencyTypeId": 10,
"expireAfterFrequencyTypeName": "Sample Text Data",
"expireAfterRecurrence": 93,
"isAssociatedWithSharePlan": true,
"accountPackageActivation": true,
"overageUsageRatePlanId": 25,
"isSharedAcrossPackage": true,
"overageUsageRatePlanName": "Sample Text Data",
"isBytesInBinaryUnit": true,
"usageBucketBaseUnitId": 19,
"usageBucketBaseUnitName": "Sample Text Data",
"details": {
"tiers": [
{
"identity": 95,
"usageBucketId": 77,
"usageBucketName": "Sample Text Data",
"threshold": 12.44,
"flatCharge": 25.25,
"usageUnitId": 28,
"usageUnitName": "Sample Text Data",
"packageFrequencyId": 34,
"packageFrequencyName": "Sample Text Data",
"packageServiceId": 28,
"currencyId": 76,
"currencyName": "Sample Text Data",
"money": 14.21,
"priceBookId": 17,
"priceBookName": "Sample Text Data",
"tierOverride": true
}
],
"contributions": [
{
"identity": 39,
"usageBucketSharePlanParticipationId": 83,
"usageBucketId": 4,
"usageBucketName": "Sample Text Data",
"isContributing": true,
"contributingAmount": 32,
"contributingUsageUnitId": 79,
"contributingUsageUnitName": "Sample Text Data",
"moneyCurrencyId": 8,
"serviceId": 52,
"serviceName": "Sample Text Data",
"packageId": 35,
"packageName": "Sample Text Data"
}
],
"usageBucketNotifications": [
{
"identity": 92,
"usageBucketServiceId": 13,
"emailConfigurationId": 73,
"emailConfigurationName": "Sample Text Data",
"webhookConfigurationId": 48,
"webhookConfigurationName": "Sample Text Data",
"thresholdPercent": 26,
"details": {
"emailConfiguration": {
"identity": 88,
"name": "Sample Text Data",
"eventSubscriptionId": 39,
"eventSubscriptionName": "Sample Text Data",
"emailTemplateId": 13,
"emailTemplateName": "Sample Text Data",
"details": {
"emailToAddresses": [
{
"identity": 65,
"emailConfigurationId": 62,
"emailConfigurationName": "Sample Text Data",
"userId": 47,
"userName": "Sample Text Data",
"contactTypeTypeId": 52,
"contactTypeTypeName": "Sample Text Data",
"email": "Sample Text Data"
}
]
}
},
"webhookConfiguration": {
"identity": 94,
"name": "Sample Text Data",
"url": "Sample Text Data",
"requestVerb": "Sample Text Data",
"webhookTemplateId": 85,
"webhookTemplateName": "Sample Text Data",
"keyValuePairAuthorizationTokenKey": "Sample Text Data",
"keyValuePairAuthorizationTokenValue": "Sample Text Data",
"eventSubscriptionId": 67,
"eventSubscriptionName": "Sample Text Data",
"webhookAuthorizationTypeId": 7,
"webhookAuthorizationTypeName": "Sample Text Data",
"oAuthUsername": "Sample Text Data",
"oAuthPassword": "Sample Text Data",
"oAuthClientId": "Sample Text Data",
"oAuthAuthorizationURL": "Sample Text Data",
"hasCredentialsSet": true,
"oAuthClientSecret": "Sample Text Data"
}
}
}
],
"usageBucketBase": [
{
"identity": 4,
"name": "Sample Text Data",
"start": "2021-04-26T15:25:27.587Z",
"end": "2021-04-26T15:25:27.587Z",
"retired": true,
"usageBucketBaseUnitId": 75,
"usageBucketBaseUnitName": "Sample Text Data"
}
]
}
}
],
"servicePricebookSetting": [
{
"identity": 50,
"serviceId": 63,
"serviceName": "Sample Text Data",
"priceBookId": 4,
"priceBookName": "Sample Text Data",
"currencyId": 29,
"currencyName": "Sample Text Data",
"generalLedgerId": 65,
"generalLedgerName": "Sample Text Data",
"serviceTaxCategoryId": 96,
"serviceTaxCategoryName": "Sample Text Data",
"isTaxInclusive": true,
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z",
"currencyCode": "Sample Text Data"
}
]
}
}
} | |
| PATCH | Service/{id} |
| Update or Add the Service 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 Service object. |
Update or Add the Service object and optionally make changes to any child objects. PATCH Service/{id}
{
"details": {},
"services": {
"items": [
{
"patchType": "create",
"patchClientId": 1,
"name": "Activation Fee",
"serviceTypeId": 1,
"usageFrequency": 17,
"usageFrequencyTypeId": 0,
"isActive": true,
"isTaxExempt": true,
"isTaxInclusive": true,
"generalLedgerId": 15,
"serviceTaxCategoryId": 10,
"defaultServiceStatusTypeId": 7,
"serviceCategoryId": 2,
"description": "One time charge for activation",
"id": 27
}
]
}
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "patch",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"action": "created",
"dtoTypeKey": "service",
"instance": {
"identity": 1,
"name": "Activation Fee",
"ownerId": 22,
"ownerName": "Sample Text Data",
"serviceTypeId": 15,
"serviceTypeName": "Sample Text Data",
"usageFrequency": 24,
"usageFrequencyTypeId": 22,
"usageFrequencyTypeName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"isActive": true,
"isTaxExempt": true,
"isTaxInclusive": true,
"generalLedgerId": 19,
"generalLedgerName": "Sample Text Data",
"taxCodeId": 17,
"taxCodeName": "Sample Text Data",
"serviceTaxCategoryId": 9,
"serviceTaxCategoryName": "Sample Text Data",
"defaultServiceStatusTypeId": 23,
"defaultServiceStatusTypeName": "Sample Text Data",
"serviceCategoryId": 13,
"serviceCategoryName": "Sample Text Data",
"description": "One time charge for activation",
"id": 15
}
}
]
}
} | |
| POST | Service/ |
| Create a new instance of the Service object. | |
Create a new instance of the Service object. POST Service/
{
"name": "Activation Fee",
"serviceTypeId": 4,
"usageFrequency": 24,
"usageFrequencyTypeId": 2,
"isActive": true,
"isTaxExempt": true,
"isTaxInclusive": true,
"generalLedgerId": 23,
"serviceTaxCategoryId": 22,
"defaultServiceStatusTypeId": 16,
"serviceCategoryId": 22,
"description": "One time charge for activation",
"id": 19
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Activation Fee",
"ownerId": 27,
"ownerName": "Sample Text Data",
"serviceTypeId": 24,
"serviceTypeName": "Sample Text Data",
"usageFrequency": 9,
"usageFrequencyTypeId": 15,
"usageFrequencyTypeName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"isActive": true,
"isTaxExempt": true,
"isTaxInclusive": true,
"generalLedgerId": 4,
"generalLedgerName": "Sample Text Data",
"taxCodeId": 13,
"taxCodeName": "Sample Text Data",
"serviceTaxCategoryId": 0,
"serviceTaxCategoryName": "Sample Text Data",
"defaultServiceStatusTypeId": 8,
"defaultServiceStatusTypeName": "Sample Text Data",
"serviceCategoryId": 21,
"serviceCategoryName": "Sample Text Data",
"description": "One time charge for activation",
"id": 12
}
]
}
} | |
| PUT | Service/{id} |
| Update an existing instance of the Service object. | |
Update an existing instance of the Service object. PUT Service/{id}
{
"identity": 1,
"name": "Activation Fee",
"serviceTypeId": 16,
"usageFrequency": 26,
"usageFrequencyTypeId": 15,
"isActive": true,
"isTaxExempt": true,
"isTaxInclusive": true,
"generalLedgerId": 3,
"serviceTaxCategoryId": 7,
"defaultServiceStatusTypeId": 6,
"serviceCategoryId": 22,
"description": "One time charge for activation",
"id": 0
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Activation Fee",
"ownerId": 5,
"ownerName": "Sample Text Data",
"serviceTypeId": 26,
"serviceTypeName": "Sample Text Data",
"usageFrequency": 1,
"usageFrequencyTypeId": 22,
"usageFrequencyTypeName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"isActive": true,
"isTaxExempt": true,
"isTaxInclusive": true,
"generalLedgerId": 26,
"generalLedgerName": "Sample Text Data",
"taxCodeId": 27,
"taxCodeName": "Sample Text Data",
"serviceTaxCategoryId": 13,
"serviceTaxCategoryName": "Sample Text Data",
"defaultServiceStatusTypeId": 6,
"defaultServiceStatusTypeName": "Sample Text Data",
"serviceCategoryId": 13,
"serviceCategoryName": "Sample Text Data",
"description": "One time charge for activation",
"id": 10
}
]
}
} | |