Documents

<b>BETA:</b> Create index document.

post/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_write)

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

Request body

DocumentTypeCodestring
Descriptionstring
DocumentStartDatestring
DocumentEndDatestring
DocumentSignedboolean
AvailableToClientViewboolean
WorkflowTemplateCodestring
WorkflowInstanceIDinteger
ExternalDocumentReferencestring guid

Example request

{
  "WorkflowTemplateCode": "Template-Code",
  "FinancialYears": [
    2021,
    2022
  ],
  "ExternalDocumentReference": "123e4567-e89b-12d3-a456-426614174000"
}

Response

Success

Changes

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