Skip to main content
POST
/
reports
/
lending
Create Lending Report
curl --request POST \
  --url https://api.copper.co/platform/reports/lending \
  --header 'Content-Type: application/json' \
  --data '
{
  "organizationId": "<string>",
  "reportType": "outstanding-loans-report",
  "fromDate": "<string>",
  "loanSide": "lend",
  "toDate": "<string>"
}
'
{}

Body

application/json
​
organizationId
string
required

Unique ID of the organisation

​
reportType
enum<string>
required

The type of the report to generate. See details

Available options:
outstanding-loans-report,
loan-activity-report,
loan-fees-report
Example:

"outstanding-loans-report,loan-activity-report,loan-fees-report"

​
fromDate
string

Optional date when provided the report will only contain lending information from this date onward (inclusive)

​
loanSide
enum<string>

The loan side to filter by. See details

Available options:
lend,
borrow
Example:

"lend,borrow"

​
toDate
string

Optional date when provided the report will only contain lending information up to this date (inclusive)

Response

OK

The response is of type object.