Create an amount

post
Create amount

https://api.rightsline.com/v3/amount
This endpoint allows you to create a new amount.
Request
Response
Request
Headers
x-api-key
required
string
Your company's API key.
Authentication
required
string
Authentication token.
Body Parameters
title
required
string
The title of the new amount.
template
required
object
The template of the new amount.
template.templateId
required
string
The unique ID of the template to assign to the amount.
characteristics
required
object
The field values to assign to the amount.
parentRelationship
optional
array
Create this amount as a child of another entity.
Response
200: OK
Amount created successfully. Returns the ID of the new entity.
123456
400: Bad Request
Request is missing required information, or the information is invalid.
{
"message": "TemplateId is required"
}

Example: Create an amount as a child of a Financial Document

{
"title": "Test Amount Record",
"template": {
"templateId": 1
},
"characteristics": {
"amount": {
"locAmt": "90",
"locCur": 1,
"locSym": "USD"
}
},
"parentRelationship": [
{
"parentRecordId": 7,
"parentcharTypeId": 100
}
]
}