Create Checklist Items

post https://example.com/lending/web/Lending/{Company}/{AccountNumber}/Checklists

Path Params

Company

string

required

The GET /System/Companies endpoint from the System Admin specification can be used to find an available value for this path parameter.

AccountNumber

integer

required

The GET /Lending endpoint, where the AccountNumber query parameter is utilized, from the Lending specification can be used to find an available value for this parameter.

Body Params

Company

string

Company code of company associated with a checklist item.

InstrumentNumber

int64

Instrument number of instrument associated with a checklist item.

ChecklistType

string

A component that identifies a unique checklist item. It contains properties that determine some of the default settings, and behavior of the checklist item.

SequenceNumber

integer

One of the components that identifies a unique checklist item. A new checklist item will be assigned with a new sequence number.

DueDate

date-time

Required due date of a checklist item.

ReceivedDate

date-time

The date the checklist item has been received.

IsRequired

boolean

This flag determines whether or not the required checklist item is required.

ItemDescription

string

Description of a checklist item.

Notes

string

Notes attached to a checklist item.

ExpiryDate

date-time

Expiry date of a checklist item, if applicable.

Amount

number

Amount associated with a checklist item, if applicable. For example, confirmation of 20,000 down payment.

FileAttached

boolean

This flag indicates whether any document is attached to a checklist item.

ChecklistDocument

object

Responses

Response body

object

data

object

Company

string

Company code of company associated with a checklist item.

SubSystem

string

Subsystem code of subsystem associated with a checklist item.

InstrumentNumber

int64

Instrument number of instrument associated with a checklist item.

ChecklistType

string

A component that identifies a unique checklist item. It contains properties that determine some of the default settings, and behavior of the checklist item.

SequenceNumber

integer

One of the components that identifies a unique checklist item. A new checklist item will be assigned with a new sequence number.

DueDate

date-time

Required due date of a checklist item.

ReceivedDate

date-time

The date the checklist item has been received.

IsRequired

boolean

This flag determines whether or not the required checklist item is required.

ItemDescription

string

Description of a checklist item.

Notes

string

Notes attached to a checklist item.

ExpiryDate

date-time

Expiry date of a checklist item, if applicable.

Amount

number

Amount associated with a checklist item, if applicable. For example, confirmation of 20,000 down payment.

FileAttached

boolean

This flag indicates whether any document is attached to a checklist item.

ChecklistDocument

object

401

User is not authorized for this operation

403

User does not have the authority to perform the requested action

500

An error occurred on the backend server

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request POST \
2
     --url https://example.com/lending/web/Lending/Company/AccountNumber/Checklists \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
23
 
1
{
2
  "data": {
3
    "Company": "ppf",
4
    "SubSystem": "sd",
5
    "InstrumentNumber": 20,
6
    "ChecklistType": "GEN",
7
    "SequenceNumber": 1,
8
    "DueDate": "2019-05-22T05:27:58.491Z",
9
    "ReceivedDate": "2019-04-22T05:27:58.491Z",
10
    "IsRequired": false,
11
    "ItemDescription": "Confirmation of down payment.",
12
    "Notes": "This is a sample sentence in a checklist note.",
13
    "ExpiryDate": "2025-04-22T05:27:58.491Z",
14
    "Amount": 20000,
15
    "FileAttached": true,
16
    "ChecklistDocument": {
17
      "FileContent": "aGVsbG8gd29ybGQ=",
18
      "FileName": "hello.txt",
19
      "FileType": "text/plain",
20
      "FileLocation": "/u/ppout/public/Image/Retail/73"
21
    }
22
  }
23
}

201Checklist Item Created Successfully

400Unable to understand the request, due to invalid syntax

404The requested resource could not be found