Skip to content
Explore Class APIs/
Document Management Servi...
/Documents

Fund documents

Request

Retrieves all the documents related to the specificentity within a business. The system document date is derived differently for specific Class generated documents, see below for some examples:

Document TypeDate LogicFinancial year tag
Actuarial Certificate30 June of requested yearYes
Audit report30 June of requested yearYes
Property ValuationDate of requestYes
Direct Connect Doc feedStatement period end dateYes
Data feed authority formDate uploadedNo
Client ViewDate msg sentYes
Title searchDate of requestYes
Class docusign envelopeDate envelope completed (last signer)No
Security
Class_oAuth(Required scopes: fund.readfund.maintain)
Path
businessCodestringrequired

Class business code

Example:demo-business
fundCodestringrequired

Class entity code

Example:demo-fund
versionstringrequired

API version

Example:1.0
Query
documentDateFromstring

Retrieve the documents based on a specified from date.

documentDateTostring

Retrieve the documents based on a specified to date.

sortBystring

Available values:

  • description
  • createdby
  • created
  • source
  • status
  • effectivetime

Multiple values can be provided if they are comma-separated.

  • To denote descending order, prefix the name with a '-' , e .g., SortBy=-created (sorts by created date in descending order).
  • Example: SortBy=description,-createdby
    • Sorts by 'description' in ascending order.
    • Then sorts by 'createdby' in descending order.
Example:sortBy=created
pageNumberstring

Page number must be a valid number between 1 and 500000. Default value is 1.

pageSizestring

Page size must be a valid number between 1 and 500. Default value is 500.

curl -i -X GET \
  'https://api.class-pie.com.au/api/1.0/f/demo-business/demo-fund/dms/documents?documentDateFrom=string&documentDateTo=string&sortBy=created&pageNumber=string&pageSize=string'

Responses

Success (Ok)

Bodyapplication/json
totalinteger, (int32)

The total number of documents returned by the query.

Example:1
pageSizeinteger, (int32)

The number of documents included per page of results.

Example:500
pageNumberinteger, (int32)

The current page number being viewed or returned.

Example:1
totalPagesinteger, (int32)

The total number of pages available based on the total and pageSize.

Example:1
documentsArray of objects or nullread-only
Response
{
  "total": 1,
  "pageSize": 500,
  "pageNumber": 1,
  "totalPages": 1,
  "documents": [
    {
      "id": "1f41a318-3179-4734-b9f5-9b95811bc270",
      "description": "Tax Statement.pdf",
      "fileName": "Tax Statement.pdf",
      "createdBy": "Bob.Jones@class.com.au",
      "createdTime": "2024-04-23T10:27:51.643869",
      "effectiveTime": "2023-06-30T00:00:00",
      "updatedBy": "Bob.Jones@class.com.au",
      "updatedTime": "2024-04-23T10:27:51.877835",
      "effectiveStatusCode": "Active",
      "isClassManaged": false,
      "status": "unverified",
      "source": "unspecified",
      "isRestricted": false,
      "tags": [
        {
          "id": "6014071d-1a37-4019-92c2-04bb15fc0c63",
          "externalId": "385deb74-cd09-42d0-8ef4-88782fc3211c",
          "displayName": "Ms Ellyse Perry: Accumulation",
          "code": null,
          "tagType": "Account",
          "isProtected": false
        }
      ]
    }
  ]
}