COcodatio
Reports

Get loan summaries

Changed on

The Get loan summaries endpoint returns a summary by integration type of all loans identified from a company's accounting, banking, and commerce integrations.

The endpoint returns a list of a company's loan summaries for each valid data connection.

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

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

Request

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

Response

OK

reportInfoLoanSummaryReportInfo (unresolved $ref)
reportItemsLoanSummaryReportItem[] (unresolved $ref)

Returns a summary of all loan activity for that integration type

Example response

{
  "reportInfo": {
    "reportName": "LoanSummaryReport",
    "companyName": "The Coffee shop",
    "generatedDate": "2022-10-23T00:00:00Z"
  },
  "reportItems": [
    {
      "recordRef": {
        "id": "string",
        "dataConnectionId": "DE34E8E3-089F-4DF4-89E9-F7C43618FCAAA",
        "integrationType": "Accounting",
        "recordRefType": "accounts"
      },
      "description": "string",
      "startDate": "2021-01-01",
      "totalInvestments": 100000,
      "totalRepayments": 83481.72,
      "balance": 42513.18,
      "lender": "Barclays Bank"
    }
  ]
}

Changes

  • 619755636d13Revision changes
    • warning

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

    • info

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

  • 0167fa08722eRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status