GET /sites/{site-identifier}/funds/{fund-identifier}/documents/{document-identifier}/details

Documents

<b>BETA:</b> Return a document details.

get/sites/{site-identifier}/funds/{fund-identifier}/documents/{document-identifier}/details

Request

Base URL: https://api-dev.superconcepts.com.au/api/v1
URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/funds/{fund-identifier}/documents/{document-identifier}/details
Auth: OAuth 2 (authorization code, authorization URL https://api.supermate.com.au/oauth/v1/authorize, token URL https://api.supermate.com.au/oauth/v1/token, scopes: default, documents_read)

Path parameters

site-identifierstring required

The GUID that identifies a site

fund-identifierstring required

The GUID that identifies a fund

document-identifierstring guid required

The GUID that identifies a document

transaction-identifierstring guid required

Filters the document's linked transactions to the specified transaction identifier. Use this when a document is associated with multiple transactions within the same batch.

Response

Success

DocumentTypeCodestring

Descriptionstring

DocumentDescriptionstring

DocumentDatestring date

DocumentStartDatestring date

DocumentEndDatestring date

DocumentSignedboolean

FileNamestring

AvailableToClientViewboolean

ExternalDocumentReferencestring guid

ExternalDocumentSystemstring

UploadDatestring date-time

UploadUserstring

PrivacyLevel'CONFIDENTIAL' | 'NO-RESTRICTION'

Example response

{
  "DocumentDate": "2022-07-01",
  "DocumentStartDate": "2022-07-01",
  "DocumentEndDate": "2022-07-02",
  "FinancialYears": [
    2021,
    2022
  ],
  "AvailableClientViewRoleTypes": [
    "AUDITOR",
    "ADVISER",
    "TRUSTEE"
  ],
  "ExternalDocumentReference": "123e4567-e89b-12d3-a456-426614174000",
  "ExternalDocumentSystem": "EXTSYS001",
  "LinkedQueryGUID": [
    "123e4567-e89b-12d3-a456-426614174000",
    "123e4567-e89b-12d3-a456-426614174111"
  ],
  "LinkedQueryItemAttachmentGUID": [
    "bbfd14fa-1289-cb98-d414-3eec88164dec",
    "b5a53a2f-7941-58aa-8d14-53b3f6e72dc1"
  ],
  "LinkedTransactionGUID": [
    "bbfd14fa-1289-cb98-d414-3eec88164def",
    "b5a53a2f-7941-58aa-8d14-53b3f6e72dgh"
  ],
  "FileData": {
    "FileName": "GOODSM_2024_PurchaseGoodmanGroupForus_1989.pdf",
    "OriginalFileName": "PurchaseGoodmanGroupForus.pdf",
    "FileHash": "sha-512=e56775dbad0771d3ed62a28b71b756a137b02105b313bd75587d27017edaf2e6f9219a19ceadf4f1a972f11f7c93f3826477fa9cd76d7ec1cd57f15a7e5ff88c",
    "FileSize": 1989
  },
  "UploadDate": "2020-03-24T15:55:52.679+07:00",
  "UploadUser": "John",
  "LinkedWorkflowInstances": [
    {
      "WorkflowInstanceID": 12
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.