Documents

Search documents attached to the fund.

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

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
  • 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
Example:e3c76443-8126-05b6-9914-c88c1ce84725

The GUID that identifies a specified document

Query parameters

financial-yearnumber

Search for documents in this financial year

document-typestring

the document type code

start-datestring date

the start date to search for documents

end-datestring date

the end date to search for documents

upload-start-datestring

The upload start date with format (yyyy-MM-dd)

upload-end-datestring

The upload end date with format (yyyy-MM-dd)

account-numberstring

The chart account number

indexedstring
Example:yes

Document is fully indexed or not

descriptionstring

the documents description

viewRoleType'TRUSTEE' | 'ADVISER' | 'AUDITOR'

View role type

categorystring
Example:ATO

The document type category code

external-document-referencestring
Example:123e4567-e89b-12d3-a456-426614174000

the external document reference

textSearchstring

filters documents content

workflow-instance-idinteger

The id of the workflow instance that the document is linked to.

Response

Success

DocumentIDstring guid
DocumentDatestring date
DocumentEndDatestring date
UploadDatestring date-time
UploadUserstring
LastModifiedDateTimestring date-time
LastModifiedUserstring
DocumentDescriptionstring
FinancialYearnumber
AccountNumberstring
InvestmentSecurityCodestring
IsSignedboolean
AvailableToClientViewboolean
WorkflowInstanceIDinteger
WorkflowInstanceStatus'INCOMPLETE' | 'COMPLETE' | 'CANCELLED'
ExternalDocumentReferencestring guid
ExternalDocumentSystemstring
IndexStatus'COMPLETE' | 'INCOMPLETE'
PrivacyLevel'CONFIDENTIAL' | 'NO-RESTRICTION'

Example response

[
  {
    "DocumentID": "b4dd9f2a-7cc3-2198-6114-357f8cc46ef8",
    "Fund": {
      "Code": "GOODSM",
      "Name": "Good SuperMate Enterprise Superannuation Fund."
    },
    "UploadDate": "2020-03-24T15:55:52.679+07:00",
    "UploadUser": "John",
    "LastModifiedDateTime": "2020-05-20T15:55:52.679+07:00",
    "LastModifiedUser": "John",
    "DocumentDescription": "Purchase Goodman Group Forus",
    "FinancialYear": 2024,
    "AccountNumber": "2050001",
    "InvestmentSecurityCode": "ONT",
    "WorkflowInstanceID": 12,
    "Type": {
      "Code": "CONTRACT-NOTES",
      "Description": "Contract Notes"
    },
    "Transaction": {
      "AccountNumber": "2050001",
      "Description": "Purchase Goodman Group Forus",
      "Source": "Manual: John"
    },
    "Links": [
      {
        "Type": "Account",
        "GUID": "97023f20-cd81-9c8a-9314-09c76440a1fb",
        "DisplayDescription": "Goodman Group Forus"
      }
    ],
    "FileData": {
      "FileName": "GOODSM_2024_PurchaseGoodmanGroupForus_1989.pdf",
      "OriginalFileName": "PurchaseGoodmanGroupForus.pdf",
      "FileHash": "sha-512=e56775dbad0771d3ed62a28b71b756a137b02105b313bd75587d27017edaf2e6f9219a19ceadf4f1a972f11f7c93f3826477fa9cd76d7ec1cd57f15a7e5ff88c",
      "FileSize": 1989
    },
    "ExternalDocumentReference": "123e4567-e89b-12d3-a456-426614174000",
    "ExternalDocumentSystem": "EXTSYS001",
    "LinkedWorkflowInstances": [
      {
        "WorkflowInstanceID": 12
      }
    ]
  }
]

Changes

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