Visit Rightsline
logo
Powered by Redocly

Payments

Get multiple Payments

Read the data for multiple Payments.

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
contextReplace
string

Use this parameter to specify the properties with context replaced values in the response, separated by commas. You can also specify that you want to context replace values for all properties by specifying all.

Note: When the values specified in the contextReplace parameter are not valid, the query parameter is ignored.

Examples:
displayName and ud_UDField1 properties in the response have context replaced values.
contextReplace=displayName,ud_UDField1
All properties in the response have context replaced values.
contextReplace=all
$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/payments
Response samples
application/json
{
  • "result": {
    },
  • "errors": [ ],
  • "warnings": [ ],
  • "hasErrors": false,
  • "hasWarnings": false
}

Create a new Payment

Create a new payment.

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
contextReplace
string

Use this parameter to specify the properties with context replaced values in the response, separated by commas. You can also specify that you want to context replace values for all properties by specifying all.

Note: When the values specified in the contextReplace parameter are not valid, the query parameter is ignored.

Examples:
displayName and ud_UDField1 properties in the response have context replaced values.
contextReplace=displayName,ud_UDField1
All properties in the response have context replaced values.
contextReplace=all
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 Payment

ID (object) or description (object) or SID (object) or GUID (object) (Admin Class)

Specify the Admin Class for the Payment.

amount1
required
number
checkIssuedDatetime
string <date-time> (Datetime)
checkNumberID
string
comment
string (Comment) <= 1000 characters

Specify any additional information for the Payment, when applicable.

ID (object) or description (object) or SID (object) or GUID (object) (Reference)

Define the reference using an ID, Description, SID, or GUID value.

ID (object) or description (object) or SID (object) or GUID (object) (Reference)

Define the reference using an ID, Description, SID, or GUID value.

ID (object) or description (object) or SID (object) or GUID (object) (Reference)

Define the reference using an ID, Description, SID, or GUID value.

description
required
string (description) [ 1 .. 255 ] characters

Specify the unique description for the Payment.

dueDatetime
required
string <date-time> (Datetime)
id
required
string (ID) [ 1 .. 60 ] characters unique

Specify the unique “name” of the Payment.

Array of objects (Attachments Child Collection Request)

Payment Attachments

Array of objects (Keywords Child Collection Request)

Payment Keywords

Array of objects (Links Child Collection Request)

Payment Links

Array of objects (Notes Child Collection Request)

Payment Notes

Array of objects (Reminders Child Collection Request)

Payment Reminders

The required properties vary based on the _action that you are performing and the values that you specify.

ID (object) or description (object) or SID (object) or GUID (object) (Reference)

Define the reference using an ID, Description, SID, or GUID value.

ID (object) or description (object) or SID (object) or GUID (object) (Reference)

Define the reference using an ID, Description, SID, or GUID value.

required
ID (object) or description (object) or SID (object) or GUID (object) (Reference)

Define the reference using an ID, Description, SID, or GUID value.

ud_userDefinedStringField
string (ud_userDefinedStringField_Request)

Specify values for the single-value string UD Fields for the Item, when applicable. These UD Fields use the name of the UD Field prefixed with ud_ (for example, when the UD Field name is ''''title'''', the UD Field property name in the collection is ud_title. The UD Fields associated with the Item depend on the configuration, including the Admin Class and the data populated for the Item.

ud_userDefinedNumberField
number (ud_userDefinedNumberField_Request)

Specify values for the single-value numerical UD Fields for the Item, when applicable. These UD Fields use the name of the UD Field prefixed with ud_ (for example, when the UD Field name is ''''weighting'''', the UD Field property name in the collection is ud_weighting. The UD Fields associated with the Item depend on the configuration, including the Admin Class and the data populated for the Item.

ID (string) or description (string) or SID (number) or GUID (string) (ud_userDefinedReferenceRequest)

Single-value Reference UD Fields for an Item are included in the collection with the Name of the UD Field prefixed with ud_ and suffixed with Reference (for example, when the UD Field name is ''''territory'''', the UD Field property name in the collection is ud_territoryReference. The UD Fields included depend on the configuration, including the Admin Class and the data populated for the Item. Define the reference using an ID, Description, SID, or GUID value.

object (udLookup_LookupUDFieldRequest)

When you send a POST or PUT request for an Item that includes a Lookup UD Field and you want to modify the Lookup UD Field data, use the _action property to specify whether to add, update, or delete the corresponding Child Collection data. The properties shown below are examples of the properties that can be sent. The actual set of properties necessary varies based on the configuration on the Lookup UD Field and the data that you want to add, update, or delete. Lookup UD Fields for an Item are included in the collection with the Name of the UD Field prefixed with udLookup_. For example, when the Lookup UD Field name is tiers, the Lookup UD Field property name in the collection is udLookup_tiers. The UD Fields included depend on the configuration, including the Admin Class and the data populated for the Item.

ID (object) or description (object) or SID (object) or GUID (object) (Reference)

Define the reference using an ID, Description, SID, or GUID value.

udKeyXSID
number
Responses
201

Created

400

Bad Request

403

Forbidden

404

Not Found

405

Method Not Allowed

409

Conflict

500

Internal Server Error

post/api/data/payments
Request samples
application/json
{
  • "adminClassReference": {
    },
  • "amount1": 5000,
  • "id": "New Payment",
  • "comment": "New Payment comment",
  • "contractReference": {
    },
  • "description": "New Payment",
  • "dueDatetime": "3/05/2025",
  • "recipientContactReference": {
    }
}
Response samples
application/json
{
  • "result": {
    },
  • "errors": [
    ],
  • "warnings": [
    ],
  • "hasErrors": false,
  • "hasWarnings": false
}

Get a single Payment

Read the data for a specific Payment.

A Payment is an on-line data item that relates to a legal agreement between your company and an individual or company. In general, each Payment can define the related Participants, Recipients, Recipient Groups, Products, Deals, IP Rights, IP Rights Templates, Statement Schedule, Scope, System Events, User-Defined Fields (UD Fields), and so forth.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Payment 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
contextReplace
string

Use this parameter to specify the properties with context replaced values in the response, separated by commas. You can also specify that you want to context replace values for all properties by specifying all.

Note: When the values specified in the contextReplace parameter are not valid, the query parameter is ignored.

Examples:
displayName and ud_UDField1 properties in the response have context replaced values.
contextReplace=displayName,ud_UDField1
All properties in the response have context replaced values.
contextReplace=all
getWarnings
boolean

When you specify this parameter, warning validation messages are returned.

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/payments/{guid}
Response samples
application/json
{
  • "result": {
    },
  • "errors": [
    ],
  • "warnings": [
    ],
  • "hasErrors": false,
  • "hasWarnings": false
}

Delete a Payment

Delete a specific Payment.

TODO for Product Team

SecurityHeaderToken
Request
path Parameters
guid
required
string

Payment 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/payments/{guid}
Response samples
application/json
{
  • "result": null,
  • "errors": [ ],
  • "warnings": [ ],
  • "hasErrors": false,
  • "hasWarnings": false
}

Update a Payment

Update the data for a specific Payment.

TODO for Product Team

The request body that you submit should include all of the properties that you want to update. When you want to update a UD Field Lookup Item, Child Data Item, Cross-Reference Item, or Adjustments on Tab Item, you must specify a value for the _action subproperty. The following actions are available for UD Field Lookup Items, Child Data Items, and Adjustments on Tab:

· 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.

The following actions are available for Cross-Reference Items:

· add – specify this action when you want to add a Cross-Reference Item.

· update – specify this action when you want to update data for a Cross-Reference 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

Payment 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
contextReplace
string

Use this parameter to specify the properties with context replaced values in the response, separated by commas. You can also specify that you want to context replace values for all properties by specifying all.

Note: When the values specified in the contextReplace parameter are not valid, the query parameter is ignored.

Examples:
displayName and ud_UDField1 properties in the response have context replaced values.
contextReplace=displayName,ud_UDField1
All properties in the response have context replaced values.
contextReplace=all
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 Payment

ID (object) or description (object) or SID (object) or GUID (object) (Admin Class)

Specify the Admin Class for the Payment.

amount1
number
checkIssuedDatetime
string <date-time> (Datetime)
checkNumberID
string
comment
string (Comment) <= 1000 characters

Specify any additional information for the Payment, when applicable.

ID (object) or description (object) or SID (object) or GUID (object) (Reference)

Define the reference using an ID, Description, SID, or GUID value.

ID (object) or description (object) or SID (object) or GUID (object) (Reference)

Define the reference using an ID, Description, SID, or GUID value.

ID (object) or description (object) or SID (object) or GUID (object) (Reference)

Define the reference using an ID, Description, SID, or GUID value.

description
string (description) [ 1 .. 255 ] characters

Specify the unique description for the Payment.

dueDatetime
string <date-time> (Datetime)
id
string (ID) [ 1 .. 60 ] characters unique

Specify the unique “name” of the Payment.

Array of objects (Attachments Child Collection Request)

Payment Attachments

Array of objects (Keywords Child Collection Request)

Payment Keywords

Array of objects (Links Child Collection Request)

Payment Links

Array of objects (Notes Child Collection Request)

Payment Notes

Array of objects (Reminders Child Collection Request)

Payment Reminders

The required properties vary based on the _action that you are performing and the values that you specify.

ID (object) or description (object) or SID (object) or GUID (object) (Reference)

Define the reference using an ID, Description, SID, or GUID value.

ID (object) or description (object) or SID (object) or GUID (object) (Reference)

Define the reference using an ID, Description, SID, or GUID value.

ID (object) or description (object) or SID (object) or GUID (object) (Reference)

Define the reference using an ID, Description, SID, or GUID value.

ud_userDefinedStringField
string (ud_userDefinedStringField_Request)

Specify values for the single-value string UD Fields for the Item, when applicable. These UD Fields use the name of the UD Field prefixed with ud_ (for example, when the UD Field name is ''''title'''', the UD Field property name in the collection is ud_title. The UD Fields associated with the Item depend on the configuration, including the Admin Class and the data populated for the Item.

ud_userDefinedNumberField
number (ud_userDefinedNumberField_Request)

Specify values for the single-value numerical UD Fields for the Item, when applicable. These UD Fields use the name of the UD Field prefixed with ud_ (for example, when the UD Field name is ''''weighting'''', the UD Field property name in the collection is ud_weighting. The UD Fields associated with the Item depend on the configuration, including the Admin Class and the data populated for the Item.

ID (string) or description (string) or SID (number) or GUID (string) (ud_userDefinedReferenceRequest)

Single-value Reference UD Fields for an Item are included in the collection with the Name of the UD Field prefixed with ud_ and suffixed with Reference (for example, when the UD Field name is ''''territory'''', the UD Field property name in the collection is ud_territoryReference. The UD Fields included depend on the configuration, including the Admin Class and the data populated for the Item. Define the reference using an ID, Description, SID, or GUID value.

object (udLookup_LookupUDFieldRequest)

When you send a POST or PUT request for an Item that includes a Lookup UD Field and you want to modify the Lookup UD Field data, use the _action property to specify whether to add, update, or delete the corresponding Child Collection data. The properties shown below are examples of the properties that can be sent. The actual set of properties necessary varies based on the configuration on the Lookup UD Field and the data that you want to add, update, or delete. Lookup UD Fields for an Item are included in the collection with the Name of the UD Field prefixed with udLookup_. For example, when the Lookup UD Field name is tiers, the Lookup UD Field property name in the collection is udLookup_tiers. The UD Fields included depend on the configuration, including the Admin Class and the data populated for the Item.

ID (object) or description (object) or SID (object) or GUID (object) (Reference)

Define the reference using an ID, Description, SID, or GUID value.

udKeyXSID
number
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/payments/{guid}
Request samples
application/json
{
  • "amount1": 4000,
  • "comment": "New Comment",
  • "description": "Updated Payment",
  • "id": "Updated Payment"
}
Response samples
application/json
{
  • "result": {
    },
  • "errors": [
    ],
  • "warnings": [
    ],
  • "hasErrors": false,
  • "hasWarnings": false
}

Update a Payment

Update the data for a specific Payment.

TODO For Product Team

The request body that you submit should include all of the properties that you want to update. When you want to update a UD Field Lookup Item, Child Data Item, Cross-Reference Item, or Adjustments on Tab Item, you must specify a value for the _action subproperty. The following actions are available for UD Field Lookup Items, Child Data Items, and Adjustments on Tab:

· 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.

The following actions are available for Cross-Reference Items:

· add – specify this action when you want to add a Cross-Reference Item.

· update – specify this action when you want to update data for a Cross-Reference 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

Payment 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
contextReplace
string

Use this parameter to specify the properties with context replaced values in the response, separated by commas. You can also specify that you want to context replace values for all properties by specifying all.

Note: When the values specified in the contextReplace parameter are not valid, the query parameter is ignored.

Examples:
displayName and ud_UDField1 properties in the response have context replaced values.
contextReplace=displayName,ud_UDField1
All properties in the response have context replaced values.
contextReplace=all
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 Payment

ID (object) or description (object) or SID (object) or GUID (object) (Admin Class)

Specify the Admin Class for the Payment.

amount1
number
checkIssuedDatetime
string <date-time> (Datetime)
checkNumberID
string
comment
string (Comment) <= 1000 characters

Specify any additional information for the Payment, when applicable.

ID (object) or description (object) or SID (object) or GUID (object) (Reference)

Define the reference using an ID, Description, SID, or GUID value.

ID (object) or description (object) or SID (object) or GUID (object) (Reference)

Define the reference using an ID, Description, SID, or GUID value.

ID (object) or description (object) or SID (object) or GUID (object) (Reference)

Define the reference using an ID, Description, SID, or GUID value.

description
string (description) [ 1 .. 255 ] characters

Specify the unique description for the Payment.

dueDatetime
string <date-time> (Datetime)
id
string (ID) [ 1 .. 60 ] characters unique

Specify the unique “name” of the Payment.

Array of objects (Attachments Child Collection Request)

Payment Attachments

Array of objects (Keywords Child Collection Request)

Payment Keywords

Array of objects (Links Child Collection Request)

Payment Links

Array of objects (Notes Child Collection Request)

Payment Notes

Array of objects (Reminders Child Collection Request)

Payment Reminders

The required properties vary based on the _action that you are performing and the values that you specify.

ID (object) or description (object) or SID (object) or GUID (object) (Reference)

Define the reference using an ID, Description, SID, or GUID value.

ID (object) or description (object) or SID (object) or GUID (object) (Reference)

Define the reference using an ID, Description, SID, or GUID value.

ID (object) or description (object) or SID (object) or GUID (object) (Reference)

Define the reference using an ID, Description, SID, or GUID value.

ud_userDefinedStringField
string (ud_userDefinedStringField_Request)

Specify values for the single-value string UD Fields for the Item, when applicable. These UD Fields use the name of the UD Field prefixed with ud_ (for example, when the UD Field name is ''''title'''', the UD Field property name in the collection is ud_title. The UD Fields associated with the Item depend on the configuration, including the Admin Class and the data populated for the Item.

ud_userDefinedNumberField
number (ud_userDefinedNumberField_Request)

Specify values for the single-value numerical UD Fields for the Item, when applicable. These UD Fields use the name of the UD Field prefixed with ud_ (for example, when the UD Field name is ''''weighting'''', the UD Field property name in the collection is ud_weighting. The UD Fields associated with the Item depend on the configuration, including the Admin Class and the data populated for the Item.

ID (string) or description (string) or SID (number) or GUID (string) (ud_userDefinedReferenceRequest)

Single-value Reference UD Fields for an Item are included in the collection with the Name of the UD Field prefixed with ud_ and suffixed with Reference (for example, when the UD Field name is ''''territory'''', the UD Field property name in the collection is ud_territoryReference. The UD Fields included depend on the configuration, including the Admin Class and the data populated for the Item. Define the reference using an ID, Description, SID, or GUID value.

object (udLookup_LookupUDFieldRequest)

When you send a POST or PUT request for an Item that includes a Lookup UD Field and you want to modify the Lookup UD Field data, use the _action property to specify whether to add, update, or delete the corresponding Child Collection data. The properties shown below are examples of the properties that can be sent. The actual set of properties necessary varies based on the configuration on the Lookup UD Field and the data that you want to add, update, or delete. Lookup UD Fields for an Item are included in the collection with the Name of the UD Field prefixed with udLookup_. For example, when the Lookup UD Field name is tiers, the Lookup UD Field property name in the collection is udLookup_tiers. The UD Fields included depend on the configuration, including the Admin Class and the data populated for the Item.

ID (object) or description (object) or SID (object) or GUID (object) (Reference)

Define the reference using an ID, Description, SID, or GUID value.

udKeyXSID
number
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/payments/{guid}
Request samples
application/json
{
  • "amount1": 4000,
  • "comment": "New Comment",
  • "description": "Updated Payment",
  • "id": "Updated Payment"
}
Response samples
application/json
{
  • "result": {
    },
  • "errors": [
    ],
  • "warnings": [
    ],
  • "hasErrors": false,
  • "hasWarnings": false
}

Execute the Approve Tool on an existing Payment

Execute the Approve Tool on an existing Payment.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Payment 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 comment for the Payment.

Responses
200

OK

400

Bad Request

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

put/api/data/payments/approve/{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 Payment

Execute the Complete Tool on an existing Payment.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Payment 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/payments/complete/{guid}
Response samples
application/json
{
  • "result": null,
  • "errors": [ ],
  • "warnings": [ ],
  • "hasErrors": false,
  • "hasWarnings": false
}

Execute the Copy Tool on an existing Payment

Execute the Copy Tool on an existing Payment.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Payment 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
contextReplace
string

Use this parameter to specify the properties with context replaced values in the response, separated by commas. You can also specify that you want to context replace values for all properties by specifying all.

Note: When the values specified in the contextReplace parameter are not valid, the query parameter is ignored.

Examples:
displayName and ud_UDField1 properties in the response have context replaced values.
contextReplace=displayName,ud_UDField1
All properties in the response have context replaced values.
contextReplace=all
getWarnings
boolean

When you specify this parameter, warning validation messages are returned.

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 include the Notes, Reminders, Attachments, and Links associated with the Contract with the copy of the Contract.

Responses
200

Successful Operation

403

Forbidden

404

Not Found

405

Method Not Allowed

415

Unsupported Media Type

500

Internal Server Error

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

Execute the Hold Tool on an existing Payment

Execute the Hold Tool on an existing Payment.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Payment 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/payments/hold/{guid}
Response samples
application/json
{
  • "result": null,
  • "errors": [ ],
  • "warnings": [ ],
  • "hasErrors": false,
  • "hasWarnings": false
}

Execute the In Setup Tool on an existing Payment

Execute the In Setup Tool on an existing Payment.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Payment 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/payments/insetup/{guid}
Response samples
application/json
{
  • "result": null,
  • "errors": [ ],
  • "warnings": [ ],
  • "hasErrors": false,
  • "hasWarnings": false
}

Execute the Release Tool on an existing Payment

Execute the Release Tool on an existing Payment.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Payment 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/payments/release/{guid}
Response samples
application/json
{
  • "result": null,
  • "errors": [ ],
  • "warnings": [ ],
  • "hasErrors": false,
  • "hasWarnings": false
}

Execute the Paid Tool on an existing Payment

Execute the Paid Tool on an existing Payment.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Payment 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/payments/paid/{guid}
Response samples
application/json
{
  • "result": null,
  • "errors": [ ],
  • "warnings": [ ],
  • "hasErrors": false,
  • "hasWarnings": false
}
➔ Next to Process Server Groups