Visit Rightsline
logo
Powered by Redocly

Adjustments

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.

SecurityHeaderToken
Request
query Parameters
minimal
boolean

When you specify this Verbosity parameter, the _timestamp, _type, displayName, and guid properties are returned.

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 warnings property of the Standard Response.

Examples:
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 warnings property of the Standard Response.

Examples:
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
$filter
string

Use the $filter parameter to filter returned data Items in a manner similar to the Alliant User Applications column filter. This parameter uses the following format: {filterBy} {operator} {value}

  • filterBy is the name of a property, the name of a Reference property specified as referenceProperty.property, or the name of Reference property for quality or inequality comparisons to null.

  • operator – specify one of the following operators:

    Operator Description filterBy datatype
    contains Contains String/Text
    endswith Ends with String/Text
    startswith Starts with String/Text
    eq Equals String/Text, Integer, Small Integer, Flag/Boolean, Reference property eq null
    ne Does not equal String/Text, Integer, Small Integer, Flag/Boolean, Reference property ne null
    le Less than or equal to String/Text, Integer, Small Integer, Flag/Boolean, DateTime
    lt Less than String/Text, Integer, Small Integer, Flag/Boolean, DateTime
    ge Greater than or equal to String/Text, Integer, Small Integer, Flag/Boolean, DateTime
    gt Greater than String/Text, Integer, Small Integer, Flag/Boolean, DateTime

  • value is the value to which the operator is applied. The value should be enclosed in single quotes unless the value is an Integer or Small Integer

You can use the and and or operators to combine multiple filter parameter criteria.

Examples:
The response includes only data Items with a displayName value that contains 'rin'
$filter=displayName contains 'rin'
The response includes only data Items with a comment value that ends with 'ing'
$filter=comment endswith 'ing'
The response includes only data Items with a description value that starts with 'str'
$filter=description startswith 'str'
The response includes a single data Item with an id value equal to 'ABC123'
$filter=id eq 'ABC123'
The response includes only data Items with a udfVersionNumber value equal to 1
$filter=udfVersionNumber ge 1
The response includes only data Items with a displayName value that starts with 'rin' or data Items with a comment value that ends with 'ing' and data Items with description value that starts with 'str'
$filter=(displayName contains 'rin' or comment endswith 'ing') and description startswith 'str'
The response includes only data Items that have no Admin Class
$filter=adminClassReference eq null
$orderby
string

Use the $orderby parameter to specify the sort order of the returned data Items. You can specify a property or a property of a Reference property followed by asc or desc to sort returned data Items by a property in ascending or descending order.

Note: When this parameter is not specified, the returned data Items are sorted by Display Name in ascending order.

Examples:
ascending sort by property1
$orderby=property1
descending sort by property1 of the referenceProperty
$orderby=referenceProperty.property1 desc
$top
integer

Use the $top parameter to specify the maximum number of Items to return. When you do not specify this parameter, 20 Items are returned by default. When you specify the verbose parameter, the maximum number of Items that you can request 100. When you specify the minimal or default parameters, the maximum number of Items that you can request 1000. This query parameter combined with $skip query parameter can be used to facilitate paging.

Examples:
The response includes 30 data Items
$top=30
$skip
integer

Use the $skip parameter to specify the number of Items to skip from the first result. This query parameter combined with the $top query parameter can be used to facilitate paging. For example, $skip=20&$top=20 returns the second page of 20 Items.

Examples:
The response includes data Items that follow the first 30 data Items
$skip=30
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 _downloadUrl properties to download Attachments directly.

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.

Responses
200

Success

400

Bad Request

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/api/data/adjustmentHeaders
Response samples
application/json
{
  • "result": {
    },
  • "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.

SecurityHeaderToken
Request
query Parameters
minimal
boolean

When you specify this Verbosity parameter, the _timestamp, _type, displayName, and guid properties are returned.

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 warnings property of the Standard Response.

Examples:
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 warnings property of the Standard Response.

Examples:
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
required

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.

Responses
201

Created

400

Bad Request

403

Forbidden

404

Not Found

405

Method Not Allowed

409

Conflict

415

Unsupported Media Type

500

Internal Server Error

post/api/data/adjustmentHeaders
Request samples
application/json
{
  • "adjustmentTypeReference": "string",
  • "autoReverseFlag": true,
  • "comment": "string",
  • "contextElementReference": "string",
  • "description": "string",
  • "itemReference": "string",
  • "reversePeriodNumber": 0,
  • "adjustmentKeywords": [
    ],
  • "adjustmentNotes": [
    ],
  • "adjustmentCalcDetails": [
    ],
  • "adjustmentContractDetails": [
    ],
  • "adjustmentImportDetails": [
    ]
}
Response samples
application/json
{
  • "result": {
    },
  • "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.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Adjustment Unique Identity

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 _downloadUrl properties to download Attachments directly.

minimal
boolean

When you specify this Verbosity parameter, the _timestamp, _type, displayName, and guid properties are returned.

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 warnings property of the Standard Response.

Examples:
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 warnings property of the Standard Response.

Examples:
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.

Responses
200

Successful Operation

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/api/data/adjustmentHeaders/{guid}
Response samples
application/json
{
  • "result": {
    },
  • "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.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Adjustment Unique Identity

query Parameters
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.

Responses
200

OK

403

Forbidden

405

Method Not Allowed

409

Conflict

500

Internal Server Error

delete/api/data/adjustmentHeaders/{guid}
Response samples
application/json
{
  • "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.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Adjustment Unique Identity

query Parameters
minimal
boolean

When you specify this Verbosity parameter, the _timestamp, _type, displayName, and guid properties are returned.

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 warnings property of the Standard Response.

Examples:
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 warnings property of the Standard Response.

Examples:
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:

  • Timestamp properties that correspond to the Timestamp properties for all of the data Items (root and Child) that you want to update. When the _timestamp property is missing in the request body for any of the data Items, a 409 (Conflict) error response is returned.

  • Values for the Timestamp properties that correspond to the Timestamp values for the Items in Alliant. When the Timestamp values do not match, this endpoint returns a 409 (Conflict) error response.

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
required

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.

Responses
200

OK

400

Bad Request

403

Forbidden

404

Not Found

405

Method Not Allowed

409

Conflict

415

Unsupported Media Type

500

Internal Server Error

put/api/data/adjustmentHeaders/{guid}
Request samples
application/json
{
  • "adjustmentTypeReference": "string",
  • "autoReverseFlag": true,
  • "comment": "string",
  • "contextElementReference": "string",
  • "description": "string",
  • "itemReference": "string",
  • "reversePeriodNumber": 0,
  • "adjustmentKeywords": [
    ],
  • "adjustmentNotes": [
    ],
  • "adjustmentCalcDetails": [
    ],
  • "adjustmentContractDetails": [
    ],
  • "adjustmentImportDetails": [
    ]
}
Response samples
application/json
{
  • "result": {
    },
  • "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.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Adjustment Unique Identity

query Parameters
minimal
boolean

When you specify this Verbosity parameter, the _timestamp, _type, displayName, and guid properties are returned.

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 warnings property of the Standard Response.

Examples:
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 warnings property of the Standard Response.

Examples:
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:

  • Timestamp properties that correspond to the Timestamp properties for all of the data Items (root and Child) that you want to update. When the _timestamp property is missing in the request body for any of the data Items, a 409 (Conflict) error response is returned.

  • Values for the Timestamp properties that correspond to the Timestamp values for the Items in Alliant. When the Timestamp values do not match, this endpoint returns a 409 (Conflict) error response.

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
required

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.

Responses
200

OK

400

Bad Request

403

Forbidden

404

Not Found

405

Method Not Allowed

409

Conflict

415

Unsupported Media Type

500

Internal Server Error

patch/api/data/adjustmentHeaders/{guid}
Request samples
application/json
{
  • "adjustmentTypeReference": "string",
  • "autoReverseFlag": true,
  • "comment": "string",
  • "contextElementReference": "string",
  • "description": "string",
  • "itemReference": "string",
  • "reversePeriodNumber": 0,
  • "adjustmentKeywords": [
    ],
  • "adjustmentNotes": [
    ],
  • "adjustmentCalcDetails": [
    ],
  • "adjustmentContractDetails": [
    ],
  • "adjustmentImportDetails": [
    ]
}
Response samples
application/json
{
  • "result": {
    },
  • "errors": [
    ],
  • "warnings": [
    ],
  • "hasErrors": false,
  • "hasWarnings": false
}

Execute the Approve Tool on an existing Adjustment

Execute the Approve Tool on an existing Adjustment.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Adjustment Unique Identity

query Parameters
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
comment
required
string (Comment) <= 1000 characters

Specify the Approval or Clear Approval Comment for the Adjustment.

Responses
200

OK

400

Bad Request

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

put/api/data/adjustmentHeaders/approve/{guid}
Request samples
application/json
{
  • "comment": "string"
}
Response samples
application/json
{
  • "result": null,
  • "errors": [ ],
  • "warnings": [ ],
  • "hasErrors": false,
  • "hasWarnings": false
}

Execute the Clear Tool on an existing Adjustment

Execute the Clear Tool on an existing Adjustment.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Adjustment Unique Identity

query Parameters
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.

Responses
200

OK

400

Bad Request

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

put/api/data/adjustmentHeaders/clear/{guid}
Response samples
application/json
{
  • "result": null,
  • "errors": [ ],
  • "warnings": [ ],
  • "hasErrors": false,
  • "hasWarnings": false
}

Execute the ClearRequest Tool on an existing Adjustment

Execute the ClearRequest Tool on an existing Adjustment.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Adjustment Unique Identity

query Parameters
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
comment
required
string (Comment) <= 1000 characters

Specify the Clear Request Comment for the Adjustment.

Responses
200

OK

400

Bad Request

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

put/api/data/adjustmentHeaders/clearRequest/{guid}
Request samples
application/json
{
  • "comment": "string"
}
Response samples
application/json
{
  • "result": null,
  • "errors": [ ],
  • "warnings": [ ],
  • "hasErrors": false,
  • "hasWarnings": false
}

Execute the Complete Tool on an existing Adjustment

Execute the Complete Tool on an existing Adjustment.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Adjustment Unique Identity

query Parameters
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.

Responses
200

OK

400

Bad Request

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

put/api/data/adjustmentHeaders/complete/{guid}
Response samples
application/json
{
  • "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.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Adjustment Unique Identity

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 _downloadUrl properties to download Attachments directly.

minimal
boolean

When you specify this Verbosity parameter, the _timestamp, _type, displayName, and guid properties are returned.

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 warnings property of the Standard Response.

Examples:
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 warnings property of the Standard Response.

Examples:
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.

Responses
200

Successful Operation

403

Forbidden

404

Not Found

405

Method Not Allowed

415

Unsupported Media Type

500

Internal Server Error

put/api/data/adjustmentHeaders/copy/{guid}
Request samples
application/json
{
  • "copyNotes": true,
  • "reverseCopiedDetails": true
}
Response samples
application/json
{
  • "result": {
    },
  • "errors": [
    ],
  • "warnings": [
    ],
  • "hasErrors": false,
  • "hasWarnings": false
}

Execute the In Setup Tool on an existing Adjustment

Execute the In Setup Tool on an existing Adjustment.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Adjustment Unique Identity

query Parameters
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.

Responses
200

OK

400

Bad Request

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

put/api/data/adjustmentHeaders/insetup/{guid}
Response samples
application/json
{
  • "result": null,
  • "errors": [ ],
  • "warnings": [ ],
  • "hasErrors": false,
  • "hasWarnings": false
}

Execute the Post Tool on an existing Adjustment

Execute the Post Tool on an existing Adjustment.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Adjustment Unique Identity

query Parameters
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.

Responses
200

OK

400

Bad Request

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

put/api/data/adjustmentHeaders/post/{guid}
Response samples
application/json
{
  • "result": null,
  • "errors": [ ],
  • "warnings": [ ],
  • "hasErrors": false,
  • "hasWarnings": false
}
➔ Next to Computed Dates