COcodatio
Reports

List loan transactions

Changed on

The List loan transactions endpoint returns all loan transactions identified from a company's accounting, banking, and commerce integrations.

This detail gives analysts a better idea of the loan obligations a company may have.

Make sure you have synced a company recently before calling the endpoint.

get/companies/{companyId}/reports/liabilities/loans/transactions

Request

  • Base URL
    https://api.codat.io
  • URL
    https://api.codat.io/companies/{companyId}/reports/liabilities/loans/transactions
  • Auth
    API key in header Authorization

Response

OK

reportInfoLoanTransactionsReportInfo (unresolved $ref)
reportItemsReportItems[] (unresolved $ref)

Contains object of reporting properties. The loan ref will reference a different object depending on the integration type.

Example response

{
  "reportInfo": {
    "pageNumber": 1,
    "pageSize": 1000,
    "totalResults": 1,
    "reportName": "AccountingLoanTransactions",
    "companyName": "Supermarket store",
    "generatedDate": "2022-10-23T00:00:00Z"
  },
  "reportItems": [
    {
      "loanRef": {
        "id": "332",
        "dataConnectionId": "ecd2d6be-5194-40a1-838f-5577a4881aaa",
        "type": "chartOfAccount"
      },
      "itemRef": {
        "id": "755488",
        "dataConnectionId": "ecd2d6be-5194-40a1-838f-5577a4881aaa",
        "type": "journalEntry"
      },
      "date": "2020-08-02",
      "amount": -455,
      "transactionType": "Repayment",
      "lender": "Barclays Bank"
    }
  ]
}

Changes

  • ffdd6f0dd24bRevision changes
    • warning

      removed the optional property from the response with the status

  • 31551ff4fd5cRevision changes
    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property // to the response with the status