Reports

Get loan summaries

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

Response

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

Changed in 4 of the 51 revisions of this API.114

Aug 8, 2024619755636d1311See the full diff
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ○
  added the optional property // to the response with the status
  response-optional-property-added
Feb 13, 20240167fa08722e7See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
Oct 23, 20237ca7ffc3edf15See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
Sep 27, 2023adad52f540321See the full diff
- ○
  endpoint added
  endpoint-added

Full history