Fund document by doc id

Request

Retrieves a document from the system by a unique document Id.

Security

Class_oAuth(Required scopes: fund.readfund.maintain)

Path

documentIdstringrequired

Document Id

Example:8e4cbebe-61e2-4629-aa19-4dc804d7f7ae

businessCodestringrequired

Class business code

Example:demo-business

fundCodestringrequired

Class entity code

Example:demo-fund

versionstringrequired

API version

Example:1.0

curl -i -X GET \
  https://api.class-pie.com.au/api/1.0/f/demo-business/demo-fund/dms/documents/8e4cbebe-61e2-4629-aa19-4dc804d7f7ae

Responses

Success (Ok)

Bodyapplication/json

idstring or null

Unique identifier for the document.

Example:"1f41a318-3179-4734-b9f5-9b95811bc270"

descriptionstring or null

A brief description or title of the document.

Example:"Tax Statement.pdf"

fileNamestring or null

The name of the file as stored or uploaded.

Example:"Tax Statement.pdf"

createdBystring or null

Email address of the user who created the document.

Example:"Bob.Jones@class.com.au"

createdTimestring, (date-time)

Timestamp indicating when the document was created.

Example:"2024-04-23T10:27:51.643869"

effectiveTimestring or null, (date-time)

The date and time when the document becomes effective or valid.

Example:"2023-06-30T00:00:00"

updatedBystring or null

Email address of the user who last updated the document.

Example:"Bob.Jones@class.com.au"

updatedTimestring, (date-time)

Timestamp indicating when the document was last updated.

Example:"2024-04-23T10:27:51.877835"

effectiveStatusCodestring or null

Status code indicating the current effective state of the document.

Example:"Active"

isClassManagedboolean

Indicates whether the document is managed by a class-based system.

Example:false

statusstring or null

General status of the document (e.g., verified, unverified).

Example:"unverified"

sourcestring or null

Origin or source of the document (e.g., uploaded manually, system-generated).

Example:"unspecified"

isRestrictedboolean

Indicates whether access to the document is restricted.

Example:false

tagsArray of objects or nullread-only

Response

{
  "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
    }
  ]
}