Get multiple Adjustments
Read the data for multiple Adjustments.
Adjustments are manually created item used to change the Alliant system data. All Adjustment information can be included in future Calculations. An Adjustment item can include Import Adjustments, Contract Adjustments, Calculation Adjustments, or any combination of these three types of Adjustments. An Import Adjustment is used to make changes to imported data. A Contract Adjustment is used to add transactions to a specific Contract. A Calculation Adjustment is used to change calculated data.
query Parameters
Success
Bad Request
Forbidden
Not Found
Method Not Allowed
Internal Server Error
- 200
- 400
- 403
- 404
- 405
- 500
{- "result": {
- "previousPageUrl": "string",
- "nextPageUrl": "string",
- "itemCount": 1,
- "totalItemCount": 20,
- "items": [
- {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
- "adjustmentTypeReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "approvalComment": "string",
- "approvedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "approvedDatetime": "2019-08-24T14:15:22Z",
- "autoReverseFlag": true,
- "calcDataViewReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "clearedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "clearedDatetime": "2019-08-24T14:15:22Z",
- "clearRequestApprovalComment": "string",
- "clearRequestApprovedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "clearRequestApprovedDatetime": "2019-08-24T14:15:22Z",
- "clearRequestComment": "string",
- "clearRequestedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "clearRequestedDatetime": "2019-08-24T14:15:22Z",
- "comment": "string",
- "completedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "completedDatetime": "2019-08-24T14:15:22Z",
- "contextElementReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "contractDataViewReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "createdByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "createdDatetime": "2019-08-24T14:15:22Z",
- "description": "string",
- "importDataViewReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "itemReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "modifiedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "modifiedDatetime": "2019-08-24T14:15:22Z",
- "noteSid": 0,
- "postedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "postedDatetime": "2019-08-24T14:15:22Z",
- "reversePeriodNumber": "2019-08-24T14:15:22Z",
- "sid": 1,
- "statusReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "systemModifiedDatetime": "2019-08-24T14:15:22Z",
- "tabSid": 0
}
]
}, - "errors": [ ],
- "warnings": [ ],
- "hasErrors": false,
- "hasWarnings": false
}
Create a new Adjustment
Create an Adjustment.
Adjustments are manually created item used to change the Alliant system data. All Adjustment information can be included in future Calculations. An Adjustment item can include Import Adjustments, Contract Adjustments, Calculation Adjustments, or any combination of these three types of Adjustments. An Import Adjustment is used to make changes to imported data. A Contract Adjustment is used to add transactions to a specific Contract. A Calculation Adjustment is used to change calculated data.
query Parameters
minimal | boolean When you specify this Verbosity parameter, the |
default | boolean Use this Verbosity parameter option when you want Alliant API to return a response that includes all properties for the Item, including UD Fields. This is the default option that is used when no Verbosity parameter is provided. |
verbose | boolean Use this Verbosity parameter option when you want Alliant API to return UD Field Lookups, Adjustments on Tab, Child Collection, and Cross-Reference properties in addition to the properties from the default Verbosity level. Note: Using this parameter may affect performance and should only be used when necessary. |
include | string Use this Verbosity parameter to specify the properties to include in the response, separated by commas. You can also specify that you want to include Adjustments on Tab, Cross-Reference data Items, Child Items, and Child fields in the response. When you set the Verbosity of the response to minimal or default, Items only display as much information as the Verbosity parameter allows. You can use the ChildDataItem.ChildPropertyName syntax to specify when you want to return additional Child properties. Note: When the values specified in the include parameter are not valid, the query parameter is ignored and a warning is added to response includes property1, childItem1 child collection, childProperty2 of childItem2 collection, udLookup_UDField1 UD Field lookup collection. include=property1,childItem1,childItem2.childProperty2,udLookup_UDField1 |
exclude | string Use this Verbosity parameter to specify the properties to exclude from the response, separated by commas. You can also specify that you want to exclude Adjustments on Tab, Cross-Reference data Items, Child Items, and Child fields from the response. You can use the ChildDataItem.ChildPropertyName syntax to specify when you want to exclude specific Child properties. Note: When the values specified in the exclude parameter are not valid, the query parameter is ignored and a warning is added to response includes all properies according to Verbosity parameter, except for property1, childItem1 collection, childProperty2 of childItem2 collection, and udLookup_UDField1 UD Field lookup collection. exclude=property1,childItem1,childItem2.childProperty2,udLookup_UDField1 |
autoLogOff | boolean Use the autoLogOff parameter to log off Alliant API, discard the Alliant session Security Token, and release the Alliant license currently in use by Alliant API once the request completes. |
Request Body schema: application/jsonrequired
Include as much information as possible regarding the Adjustment
ID (object) or description (object) or SID (object) or GUID (object) (Reference) Specify the Adjustment Type for the Adjustment. | |
autoReverseFlag | boolean (Flag) Specify whether the Adjustment reverses automatically. |
comment | string (Comment) <= 1000 characters Specify the Comment for the Adjustment, when applicable. |
ID (object) or description (object) or SID (object) or GUID (object) (Reference) Specify the Transaction Characteristic associated with the Adjustment (for example, Contracts, Contacts, Accounts, and so forth), when applicable. This property corresponds to the Linked To field on the Adjustment – General tab. | |
description required | string (description) [ 1 .. 255 ] characters Specify the description for the Adjustment. |
ID (object) or description (object) or SID (object) or GUID (object) (Reference) Specify the Item associated with the Adjustment, when applicable. This property corresponds to the Linked Item field on the Adjustment – General tab. | |
reversePeriodNumber | integer Specify the number of Periods after which the Adjustment is reversed, when applicable. This property is required only when the Auto Reverse? checkbox is checked on the Adjustment – General tab. |
Array of objects (Keywords Child Collection Request) Adjustment Keywords | |
Array of objects (Notes Child Collection Request) Adjustment Notes | |
Array of objects (Adjustment Calculation Details Child Collection Request Properties) Adjustment Calculation Details Child Collection. | |
Array of objects (Adjustment Contract Details Child Collection Request Properties) Adjustment Contract Details Child Collection. | |
Array of objects (Adjustment Import Details Child Collection Request Properties) Adjustment Import Details Child Collection. |
Created
Bad Request
Forbidden
Not Found
Method Not Allowed
Conflict
Unsupported Media Type
Internal Server Error
- Payload
{- "adjustmentTypeReference": "string",
- "autoReverseFlag": true,
- "comment": "string",
- "contextElementReference": "string",
- "description": "string",
- "itemReference": "string",
- "reversePeriodNumber": 0,
- "adjustmentKeywords": [
- {
- "_action": "add",
- "keywordReference": "string"
}
], - "adjustmentNotes": [
- {
- "_action": "add",
- "noteAttachments": [
- {
- "_action": "add",
- "_data": "VGhpcyBpcyBhIENvbnRyYWN0IEF0dGFjaG1lbnQgdXBsb2FkZWQgdXNpbmcgQWxsaWFudCBBUEku",
- "attachmentFilename": "string",
- "attachmentName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
- "originalPathFilename": "string",
- "sid": 1
}
], - "noteKeyword": "string",
- "noteLinks": [
- {
- "_action": "add",
- "largeSequenceNumber": 26,
- "linkAddress": "string",
- "linkName": "string",
- "sid": 1
}
], - "noteReminders": [
- {
- "_action": "add",
- "cc2ContactReference": "string",
- "ccContactReference": "string",
- "ccDeliveryGroupReference": "string",
- "completedByContactReference": "string",
- "completedComment": "string",
- "computationTypeReference": "string",
- "noteKeyword": "string",
- "noteReminderCc2ContactDeliveryGroupDetails": [
- {
- "_action": "add",
- "deliverToContactReference": "string",
- "deliveryMethodReference": "string",
- "emailTypeReference": "string"
}
], - "noteReminderCompletionSchedules": [
- {
- "_action": "add",
- "durationNumber": 0,
- "durationTypeReference": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}
], - "noteReminderResponseSchedules": [
- {
- "_action": "add",
- "durationNumber": 0,
- "durationTypeReference": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}
], - "noteReminderTo2ContactDeliveryGroupDetails": [
- {
- "_action": "add",
- "deliverToContactReference": "string",
- "deliveryMethodReference": "string",
- "emailTypeReference": "string"
}
], - "recurEndsAfterIntervalNumber": 1,
- "recurEndsDatetime": "2019-08-24T14:15:22Z",
- "recurForeverFlag": true,
- "recurFrequencyTypeReference": "string",
- "recurIntervalNumber": 0,
- "recurReminderFlag": true,
- "recurSpecificDateFlag": true,
- "recurSpecificIntervalFlag": true,
- "reminderDateTypeReference": "string",
- "reminderNote": "string",
- "reminderSpecificDate": "2019-08-24T14:15:22Z",
- "reminderTypeReference": "string",
- "reminderUsesTwoDatesFlag": true,
- "respondedByContactReference": "string",
- "respondedComment": "string",
- "respondedDatetime": "2019-08-24T14:15:22Z",
- "sid": 1,
- "to2ContactReference": "string",
- "toContactReference": "string",
- "toDeliveryGroupReference": "string"
}
], - "noteText": "string",
- "title": "string"
}
], - "adjustmentCalcDetails": [
- {
- "_action": "add",
- "actualPeriodReference": "string",
- "amount1": 99.123456789,
- "amount2": 99.123456789,
- "comment": "string",
- "contact1Reference": "string",
- "contact2Reference": "string",
- "contact3Reference": "string",
- "contact4Reference": "string",
- "fromDate": "2019-08-24T14:15:22Z",
- "otherPeriodReference": "string",
- "postedPeriodReference": "string",
- "price1": 99.123456789,
- "price2": 99.123456789,
- "rate1": 99.123456789,
- "rate2": 99.123456789,
- "rate3": 99.123456789,
- "text1": "string",
- "text2": "string",
- "toDate": "2019-08-24T14:15:22Z",
- "udKeyXReference": "string",
- "unit1": 99.123456789,
- "unit2": 99.123456789,
- "calcReference": "string",
- "dealReference": "string"
}
], - "adjustmentContractDetails": [
- {
- "_action": "add",
- "actualPeriodReference": "string",
- "amount1": 99.123456789,
- "amount2": 99.123456789,
- "comment": "string",
- "contact1Reference": "string",
- "contact2Reference": "string",
- "contact3Reference": "string",
- "contact4Reference": "string",
- "fromDate": "2019-08-24T14:15:22Z",
- "otherPeriodReference": "string",
- "postedPeriodReference": "string",
- "price1": 99.123456789,
- "price2": 99.123456789,
- "rate1": 99.123456789,
- "rate2": 99.123456789,
- "rate3": 99.123456789,
- "text1": "string",
- "text2": "string",
- "toDate": "2019-08-24T14:15:22Z",
- "udKeyXReference": "string",
- "unit1": 99.123456789,
- "unit2": 99.123456789,
- "contractReference": "string"
}
], - "adjustmentImportDetails": [
- {
- "_action": "add",
- "actualPeriodReference": "string",
- "amount1": 99.123456789,
- "amount2": 99.123456789,
- "comment": "string",
- "contact1Reference": "string",
- "contact2Reference": "string",
- "contact3Reference": "string",
- "contact4Reference": "string",
- "fromDate": "2019-08-24T14:15:22Z",
- "otherPeriodReference": "string",
- "postedPeriodReference": "string",
- "price1": 99.123456789,
- "price2": 99.123456789,
- "rate1": 99.123456789,
- "rate2": 99.123456789,
- "rate3": 99.123456789,
- "text1": "string",
- "text2": "string",
- "toDate": "2019-08-24T14:15:22Z",
- "udKeyXReference": "string",
- "unit1": 99.123456789,
- "unit2": 99.123456789,
- "financialPostDate": "2019-08-24T14:15:22Z",
- "xrefX": "string"
}
]
}
- 201
- 400
- 403
- 404
- 405
- 409
- 415
- 500
{- "result": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
- "adjustmentTypeReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "approvalComment": "string",
- "approvedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "approvedDatetime": "2019-08-24T14:15:22Z",
- "autoReverseFlag": true,
- "calcDataViewReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "clearedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "clearedDatetime": "2019-08-24T14:15:22Z",
- "clearRequestApprovalComment": "string",
- "clearRequestApprovedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "clearRequestApprovedDatetime": "2019-08-24T14:15:22Z",
- "clearRequestComment": "string",
- "clearRequestedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "clearRequestedDatetime": "2019-08-24T14:15:22Z",
- "comment": "string",
- "completedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "completedDatetime": "2019-08-24T14:15:22Z",
- "contextElementReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "contractDataViewReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "createdByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "createdDatetime": "2019-08-24T14:15:22Z",
- "description": "string",
- "importDataViewReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "itemReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "modifiedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "modifiedDatetime": "2019-08-24T14:15:22Z",
- "noteSid": 0,
- "postedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "postedDatetime": "2019-08-24T14:15:22Z",
- "reversePeriodNumber": "2019-08-24T14:15:22Z",
- "sid": 1,
- "statusReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "systemModifiedDatetime": "2019-08-24T14:15:22Z",
- "tabSid": 0
}, - "errors": [
- { }
], - "warnings": [
- { }
], - "hasErrors": false,
- "hasWarnings": false
}
Get a single Adjustment
Read the data for a specific Adjustment.
Adjustments are manually created item used to change the Alliant system data. All Adjustment information can be included in future Calculations. An Adjustment item can include Import Adjustments, Contract Adjustments, Calculation Adjustments, or any combination of these three types of Adjustments. An Import Adjustment is used to make changes to imported data. A Contract Adjustment is used to add transactions to a specific Contract. A Calculation Adjustment is used to change calculated data.
query Parameters
downloadAttachments | boolean Use the downloadAttachments parameter to include Attachment data in the response. You must include either the verbose parameter or the include={ItemType}Attachments parameter when you want to include Attachment data in the response. Attachment data is returned in the _data property in base64 encoded format. When you do not include the downloadAttachments parameter but you include the verbose parameter or the include={ItemType}Attachments parameter, you can use the value in the the |
minimal | boolean When you specify this Verbosity parameter, the |
default | boolean Use this Verbosity parameter option when you want Alliant API to return a response that includes all properties for the Item, including UD Fields. This is the default option that is used when no Verbosity parameter is provided. |
verbose | boolean Use this Verbosity parameter option when you want Alliant API to return UD Field Lookups, Adjustments on Tab, Child Collection, and Cross-Reference properties in addition to the properties from the default Verbosity level. Note: Using this parameter may affect performance and should only be used when necessary. |
include | string Use this Verbosity parameter to specify the properties to include in the response, separated by commas. You can also specify that you want to include Adjustments on Tab, Cross-Reference data Items, Child Items, and Child fields in the response. When you set the Verbosity of the response to minimal or default, Items only display as much information as the Verbosity parameter allows. You can use the ChildDataItem.ChildPropertyName syntax to specify when you want to return additional Child properties. Note: When the values specified in the include parameter are not valid, the query parameter is ignored and a warning is added to response includes property1, childItem1 child collection, childProperty2 of childItem2 collection, udLookup_UDField1 UD Field lookup collection. include=property1,childItem1,childItem2.childProperty2,udLookup_UDField1 |
exclude | string Use this Verbosity parameter to specify the properties to exclude from the response, separated by commas. You can also specify that you want to exclude Adjustments on Tab, Cross-Reference data Items, Child Items, and Child fields from the response. You can use the ChildDataItem.ChildPropertyName syntax to specify when you want to exclude specific Child properties. Note: When the values specified in the exclude parameter are not valid, the query parameter is ignored and a warning is added to response includes all properies according to Verbosity parameter, except for property1, childItem1 collection, childProperty2 of childItem2 collection, and udLookup_UDField1 UD Field lookup collection. exclude=property1,childItem1,childItem2.childProperty2,udLookup_UDField1 |
autoLogOff | boolean Use the autoLogOff parameter to log off Alliant API, discard the Alliant session Security Token, and release the Alliant license currently in use by Alliant API once the request completes. |
Successful Operation
Forbidden
Not Found
Method Not Allowed
Internal Server Error
- 200
- 403
- 404
- 405
- 500
{- "result": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
- "adjustmentTypeReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "approvalComment": "string",
- "approvedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "approvedDatetime": "2019-08-24T14:15:22Z",
- "autoReverseFlag": true,
- "calcDataViewReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "clearedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "clearedDatetime": "2019-08-24T14:15:22Z",
- "clearRequestApprovalComment": "string",
- "clearRequestApprovedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "clearRequestApprovedDatetime": "2019-08-24T14:15:22Z",
- "clearRequestComment": "string",
- "clearRequestedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "clearRequestedDatetime": "2019-08-24T14:15:22Z",
- "comment": "string",
- "completedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "completedDatetime": "2019-08-24T14:15:22Z",
- "contextElementReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "contractDataViewReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "createdByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "createdDatetime": "2019-08-24T14:15:22Z",
- "description": "string",
- "importDataViewReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "itemReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "modifiedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "modifiedDatetime": "2019-08-24T14:15:22Z",
- "noteSid": 0,
- "postedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "postedDatetime": "2019-08-24T14:15:22Z",
- "reversePeriodNumber": "2019-08-24T14:15:22Z",
- "sid": 1,
- "statusReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "systemModifiedDatetime": "2019-08-24T14:15:22Z",
- "tabSid": 0
}, - "errors": [
- { }
], - "warnings": [
- { }
], - "hasErrors": false,
- "hasWarnings": false
}
Delete an Adjustment
Delete a specific Adjustment.
Adjustments are manually created item used to change the Alliant system data. All Adjustment information can be included in future Calculations. An Adjustment item can include Import Adjustments, Contract Adjustments, Calculation Adjustments, or any combination of these three types of Adjustments. An Import Adjustment is used to make changes to imported data. A Contract Adjustment is used to add transactions to a specific Contract. A Calculation Adjustment is used to change calculated data.
OK
Forbidden
Method Not Allowed
Conflict
Internal Server Error
- 200
- 403
- 405
- 409
- 500
{- "result": null,
- "errors": [ ],
- "warnings": [ ],
- "hasErrors": false,
- "hasWarnings": false
}
Update an Adjustment
Update the data for a specific Adjustment.
Adjustments are manually created item used to change the Alliant system data. All Adjustment information can be included in future Calculations. An Adjustment item can include Import Adjustments, Contract Adjustments, Calculation Adjustments, or any combination of these three types of Adjustments. An Import Adjustment is used to make changes to imported data. A Contract Adjustment is used to add transactions to a specific Contract. A Calculation Adjustment is used to change calculated data.
The request body that you submit should include all of the properties that you want to update. When you want to update a Child Data Item, you must specify a value for the _action
subproperty. The following actions are available for Child Data Items:
· add – specify this action when you want to add a new Item.
· delete – specify this action when you want to delete an Item.
· update – specify this action when you want to update data for an Item.
Note: When you submit a request to add or delete Child or Cross-reference Items, the request is not idempotent. When you specify an _action
value for a Child or Cross-reference Item, the action supercedes the behaviour indicated by the HTTP verb for the Child or Cross-reference Item. In this scenario, the request is similar to an HTTP PATCH request.
query Parameters
minimal | boolean When you specify this Verbosity parameter, the |
default | boolean Use this Verbosity parameter option when you want Alliant API to return a response that includes all properties for the Item, including UD Fields. This is the default option that is used when no Verbosity parameter is provided. |
verbose | boolean Use this Verbosity parameter option when you want Alliant API to return UD Field Lookups, Adjustments on Tab, Child Collection, and Cross-Reference properties in addition to the properties from the default Verbosity level. Note: Using this parameter may affect performance and should only be used when necessary. |
include | string Use this Verbosity parameter to specify the properties to include in the response, separated by commas. You can also specify that you want to include Adjustments on Tab, Cross-Reference data Items, Child Items, and Child fields in the response. When you set the Verbosity of the response to minimal or default, Items only display as much information as the Verbosity parameter allows. You can use the ChildDataItem.ChildPropertyName syntax to specify when you want to return additional Child properties. Note: When the values specified in the include parameter are not valid, the query parameter is ignored and a warning is added to response includes property1, childItem1 child collection, childProperty2 of childItem2 collection, udLookup_UDField1 UD Field lookup collection. include=property1,childItem1,childItem2.childProperty2,udLookup_UDField1 |
exclude | string Use this Verbosity parameter to specify the properties to exclude from the response, separated by commas. You can also specify that you want to exclude Adjustments on Tab, Cross-Reference data Items, Child Items, and Child fields from the response. You can use the ChildDataItem.ChildPropertyName syntax to specify when you want to exclude specific Child properties. Note: When the values specified in the exclude parameter are not valid, the query parameter is ignored and a warning is added to response includes all properies according to Verbosity parameter, except for property1, childItem1 collection, childProperty2 of childItem2 collection, and udLookup_UDField1 UD Field lookup collection. exclude=property1,childItem1,childItem2.childProperty2,udLookup_UDField1 |
forceTimestampValidation | boolean Use the forceTimestampValidation parameter to validate the Timestamp for the Items that you want to update. When you use this parameter, you must include the following in the request body:
|
autoLogOff | boolean Use the autoLogOff parameter to log off Alliant API, discard the Alliant session Security Token, and release the Alliant license currently in use by Alliant API once the request completes. |
Request Body schema: application/jsonrequired
Include as much information as possible regarding the Adjustment
ID (object) or description (object) or SID (object) or GUID (object) (Reference) Specify the Adjustment Type for the Adjustment. | |
autoReverseFlag | boolean (Flag) Specify whether the Adjustment reverses automatically. |
comment | string (Comment) <= 1000 characters Specify the Comment for the Adjustment, when applicable. |
ID (object) or description (object) or SID (object) or GUID (object) (Reference) Specify the Transaction Characteristic associated with the Adjustment (for example, Contracts, Contacts, Accounts, and so forth), when applicable. This property corresponds to the Linked To field on the Adjustment – General tab. | |
description required | string (description) [ 1 .. 255 ] characters Specify the description for the Adjustment. |
ID (object) or description (object) or SID (object) or GUID (object) (Reference) Specify the Item associated with the Adjustment, when applicable. This property corresponds to the Linked Item field on the Adjustment – General tab. | |
reversePeriodNumber | integer Specify the number of Periods after which the Adjustment is reversed, when applicable. This property is required only when the Auto Reverse? checkbox is checked on the Adjustment – General tab. |
Array of objects (Keywords Child Collection Request) Adjustment Keywords | |
Array of objects (Notes Child Collection Request) Adjustment Notes | |
Array of objects (Adjustment Calculation Details Child Collection Request Properties) Adjustment Calculation Details Child Collection. | |
Array of objects (Adjustment Contract Details Child Collection Request Properties) Adjustment Contract Details Child Collection. | |
Array of objects (Adjustment Import Details Child Collection Request Properties) Adjustment Import Details Child Collection. |
OK
Bad Request
Forbidden
Not Found
Method Not Allowed
Conflict
Unsupported Media Type
Internal Server Error
- Payload
{- "adjustmentTypeReference": "string",
- "autoReverseFlag": true,
- "comment": "string",
- "contextElementReference": "string",
- "description": "string",
- "itemReference": "string",
- "reversePeriodNumber": 0,
- "adjustmentKeywords": [
- {
- "_action": "add",
- "keywordReference": "string"
}
], - "adjustmentNotes": [
- {
- "_action": "add",
- "noteAttachments": [
- {
- "_action": "add",
- "_data": "VGhpcyBpcyBhIENvbnRyYWN0IEF0dGFjaG1lbnQgdXBsb2FkZWQgdXNpbmcgQWxsaWFudCBBUEku",
- "attachmentFilename": "string",
- "attachmentName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
- "originalPathFilename": "string",
- "sid": 1
}
], - "noteKeyword": "string",
- "noteLinks": [
- {
- "_action": "add",
- "largeSequenceNumber": 26,
- "linkAddress": "string",
- "linkName": "string",
- "sid": 1
}
], - "noteReminders": [
- {
- "_action": "add",
- "cc2ContactReference": "string",
- "ccContactReference": "string",
- "ccDeliveryGroupReference": "string",
- "completedByContactReference": "string",
- "completedComment": "string",
- "computationTypeReference": "string",
- "noteKeyword": "string",
- "noteReminderCc2ContactDeliveryGroupDetails": [
- {
- "_action": "add",
- "deliverToContactReference": "string",
- "deliveryMethodReference": "string",
- "emailTypeReference": "string"
}
], - "noteReminderCompletionSchedules": [
- {
- "_action": "add",
- "durationNumber": 0,
- "durationTypeReference": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}
], - "noteReminderResponseSchedules": [
- {
- "_action": "add",
- "durationNumber": 0,
- "durationTypeReference": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}
], - "noteReminderTo2ContactDeliveryGroupDetails": [
- {
- "_action": "add",
- "deliverToContactReference": "string",
- "deliveryMethodReference": "string",
- "emailTypeReference": "string"
}
], - "recurEndsAfterIntervalNumber": 1,
- "recurEndsDatetime": "2019-08-24T14:15:22Z",
- "recurForeverFlag": true,
- "recurFrequencyTypeReference": "string",
- "recurIntervalNumber": 0,
- "recurReminderFlag": true,
- "recurSpecificDateFlag": true,
- "recurSpecificIntervalFlag": true,
- "reminderDateTypeReference": "string",
- "reminderNote": "string",
- "reminderSpecificDate": "2019-08-24T14:15:22Z",
- "reminderTypeReference": "string",
- "reminderUsesTwoDatesFlag": true,
- "respondedByContactReference": "string",
- "respondedComment": "string",
- "respondedDatetime": "2019-08-24T14:15:22Z",
- "sid": 1,
- "to2ContactReference": "string",
- "toContactReference": "string",
- "toDeliveryGroupReference": "string"
}
], - "noteText": "string",
- "title": "string"
}
], - "adjustmentCalcDetails": [
- {
- "_action": "add",
- "actualPeriodReference": "string",
- "amount1": 99.123456789,
- "amount2": 99.123456789,
- "comment": "string",
- "contact1Reference": "string",
- "contact2Reference": "string",
- "contact3Reference": "string",
- "contact4Reference": "string",
- "fromDate": "2019-08-24T14:15:22Z",
- "otherPeriodReference": "string",
- "postedPeriodReference": "string",
- "price1": 99.123456789,
- "price2": 99.123456789,
- "rate1": 99.123456789,
- "rate2": 99.123456789,
- "rate3": 99.123456789,
- "text1": "string",
- "text2": "string",
- "toDate": "2019-08-24T14:15:22Z",
- "udKeyXReference": "string",
- "unit1": 99.123456789,
- "unit2": 99.123456789,
- "calcReference": "string",
- "dealReference": "string"
}
], - "adjustmentContractDetails": [
- {
- "_action": "add",
- "actualPeriodReference": "string",
- "amount1": 99.123456789,
- "amount2": 99.123456789,
- "comment": "string",
- "contact1Reference": "string",
- "contact2Reference": "string",
- "contact3Reference": "string",
- "contact4Reference": "string",
- "fromDate": "2019-08-24T14:15:22Z",
- "otherPeriodReference": "string",
- "postedPeriodReference": "string",
- "price1": 99.123456789,
- "price2": 99.123456789,
- "rate1": 99.123456789,
- "rate2": 99.123456789,
- "rate3": 99.123456789,
- "text1": "string",
- "text2": "string",
- "toDate": "2019-08-24T14:15:22Z",
- "udKeyXReference": "string",
- "unit1": 99.123456789,
- "unit2": 99.123456789,
- "contractReference": "string"
}
], - "adjustmentImportDetails": [
- {
- "_action": "add",
- "actualPeriodReference": "string",
- "amount1": 99.123456789,
- "amount2": 99.123456789,
- "comment": "string",
- "contact1Reference": "string",
- "contact2Reference": "string",
- "contact3Reference": "string",
- "contact4Reference": "string",
- "fromDate": "2019-08-24T14:15:22Z",
- "otherPeriodReference": "string",
- "postedPeriodReference": "string",
- "price1": 99.123456789,
- "price2": 99.123456789,
- "rate1": 99.123456789,
- "rate2": 99.123456789,
- "rate3": 99.123456789,
- "text1": "string",
- "text2": "string",
- "toDate": "2019-08-24T14:15:22Z",
- "udKeyXReference": "string",
- "unit1": 99.123456789,
- "unit2": 99.123456789,
- "financialPostDate": "2019-08-24T14:15:22Z",
- "xrefX": "string"
}
]
}
- 200
- 400
- 403
- 404
- 405
- 409
- 415
- 500
{- "result": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
- "adjustmentTypeReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "approvalComment": "string",
- "approvedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "approvedDatetime": "2019-08-24T14:15:22Z",
- "autoReverseFlag": true,
- "calcDataViewReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "clearedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "clearedDatetime": "2019-08-24T14:15:22Z",
- "clearRequestApprovalComment": "string",
- "clearRequestApprovedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "clearRequestApprovedDatetime": "2019-08-24T14:15:22Z",
- "clearRequestComment": "string",
- "clearRequestedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "clearRequestedDatetime": "2019-08-24T14:15:22Z",
- "comment": "string",
- "completedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "completedDatetime": "2019-08-24T14:15:22Z",
- "contextElementReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "contractDataViewReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "createdByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "createdDatetime": "2019-08-24T14:15:22Z",
- "description": "string",
- "importDataViewReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "itemReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "modifiedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "modifiedDatetime": "2019-08-24T14:15:22Z",
- "noteSid": 0,
- "postedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "postedDatetime": "2019-08-24T14:15:22Z",
- "reversePeriodNumber": "2019-08-24T14:15:22Z",
- "sid": 1,
- "statusReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "systemModifiedDatetime": "2019-08-24T14:15:22Z",
- "tabSid": 0
}, - "errors": [
- { }
], - "warnings": [
- { }
], - "hasErrors": false,
- "hasWarnings": false
}
Update an Adjustment
Update the data for a specific Adjustment.
Adjustments are manually created item used to change the Alliant system data. All Adjustment information can be included in future Calculations. An Adjustment item can include Import Adjustments, Contract Adjustments, Calculation Adjustments, or any combination of these three types of Adjustments. An Import Adjustment is used to make changes to imported data. A Contract Adjustment is used to add transactions to a specific Contract. A Calculation Adjustment is used to change calculated data.
The request body that you submit should include all of the properties that you want to update. When you want to update a Child Data Item, you must specify a value for the _action
subproperty. The following actions are available for Child Data Items:
· add – specify this action when you want to add a new Item.
· delete – specify this action when you want to delete an Item.
· update – specify this action when you want to update data for an Item.
Note: As well as partial updates, it is possible to use an _action
to add or delete records. When there is an _action included within the body, then this action supercedes the behaviour indicated by the HTTP verb.
query Parameters
minimal | boolean When you specify this Verbosity parameter, the |
default | boolean Use this Verbosity parameter option when you want Alliant API to return a response that includes all properties for the Item, including UD Fields. This is the default option that is used when no Verbosity parameter is provided. |
verbose | boolean Use this Verbosity parameter option when you want Alliant API to return UD Field Lookups, Adjustments on Tab, Child Collection, and Cross-Reference properties in addition to the properties from the default Verbosity level. Note: Using this parameter may affect performance and should only be used when necessary. |
include | string Use this Verbosity parameter to specify the properties to include in the response, separated by commas. You can also specify that you want to include Adjustments on Tab, Cross-Reference data Items, Child Items, and Child fields in the response. When you set the Verbosity of the response to minimal or default, Items only display as much information as the Verbosity parameter allows. You can use the ChildDataItem.ChildPropertyName syntax to specify when you want to return additional Child properties. Note: When the values specified in the include parameter are not valid, the query parameter is ignored and a warning is added to response includes property1, childItem1 child collection, childProperty2 of childItem2 collection, udLookup_UDField1 UD Field lookup collection. include=property1,childItem1,childItem2.childProperty2,udLookup_UDField1 |
exclude | string Use this Verbosity parameter to specify the properties to exclude from the response, separated by commas. You can also specify that you want to exclude Adjustments on Tab, Cross-Reference data Items, Child Items, and Child fields from the response. You can use the ChildDataItem.ChildPropertyName syntax to specify when you want to exclude specific Child properties. Note: When the values specified in the exclude parameter are not valid, the query parameter is ignored and a warning is added to response includes all properies according to Verbosity parameter, except for property1, childItem1 collection, childProperty2 of childItem2 collection, and udLookup_UDField1 UD Field lookup collection. exclude=property1,childItem1,childItem2.childProperty2,udLookup_UDField1 |
forceTimestampValidation | boolean Use the forceTimestampValidation parameter to validate the Timestamp for the Items that you want to update. When you use this parameter, you must include the following in the request body:
|
autoLogOff | boolean Use the autoLogOff parameter to log off Alliant API, discard the Alliant session Security Token, and release the Alliant license currently in use by Alliant API once the request completes. |
Request Body schema: application/jsonrequired
Include as much information as possible regarding the Adjustment
ID (object) or description (object) or SID (object) or GUID (object) (Reference) Specify the Adjustment Type for the Adjustment. | |
autoReverseFlag | boolean (Flag) Specify whether the Adjustment reverses automatically. |
comment | string (Comment) <= 1000 characters Specify the Comment for the Adjustment, when applicable. |
ID (object) or description (object) or SID (object) or GUID (object) (Reference) Specify the Transaction Characteristic associated with the Adjustment (for example, Contracts, Contacts, Accounts, and so forth), when applicable. This property corresponds to the Linked To field on the Adjustment – General tab. | |
description required | string (description) [ 1 .. 255 ] characters Specify the description for the Adjustment. |
ID (object) or description (object) or SID (object) or GUID (object) (Reference) Specify the Item associated with the Adjustment, when applicable. This property corresponds to the Linked Item field on the Adjustment – General tab. | |
reversePeriodNumber | integer Specify the number of Periods after which the Adjustment is reversed, when applicable. This property is required only when the Auto Reverse? checkbox is checked on the Adjustment – General tab. |
Array of objects (Keywords Child Collection Request) Adjustment Keywords | |
Array of objects (Notes Child Collection Request) Adjustment Notes | |
Array of objects (Adjustment Calculation Details Child Collection Request Properties) Adjustment Calculation Details Child Collection. | |
Array of objects (Adjustment Contract Details Child Collection Request Properties) Adjustment Contract Details Child Collection. | |
Array of objects (Adjustment Import Details Child Collection Request Properties) Adjustment Import Details Child Collection. |
OK
Bad Request
Forbidden
Not Found
Method Not Allowed
Conflict
Unsupported Media Type
Internal Server Error
- Payload
{- "adjustmentTypeReference": "string",
- "autoReverseFlag": true,
- "comment": "string",
- "contextElementReference": "string",
- "description": "string",
- "itemReference": "string",
- "reversePeriodNumber": 0,
- "adjustmentKeywords": [
- {
- "_action": "add",
- "keywordReference": "string"
}
], - "adjustmentNotes": [
- {
- "_action": "add",
- "noteAttachments": [
- {
- "_action": "add",
- "_data": "VGhpcyBpcyBhIENvbnRyYWN0IEF0dGFjaG1lbnQgdXBsb2FkZWQgdXNpbmcgQWxsaWFudCBBUEku",
- "attachmentFilename": "string",
- "attachmentName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
- "originalPathFilename": "string",
- "sid": 1
}
], - "noteKeyword": "string",
- "noteLinks": [
- {
- "_action": "add",
- "largeSequenceNumber": 26,
- "linkAddress": "string",
- "linkName": "string",
- "sid": 1
}
], - "noteReminders": [
- {
- "_action": "add",
- "cc2ContactReference": "string",
- "ccContactReference": "string",
- "ccDeliveryGroupReference": "string",
- "completedByContactReference": "string",
- "completedComment": "string",
- "computationTypeReference": "string",
- "noteKeyword": "string",
- "noteReminderCc2ContactDeliveryGroupDetails": [
- {
- "_action": "add",
- "deliverToContactReference": "string",
- "deliveryMethodReference": "string",
- "emailTypeReference": "string"
}
], - "noteReminderCompletionSchedules": [
- {
- "_action": "add",
- "durationNumber": 0,
- "durationTypeReference": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}
], - "noteReminderResponseSchedules": [
- {
- "_action": "add",
- "durationNumber": 0,
- "durationTypeReference": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}
], - "noteReminderTo2ContactDeliveryGroupDetails": [
- {
- "_action": "add",
- "deliverToContactReference": "string",
- "deliveryMethodReference": "string",
- "emailTypeReference": "string"
}
], - "recurEndsAfterIntervalNumber": 1,
- "recurEndsDatetime": "2019-08-24T14:15:22Z",
- "recurForeverFlag": true,
- "recurFrequencyTypeReference": "string",
- "recurIntervalNumber": 0,
- "recurReminderFlag": true,
- "recurSpecificDateFlag": true,
- "recurSpecificIntervalFlag": true,
- "reminderDateTypeReference": "string",
- "reminderNote": "string",
- "reminderSpecificDate": "2019-08-24T14:15:22Z",
- "reminderTypeReference": "string",
- "reminderUsesTwoDatesFlag": true,
- "respondedByContactReference": "string",
- "respondedComment": "string",
- "respondedDatetime": "2019-08-24T14:15:22Z",
- "sid": 1,
- "to2ContactReference": "string",
- "toContactReference": "string",
- "toDeliveryGroupReference": "string"
}
], - "noteText": "string",
- "title": "string"
}
], - "adjustmentCalcDetails": [
- {
- "_action": "add",
- "actualPeriodReference": "string",
- "amount1": 99.123456789,
- "amount2": 99.123456789,
- "comment": "string",
- "contact1Reference": "string",
- "contact2Reference": "string",
- "contact3Reference": "string",
- "contact4Reference": "string",
- "fromDate": "2019-08-24T14:15:22Z",
- "otherPeriodReference": "string",
- "postedPeriodReference": "string",
- "price1": 99.123456789,
- "price2": 99.123456789,
- "rate1": 99.123456789,
- "rate2": 99.123456789,
- "rate3": 99.123456789,
- "text1": "string",
- "text2": "string",
- "toDate": "2019-08-24T14:15:22Z",
- "udKeyXReference": "string",
- "unit1": 99.123456789,
- "unit2": 99.123456789,
- "calcReference": "string",
- "dealReference": "string"
}
], - "adjustmentContractDetails": [
- {
- "_action": "add",
- "actualPeriodReference": "string",
- "amount1": 99.123456789,
- "amount2": 99.123456789,
- "comment": "string",
- "contact1Reference": "string",
- "contact2Reference": "string",
- "contact3Reference": "string",
- "contact4Reference": "string",
- "fromDate": "2019-08-24T14:15:22Z",
- "otherPeriodReference": "string",
- "postedPeriodReference": "string",
- "price1": 99.123456789,
- "price2": 99.123456789,
- "rate1": 99.123456789,
- "rate2": 99.123456789,
- "rate3": 99.123456789,
- "text1": "string",
- "text2": "string",
- "toDate": "2019-08-24T14:15:22Z",
- "udKeyXReference": "string",
- "unit1": 99.123456789,
- "unit2": 99.123456789,
- "contractReference": "string"
}
], - "adjustmentImportDetails": [
- {
- "_action": "add",
- "actualPeriodReference": "string",
- "amount1": 99.123456789,
- "amount2": 99.123456789,
- "comment": "string",
- "contact1Reference": "string",
- "contact2Reference": "string",
- "contact3Reference": "string",
- "contact4Reference": "string",
- "fromDate": "2019-08-24T14:15:22Z",
- "otherPeriodReference": "string",
- "postedPeriodReference": "string",
- "price1": 99.123456789,
- "price2": 99.123456789,
- "rate1": 99.123456789,
- "rate2": 99.123456789,
- "rate3": 99.123456789,
- "text1": "string",
- "text2": "string",
- "toDate": "2019-08-24T14:15:22Z",
- "udKeyXReference": "string",
- "unit1": 99.123456789,
- "unit2": 99.123456789,
- "financialPostDate": "2019-08-24T14:15:22Z",
- "xrefX": "string"
}
]
}
- 200
- 400
- 403
- 404
- 405
- 409
- 415
- 500
{- "result": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
- "adjustmentTypeReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "approvalComment": "string",
- "approvedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "approvedDatetime": "2019-08-24T14:15:22Z",
- "autoReverseFlag": true,
- "calcDataViewReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "clearedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "clearedDatetime": "2019-08-24T14:15:22Z",
- "clearRequestApprovalComment": "string",
- "clearRequestApprovedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "clearRequestApprovedDatetime": "2019-08-24T14:15:22Z",
- "clearRequestComment": "string",
- "clearRequestedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "clearRequestedDatetime": "2019-08-24T14:15:22Z",
- "comment": "string",
- "completedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "completedDatetime": "2019-08-24T14:15:22Z",
- "contextElementReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "contractDataViewReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "createdByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "createdDatetime": "2019-08-24T14:15:22Z",
- "description": "string",
- "importDataViewReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "itemReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "modifiedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "modifiedDatetime": "2019-08-24T14:15:22Z",
- "noteSid": 0,
- "postedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "postedDatetime": "2019-08-24T14:15:22Z",
- "reversePeriodNumber": "2019-08-24T14:15:22Z",
- "sid": 1,
- "statusReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "systemModifiedDatetime": "2019-08-24T14:15:22Z",
- "tabSid": 0
}, - "errors": [
- { }
], - "warnings": [
- { }
], - "hasErrors": false,
- "hasWarnings": false
}
Execute the Approve Tool on an existing Adjustment
Execute the Approve Tool on an existing Adjustment.
query Parameters
Request Body schema: application/json
OK
Bad Request
Forbidden
Not Found
Method Not Allowed
Internal Server Error
- Payload
{- "comment": "string"
}
- 200
- 400
- 403
- 404
- 405
- 500
{- "result": null,
- "errors": [ ],
- "warnings": [ ],
- "hasErrors": false,
- "hasWarnings": false
}
Execute the Clear Tool on an existing Adjustment
Execute the Clear Tool on an existing Adjustment.
OK
Bad Request
Forbidden
Not Found
Method Not Allowed
Internal Server Error
- 200
- 400
- 403
- 404
- 405
- 500
{- "result": null,
- "errors": [ ],
- "warnings": [ ],
- "hasErrors": false,
- "hasWarnings": false
}
Execute the ClearRequest Tool on an existing Adjustment
Execute the ClearRequest Tool on an existing Adjustment.
query Parameters
Request Body schema: application/json
OK
Bad Request
Forbidden
Not Found
Method Not Allowed
Internal Server Error
- Payload
{- "comment": "string"
}
- 200
- 400
- 403
- 404
- 405
- 500
{- "result": null,
- "errors": [ ],
- "warnings": [ ],
- "hasErrors": false,
- "hasWarnings": false
}
Execute the Complete Tool on an existing Adjustment
Execute the Complete Tool on an existing Adjustment.
OK
Bad Request
Forbidden
Not Found
Method Not Allowed
Internal Server Error
- 200
- 400
- 403
- 404
- 405
- 500
{- "result": null,
- "errors": [ ],
- "warnings": [ ],
- "hasErrors": false,
- "hasWarnings": false
}
Copy an existing Adjustment
Copy a specific Adjustment.
This PUT does not behave as a standard HTTP PUT and is NOT idempotent. This PUT will create a new resource. Its behaviour is that of a POST and it should be treated as such.
query Parameters
downloadAttachments | boolean Use the downloadAttachments parameter to include Attachment data in the response. You must include either the verbose parameter or the include={ItemType}Attachments parameter when you want to include Attachment data in the response. Attachment data is returned in the _data property in base64 encoded format. When you do not include the downloadAttachments parameter but you include the verbose parameter or the include={ItemType}Attachments parameter, you can use the value in the the |
minimal | boolean When you specify this Verbosity parameter, the |
default | boolean Use this Verbosity parameter option when you want Alliant API to return a response that includes all properties for the Item, including UD Fields. This is the default option that is used when no Verbosity parameter is provided. |
verbose | boolean Use this Verbosity parameter option when you want Alliant API to return UD Field Lookups, Adjustments on Tab, Child Collection, and Cross-Reference properties in addition to the properties from the default Verbosity level. Note: Using this parameter may affect performance and should only be used when necessary. |
include | string Use this Verbosity parameter to specify the properties to include in the response, separated by commas. You can also specify that you want to include Adjustments on Tab, Cross-Reference data Items, Child Items, and Child fields in the response. When you set the Verbosity of the response to minimal or default, Items only display as much information as the Verbosity parameter allows. You can use the ChildDataItem.ChildPropertyName syntax to specify when you want to return additional Child properties. Note: When the values specified in the include parameter are not valid, the query parameter is ignored and a warning is added to response includes property1, childItem1 child collection, childProperty2 of childItem2 collection, udLookup_UDField1 UD Field lookup collection. include=property1,childItem1,childItem2.childProperty2,udLookup_UDField1 |
exclude | string Use this Verbosity parameter to specify the properties to exclude from the response, separated by commas. You can also specify that you want to exclude Adjustments on Tab, Cross-Reference data Items, Child Items, and Child fields from the response. You can use the ChildDataItem.ChildPropertyName syntax to specify when you want to exclude specific Child properties. Note: When the values specified in the exclude parameter are not valid, the query parameter is ignored and a warning is added to response includes all properies according to Verbosity parameter, except for property1, childItem1 collection, childProperty2 of childItem2 collection, and udLookup_UDField1 UD Field lookup collection. exclude=property1,childItem1,childItem2.childProperty2,udLookup_UDField1 |
autoLogOff | boolean Use the autoLogOff parameter to log off Alliant API, discard the Alliant session Security Token, and release the Alliant license currently in use by Alliant API once the request completes. |
Request Body schema: application/json
copyNotes | boolean (Flag) Specify whether to copy the Notes attached to the Adjustment. This property corresponds to the Copy Attached Notes? field on the Adjustment – Copy the Listed Adjustments window. |
reverseCopiedDetails | boolean (Flag) Specify whether to reverse the details for the Adjustment you are copying. This property corresponds to the Reverse Copied Details? field on the Adjustment – Copy the Listed Adjustments window. |
Successful Operation
Forbidden
Not Found
Method Not Allowed
Unsupported Media Type
Internal Server Error
- Payload
{- "copyNotes": true,
- "reverseCopiedDetails": true
}
- 200
- 403
- 404
- 405
- 415
- 500
{- "result": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
- "adjustmentTypeReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "approvalComment": "string",
- "approvedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "approvedDatetime": "2019-08-24T14:15:22Z",
- "autoReverseFlag": true,
- "calcDataViewReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "clearedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "clearedDatetime": "2019-08-24T14:15:22Z",
- "clearRequestApprovalComment": "string",
- "clearRequestApprovedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "clearRequestApprovedDatetime": "2019-08-24T14:15:22Z",
- "clearRequestComment": "string",
- "clearRequestedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "clearRequestedDatetime": "2019-08-24T14:15:22Z",
- "comment": "string",
- "completedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "completedDatetime": "2019-08-24T14:15:22Z",
- "contextElementReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "contractDataViewReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "createdByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "createdDatetime": "2019-08-24T14:15:22Z",
- "description": "string",
- "importDataViewReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "itemReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "modifiedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "modifiedDatetime": "2019-08-24T14:15:22Z",
- "noteSid": 0,
- "postedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "postedDatetime": "2019-08-24T14:15:22Z",
- "reversePeriodNumber": "2019-08-24T14:15:22Z",
- "sid": 1,
- "statusReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "systemModifiedDatetime": "2019-08-24T14:15:22Z",
- "tabSid": 0
}, - "errors": [
- { }
], - "warnings": [
- { }
], - "hasErrors": false,
- "hasWarnings": false
}
Execute the In Setup Tool on an existing Adjustment
Execute the In Setup Tool on an existing Adjustment.
OK
Bad Request
Forbidden
Not Found
Method Not Allowed
Internal Server Error
- 200
- 400
- 403
- 404
- 405
- 500
{- "result": null,
- "errors": [ ],
- "warnings": [ ],
- "hasErrors": false,
- "hasWarnings": false
}
Execute the Post Tool on an existing Adjustment
Execute the Post Tool on an existing Adjustment.
OK
Bad Request
Forbidden
Not Found
Method Not Allowed
Internal Server Error
- 200
- 400
- 403
- 404
- 405
- 500
{- "result": null,
- "errors": [ ],
- "warnings": [ ],
- "hasErrors": false,
- "hasWarnings": false
}