PUT - Upload Annotation

PUT /app/docs/{docId}/companyannotation/{companyId}/data

Experimental API endpoint adds a company annotation to a document.

Path Parameters

Name	Type	Description
docId*	String	The id of the document being annotated.
companyId*	String	The id of the company providing annotation.

Request Body

Name	Type	Description
data	object	Annotation data

200: OK

Example JSON payload for Annotation data:

{
  "origin": "external",
  "fields": [
    {
      "id": "ndis.participantNo",
      "type": "simple",
      "data": {
        "value": "10000000"
      }
    },
    {
      "id": "ndis.participantName",
      "type": "simple",
      "data": {
        "value": "John Smith"
      }
    },
    {
      "id": "document.referenceNo",
      "type": "simple",
      "data": {
        "value": "1111"
      }
    },
    {
      "id": "issuer.ABN",
      "type": "simple",
      "data": {
        "value": "1111111"
      }
    },
    {
      "id": "issuer.name",
      "type": "simple",
      "data": {
        "value": "John Smith Company)"
      }
    },
    {
      "id": "ndis.supportStartDate",
      "type": "simple",
      "data": {
        "value": "2021-03-12"
      }
    },
    {
      "id": "ndis.supportEndDate",
      "type": "simple",
      "data": {
        "value": "2021-03-25"
      }
    },
    {
      "id": "invoice.total",
      "type": "simple",
      "data": {
        "value": "840.62"
      }
    }
  ],
  "docId": "111111-1111-1111-1111-111111"
}