Retrieve financial document template

Get financial document template

GET https://ris.rightsline.com/v4/financial-document-templates/:id

This endpoint allows you to get a financial document template.

Path Parameters

NameTypeDescription

id

number

Template ID.

Headers

NameTypeDescription

x-api-key

string

Your company's API key.

Authentication

string

Authentication token.

{
    "fields": [
        {
            "fieldName": "Invoice Template",
            "label": "entity_template",
            "required": true,
            "maxLength": 1000,
            "editable": false,
            "dataType": "AlphaNumericText",
            "allowMultiple": false,
            "sequenceNumber": 1,
            "groupId": 2,
            "listOfValues": []
        },
        {
            "fieldName": "Invoice Title",
            "label": "entity_title",
            "required": true,
            "maxLength": 5000,
            "editable": true,
            "dataType": "AlphaNumericText",
            "allowMultiple": false,
            "sequenceNumber": 1,
            "groupId": 1,
            "listOfValues": []
        },
        {
            "fieldName": "Invoice ID",
            "label": "entity_id",
            "required": true,
            "maxLength": 50,
            "editable": false,
            "dataType": "AlphaNumericText",
            "allowMultiple": false,
            "sequenceNumber": 2,
            "groupId": 2,
            "listOfValues": []
        },
        {
            "fieldName": "Due Date",
            "label": "due_date",
            "required": true,
            "maxLength": 25,
            "editable": true,
            "dataType": "Date_US",
            "allowMultiple": false,
            "sequenceNumber": 2,
            "groupId": 1,
            "listOfValues": []
        },
        {
            "fieldName": "Revision ID",
            "label": "entity_revision_id",
            "required": true,
            "maxLength": 50,
            "editable": false,
            "dataType": "AlphaNumericText",
            "allowMultiple": false,
            "sequenceNumber": 3,
            "groupId": 2,
            "listOfValues": []
        },
        {
            "fieldName": "Payment Date",
            "label": "payment_date",
            "required": false,
            "maxLength": 25,
            "editable": true,
            "dataType": "Date_US",
            "allowMultiple": false,
            "sequenceNumber": 3,
            "groupId": 1,
            "listOfValues": []
        }
    ],
    "templateId": 2,
    "templateName": "Check Request",
    "systemIndicatorId": 2015,
    "processId": 10,
    "processName": "Billing Doc Workflow",
    "parentRelationships": [
        {
            "charTypeID": 3,
            "templateID": 41,
            "templateName": "COPY Rights In",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 3,
            "templateID": 43,
            "templateName": "Hvo test hidden",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        }
    ],
    "childRelationships": [
        {
            "charTypeID": 1,
            "templateID": 12,
            "templateName": "Series",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 1,
            "templateID": 1,
            "templateName": "Feature",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        }
    ],
    "partyRelationships": [
        {
            "partyID": 2,
            "partyName": "Billing Party",
            "partyGroup": {
                "partyGroupID": 6
            },
            "sequenceNumber": 1,
            "isPrimary": false,
            "allowMultiple": true,
            "required": false,
            "systemIndicatorID": 2033,
            "allowedTemplates": [
                {
                    "templateId": 2,
                    "templateName": "Company",
                    "systemIndicatorId": 0,
                    "processId": 0
                },
                {
                    "templateId": 4,
                    "templateName": "Corporate",
                    "systemIndicatorId": 0,
                    "processId": 0
                }
            ]
        }
    ]
}

Last updated