Commitments

Get Commitments

GET https://api.theairr.com/commitment

This endpoint allows you to get information about all Commitments in the Organization.

Headers

Name	Type	Description
X-API-KEY	string	API key for a particular Organization

200 Commitments data successfully retrieved.

{
    "id": b8229d06-008d-4881-8732-0dd72901c34e,
    "fundId": 56eb0247-c3c6-473b-b0b4-eb15ae2665c0,
    "fundName": "Kamchatka Fund I",
    "investorId": c193ce9d-6623-4c1e-a50d-85c8e056a206,
    "investorName": "ABC Co",
    "commitmentData": {
        "totalCommitment": 1000000,
        "totalDrawdowns": 500000,
        "totalDistributions": 42342
    },
    "commitmentRecords": [
        {
            "id": 5997e091-45fd-4166-8f4e-65b221afcc8a,
            "dateFrom": 2019-09-30,
            "amount": 10000000,
            "status": "New"
        }
    ]
}

Get Commitment

GET https://api.theairr.com/commitment/:commitmentId

This endpoint allows you to get information about a particular Commitment

Query Parameters

Name	Type	Description
commitmentId	string	ID of the Commitment

Headers

Name	Type	Description
X-API-KEY	string	API key for a particular Organization

200 Commitment data successfully retrieved

{
    "id": b8229d06-008d-4881-8732-0dd72901c34e,
    "fundId": 56eb0247-c3c6-473b-b0b4-eb15ae2665c0,
    "fundName": "Kamchatka Fund I",
    "investorId": c193ce9d-6623-4c1e-a50d-85c8e056a206,
    "investorName": "ABC Co",
    "commitmentData": {
        "totalCommitment": 1000000,
        "totalDrawdowns": 500000,
        "totalDistributions": 42342
    },
    "commitmentRecords": [
        {
            "id": 5997e091-45fd-4166-8f4e-65b221afcc8a,
            "dateFrom": 2019-09-30,
            "amount": 10000000,
            "status": "New"
        }
    ]
}

404 Commitment not found

{
    "timestamp":"2019-12-02T11:20:17.201+0000",
    "status":404,
    "error":"Not Found",
    "message":"Commitment not found",
    "path":"/commitment/564745a1-4964-420b-8c32-617737169050"
}