GET /sites/{site-identifier}/documents

Documents

Search documents at site level.

get/sites/{site-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}/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

Query parameters

financial-yearnumber

Example:2024

The financial year

document-typestring

Example:ABN-CANCELLATION,ADD-DOC-5

the document type code - accepts a comma-delimited list

start-datestring

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

end-datestring

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

upload-start-datestring

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

upload-end-datestring

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

indexedstring

Example:yes

Document is fully indexed or not

max-resultnumber

Example:2500

Maximum document results are limited to searches, with a default maximum of 2500 results.

include-unindexed-fund-docsboolean

Example:true

When include-unindexed-fund-docs = true, fund unindexed documents will be included in the response result.

transaction-identifierstring

The GUID that identifies a transaction.

fund-identifierstring

the fund identifier to search for documents

member-identifierstring

the member identifier to search for documents

descriptionstring

the documents description

categorystring

Example:ATO

The document type category code

external-document-referencestring

Example:123e4567-e89b-12d3-a456-426614174000

the external document reference

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

View role type

account-numberstring

The chart account number

textSearchstring

filters documents content

list-identifierstring

Example:f40ed4cc-00dd-c798-d314-7893a8a948e6

The GUID or code of the fund list.

The json object representing the fund list definition.

include-assigned-fund-docsboolean

Example:true

When include-assigned-fund-docs = true, fund assigned documents will be included in the response result.

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.