top of page

200: OK

REQUIRED

Response

https://api.theairr.com/transaction/:transactionType

API key for a particular Organization

string

X-API-KEY

Transactions
Get Transactions
GET

Request

Query Parameters

This endpoint allows you to get all the Transactions in the Organization.

Transactions data successfully retrieved. It depends on the transaction type, if the transaction has got Investor, Investment, Round, Fund, or Service Provider.

{
    "id": b8229d06-008d-4881-8732-0dd72901c34e,
    "transactionType": "DRAWDOWN",
    "fundId": c193ce9d-6623-4c1e-a50d-85c8e056a206,
    "fundName": "Kamchatka Fund I",
    "investorId": c193ce9d-6623-4c1e-a50d-85c8e056a206,
    "investorName": "ABC Co",   
    "investmentId": null,
    "investmentName": null,
    "roundId": null,
    "roundName": null,
    "serviceProviderId": null,
    "serviceProviderName": null,        
    "name": "Drawdown 1",
    "description": "First drawdown",
    "type": null,
    "amount": 10000000,
    "amountConverted": 10434000,
    "date": 2019-09-30,
    "source": "Xero",
    "currencyCode": "EUR",
    "currencyRate": 1.0434,
    "reference": "First drawdown reference"
},
{
...
}

https://api.theairr.com/transaction/:transactionType/:transactionId

Get Transaction
GET

This endpoint allows you to get information about a particular Transaction.

Request

REQUIRED

API key for a particular Organization

string

X-API-KEY

Headers

Response

200: OK

Transaction data successfully retrieved

Query Parameters

REQUIRED

transactionId

string

ID of the Transaction

404: Not Found

Transaction not found

{
    "id": b8229d06-008d-4881-8732-0dd72901c34e,
    "transactionType": "DRAWDOWN",
    "fundId": c193ce9d-6623-4c1e-a50d-85c8e056a206,
    "fundName": "Kamchatka Fund I",
    "investorId": c193ce9d-6623-4c1e-a50d-85c8e056a206,
    "investorName": "ABC Co",   
    "investmentId": null,
    "investmentName": null,
    "roundId": null,
    "roundName": null,
    "serviceProviderId": null,
    "serviceProviderName": null,        
    "name": "Drawdown 1",
    "description": "First drawdown",
    "type": null,
    "amount": 10000000,
    "amountConverted": 10434000,
    "date": 2019-09-30,
    "source": "Xero",
    "currencyCode": "EUR",
    "currencyRate": 1.0434,
    "reference": "First drawdown reference"
}

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

REQUIRED

Type of the Transaction. Possible values: drawdown, distribution, dividend, investment_transaction, expense, management_fee, loan_received

string

transactionType

Headers

transactionType

REQUIRED

string

Type of the Transaction. Possible values: drawdown, distribution, dividend, investment_transaction, expense, management_fee, loan_received

bottom of page