Documents

Upload a document to the fund.

post/sites/{site-identifier}/funds/{fund-identifier}/documents/upload

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/upload
  • 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_write)

Path parameters

site-identifierstring required

The GUID that identifies a site

fund-identifierstring required

The GUID that identifies a fund

Request body

DocumentTypeCodestring
Descriptionstring
FinancialYearinteger

The financial year (only applicable when uploading a document to a fund).

DocumentStartDatestring date
DocumentEndDatestring date
FileNamestring required
FileDatastring byte required
AvailableToClientViewboolean
WorkflowTemplateCodestring
WorkflowInstanceIDnumber
ExternalDocumentReferencestring guid

Example request

{
  "DocumentTypeCode": "Test",
  "Description": "Test document",
  "FinancialYear": 2020,
  "FileName": "document.pdf",
  "WorkflowTemplateCode": "Template-Code",
  "ExternalDocumentReference": "123e4567-e89b-12d3-a456-426614174000"
}

Response

Created

DocumentIDstring guid

Changes

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