Document tag

Tagging of a document in Basecone.

POST documents/:documentId/tag

Request details

The post request will contain all the required information to tag the intended document, identified by the documentId.

Note: that the costcenter, project and authorizers should all be from or have access to the company that the document belongs to.

Request properties

Property	Type	Description	Optional
tag	complex	Tag details.	No
costCenter	Guid	Unique identifier of a costcenter.	Yes.
project	Guid	Unique identifier of a project.	Yes
authorizers	Array of Guid	Unique identifier of a user.	Yes

Tag details properties

Property	Type	Description
code	string	Tag code, possible values are `CASH`, `JNL`,`PNV`,`SLS`,`BNK`,`CUST`.

Example request

{
  "tag":
  {
  	"code": "PNV"
  },
  "costCenter":"AC833FBE-830E-49DC-8760-6FC8AA655D29",
  "project":"E2F31B99-7756-4408-98CA-2BAC88B4FC35",
  "authorizers":
  [
    "159193C7-CD73-4DED-B3C3-E3D79AB991F5",
    "3E00A63F-D793-4237-92C0-CD2DDE243A12",
  ]
}

Response

Upon successful tagging a 200 status code will be returned, otherwise an error message with failure details.

Even when the Tag operation is successful, there might be returned warning messages. Possible message codes are:

Warnings

Code	Description
not_ocr_capable_exceeds_size_limit	The tagged file exceeds the maximum file size allowed to perform character recognition. Maximum file size allowed by Basecone is 8MB.
not_ocr_capable_exceeds_page_count_limit	The tagged file exceeds the maximum number of pages allowed to perform character recognition. Maximum number of pages allowed by Basecone is 25.
is_ubl	The tagged file format is UBL.