TAG LINE
TAG LINE
SMALL TITLE
identity READ-ONLY | "identity": 21 Type: Number This is the unique numeric identifier for the PriceChange |
name | "name": "Hello World" Type: String |
priceChangeStatusTypeId | "priceChangeStatusTypeId": 13 Type: Number Unique identifier for the associated PriceChangeStatusType object. |
priceChangeStatusTypeName | "priceChangeStatusTypeName": "Sample Name" Type: String The name of the object associated with the priceChangeStatusTypeId property. |
priceBookId | "priceBookId": 16 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. |
effective | "effective": "Hello World" Type: String |
created READ-ONLY | "created": "2021-04-26T15:25:27.587Z" Type: Date This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format. |
createdByUserId | "createdByUserId": 11 Type: Number Unique identifier for the associated User object. |
createdByUserName | "createdByUserName": "Sample Name" Type: String The name of the object associated with the createdByUserId property. |
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. |
updatedByUserId | "updatedByUserId": 7 Type: Number Unique identifier for the associated User object. |
updatedByUserName | "updatedByUserName": "Sample Name" Type: String The name of the object associated with the updatedByUserId property. |
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 PriceChange object.
Standard PATCH objects:
DataFlow PATCH objects:
| DELETE | PriceChange/{id} |
| Delete an instance of the PriceChange 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 PriceChange object. |
Delete an instance of the PriceChange object. DELETE PriceChange/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "priceChange"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | PriceChange/ |
| Retrieve all of the PriceChange objects. | |
Retrieve all of the PriceChange objects. GET PriceChange/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Sample Text Data",
"priceChangeStatusTypeId": 20,
"priceChangeStatusTypeName": "Sample Text Data",
"priceBookId": 22,
"priceBookName": "Sample Text Data",
"effective": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 3,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 18,
"updatedByUserName": "Sample Text Data"
}
]
} | |
| GET | PriceChange/Paged |
| Retrieve all of the PriceChange 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 PriceChange objects in a paged fashion. GET PriceChange/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": "Sample Text Data",
"priceChangeStatusTypeId": 15,
"priceChangeStatusTypeName": "Sample Text Data",
"priceBookId": 3,
"priceBookName": "Sample Text Data",
"effective": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 23,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 4,
"updatedByUserName": "Sample Text Data"
}
]
}
} | |
| GET | PriceChange/Paged/Detail |
| Retrieve all of the PriceChange 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 PriceChange objects in a paged fashion with all object details. GET PriceChange/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": "Sample Text Data",
"priceChangeStatusTypeId": 6,
"priceChangeStatusTypeName": "Sample Text Data",
"priceBookId": 17,
"priceBookName": "Sample Text Data",
"effective": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 24,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 26,
"updatedByUserName": "Sample Text Data",
"details": {
"priceChangeCriteria": [
{
"identity": 25,
"priceChangeId": 9,
"priceChangeName": "Sample Text Data",
"packageId": 53,
"packageName": "Sample Text Data",
"serviceId": 81,
"serviceName": "Sample Text Data",
"packageFrequencyId": 94,
"packageFrequencyName": "Sample Text Data",
"currencyId": 73,
"currencyName": "Sample Text Data",
"currencyCode": "Sample Text Data",
"details": {
"priceChangeCriteriaPrices": [
{
"identity": 42,
"priceChangeCriteriaId": 91,
"priceChangeCriteriaPriceTypeId": 14,
"priceChangeCriteriaPriceTypeName": "Sample Text Data",
"priceChangeTypeId": 54,
"priceChangeTypeName": "Sample Text Data",
"amount": 49.73,
"percentPrecision": 6,
"serviceStatusTypeId": 90,
"serviceStatusTypeName": "Sample Text Data",
"serviceTransitionId": 89,
"serviceTransitionName": "Sample Text Data",
"details": {
"priceChangeCriteriaPriceTiers": [
{
"identity": 34,
"priceChangeCriteriaPriceId": 89,
"amount": 51.89,
"threshold": 55
}
]
}
}
]
}
}
],
"priceChangeStatusHistory": {
"identity": 14,
"priceChangeId": 80,
"PriceChangeName": "Sample Text Data",
"priceChangeStatusTypeId": 70,
"PriceChangeStatusTypeName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 64,
"CreatedByUserName": "Sample Text Data"
},
"priceChangeTracking": {
"identity": 26,
"priceChangeId": 25,
"priceChangeName": "Sample Text Data",
"priceChangeStatusTypeId": 3,
"priceChangeStatusTypeName": "Sample Text Data",
"errorMessage": "Sample Text Data",
"started": "2021-04-26T15:25:27.587Z",
"completed": "2021-04-26T15:25:27.587Z",
"createdByUserId": 46,
"createdByUserName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z"
}
}
}
]
}
} | |
| GET | PriceChange/{id} |
| Retrieve an instance of the PriceChange object by its ID. | |
| {id} | Unique identifier for the PriceChange object. |
Retrieve an instance of the PriceChange object by its ID. GET PriceChange/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Sample Text Data",
"priceChangeStatusTypeId": 23,
"priceChangeStatusTypeName": "Sample Text Data",
"priceBookId": 24,
"priceBookName": "Sample Text Data",
"effective": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 14,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 6,
"updatedByUserName": "Sample Text Data"
}
} | |
| GET | PriceChange/{id}/Detail |
| Retrieve deep detail of the PriceChange 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 PriceChange object. |
Retrieve deep detail of the PriceChange object by its ID. GET PriceChange/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Sample Text Data",
"priceChangeStatusTypeId": 11,
"priceChangeStatusTypeName": "Sample Text Data",
"priceBookId": 0,
"priceBookName": "Sample Text Data",
"effective": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 8,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 12,
"updatedByUserName": "Sample Text Data",
"details": {
"priceChangeCriteria": [
{
"identity": 25,
"priceChangeId": 9,
"priceChangeName": "Sample Text Data",
"packageId": 53,
"packageName": "Sample Text Data",
"serviceId": 81,
"serviceName": "Sample Text Data",
"packageFrequencyId": 94,
"packageFrequencyName": "Sample Text Data",
"currencyId": 73,
"currencyName": "Sample Text Data",
"currencyCode": "Sample Text Data",
"details": {
"priceChangeCriteriaPrices": [
{
"identity": 42,
"priceChangeCriteriaId": 91,
"priceChangeCriteriaPriceTypeId": 14,
"priceChangeCriteriaPriceTypeName": "Sample Text Data",
"priceChangeTypeId": 54,
"priceChangeTypeName": "Sample Text Data",
"amount": 49.73,
"percentPrecision": 6,
"serviceStatusTypeId": 90,
"serviceStatusTypeName": "Sample Text Data",
"serviceTransitionId": 89,
"serviceTransitionName": "Sample Text Data",
"details": {
"priceChangeCriteriaPriceTiers": [
{
"identity": 34,
"priceChangeCriteriaPriceId": 89,
"amount": 51.89,
"threshold": 55
}
]
}
}
]
}
}
],
"priceChangeStatusHistory": {
"identity": 14,
"priceChangeId": 80,
"PriceChangeName": "Sample Text Data",
"priceChangeStatusTypeId": 70,
"PriceChangeStatusTypeName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 64,
"CreatedByUserName": "Sample Text Data"
},
"priceChangeTracking": {
"identity": 26,
"priceChangeId": 25,
"priceChangeName": "Sample Text Data",
"priceChangeStatusTypeId": 3,
"priceChangeStatusTypeName": "Sample Text Data",
"errorMessage": "Sample Text Data",
"started": "2021-04-26T15:25:27.587Z",
"completed": "2021-04-26T15:25:27.587Z",
"createdByUserId": 46,
"createdByUserName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z"
}
}
}
} | |
| GET | PriceChange/{id}/Pricing/Paged/Detail |
| Retrieve all of the Pricing objects for a specified PriceChange in a paged fashion. | |
| {id} | Unique identifier for the PriceChange object. |
Retrieve all of the Pricing objects for a specified PriceChange in a paged fashion. GET PriceChange/{id}/Pricing/Paged/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Sample Text Data",
"priceChangeStatusTypeId": 15,
"priceChangeStatusTypeName": "Sample Text Data",
"priceBookId": 0,
"priceBookName": "Sample Text Data",
"effective": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 3,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 22,
"updatedByUserName": "Sample Text Data"
}
} | |
| PATCH | PriceChange/{id} |
| Update or Add the PriceChange 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 PriceChange object. |
Update or Add the PriceChange object and optionally make changes to any child objects. PATCH PriceChange/{id}
{
"details": {},
"priceChanges": {
"items": [
{
"patchType": "create",
"patchClientId": 1,
"name": "Sample Text Data",
"priceChangeStatusTypeId": 19,
"priceBookId": 11,
"effective": "Sample Text Data",
"createdByUserId": 23,
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 13
}
]
}
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "patch",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"action": "created",
"dtoTypeKey": "priceChange",
"instance": {
"identity": 1,
"name": "Sample Text Data",
"priceChangeStatusTypeId": 18,
"priceChangeStatusTypeName": "Sample Text Data",
"priceBookId": 26,
"priceBookName": "Sample Text Data",
"effective": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 14,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 16,
"updatedByUserName": "Sample Text Data"
}
}
]
}
} | |
| POST | PriceChange/ |
| Create a new instance of the PriceChange object. | |
Create a new instance of the PriceChange object. POST PriceChange/
{
"name": "Sample Text Data",
"priceChangeStatusTypeId": 1,
"priceBookId": 2,
"effective": "Sample Text Data",
"createdByUserId": 6,
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 3
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Sample Text Data",
"priceChangeStatusTypeId": 9,
"priceChangeStatusTypeName": "Sample Text Data",
"priceBookId": 9,
"priceBookName": "Sample Text Data",
"effective": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 17,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 17,
"updatedByUserName": "Sample Text Data"
}
]
}
} | |
| POST | PriceChange/{id}/Approve |
| Create a new instance of a Approve object that belongs to the PriceChange. | |
| {id} | Unique identifier for the PriceChange object. |
Create a new instance of a Approve object that belongs to the PriceChange. POST PriceChange/{id}/Approve
{
"name": "Sample Text Data",
"priceChangeStatusTypeId": 1,
"priceBookId": 27,
"effective": "Sample Text Data",
"createdByUserId": 2,
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 4
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Sample Text Data",
"priceChangeStatusTypeId": 24,
"priceChangeStatusTypeName": "Sample Text Data",
"priceBookId": 27,
"priceBookName": "Sample Text Data",
"effective": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 20,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 18,
"updatedByUserName": "Sample Text Data"
}
]
}
} | |
| POST | PriceChange/{id}/Process |
| Create a new instance of a Process object that belongs to the PriceChange. | |
| {id} | Unique identifier for the PriceChange object. |
Create a new instance of a Process object that belongs to the PriceChange. POST PriceChange/{id}/Process
{
"name": "Sample Text Data",
"priceChangeStatusTypeId": 16,
"priceBookId": 17,
"effective": "Sample Text Data",
"createdByUserId": 23,
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 12
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Sample Text Data",
"priceChangeStatusTypeId": 0,
"priceChangeStatusTypeName": "Sample Text Data",
"priceBookId": 12,
"priceBookName": "Sample Text Data",
"effective": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 14,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 10,
"updatedByUserName": "Sample Text Data"
}
]
}
} | |
| POST | PriceChange/{id}/Rollback |
| Create a new instance of a Rollback object that belongs to the PriceChange. | |
| {id} | Unique identifier for the PriceChange object. |
Create a new instance of a Rollback object that belongs to the PriceChange. POST PriceChange/{id}/Rollback
{
"name": "Sample Text Data",
"priceChangeStatusTypeId": 9,
"priceBookId": 17,
"effective": "Sample Text Data",
"createdByUserId": 22,
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 27
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Sample Text Data",
"priceChangeStatusTypeId": 22,
"priceChangeStatusTypeName": "Sample Text Data",
"priceBookId": 0,
"priceBookName": "Sample Text Data",
"effective": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 23,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 2,
"updatedByUserName": "Sample Text Data"
}
]
}
} | |
| PUT | PriceChange/{id} |
| Update an existing instance of the PriceChange object. | |
Update an existing instance of the PriceChange object. PUT PriceChange/{id}
{
"identity": 1,
"name": "Sample Text Data",
"priceChangeStatusTypeId": 8,
"priceBookId": 5,
"effective": "Sample Text Data",
"createdByUserId": 23,
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 16
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Sample Text Data",
"priceChangeStatusTypeId": 5,
"priceChangeStatusTypeName": "Sample Text Data",
"priceBookId": 13,
"priceBookName": "Sample Text Data",
"effective": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 2,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 23,
"updatedByUserName": "Sample Text Data"
}
]
}
} | |