ASDinCloudDocs

The tag object

View as Markdown

Tags label records. Accounting categories classify incoming and outgoing payments.

Attributes

idinteger
Identifier assigned by the API.
namestring
Name, up to 100 characters.
tag_typestring
Use tag or accounting_category. Defaults to tag.
directionstring or null
Use incoming or outgoing for accounting categories.
selectedboolean
Select this as the default accounting category.
GET/api/v1/tags

Lists tag records in the workspace.

Permissions

Send your API key in X-API-Key. Required permissions are Tags → Read.

Query parameters

qstring
Search by tag name.
tag_typestring
Use tag or accounting_category. Defaults to tag.
directionstring or null
Use incoming or outgoing for accounting categories.
selectedboolean
Filter by whether this is the selected category.
lengthinteger
Number of records to return.
startinteger
Zero-based offset.
drawstring
Optional request marker echoed in the response.
pageinteger
One-based page number when pageSize is supplied.
pageSizeinteger
Page size from 1 to 100.
sortstring
Sort by id, name, tag_type, direction, selected, tsc, or tsu. Prefix the field name with a minus sign for descending order.
orderstring
Direction for unprefixed sort fields. Use asc or desc.

Returns

Returns items in data, counts before and after text search, and the optional draw marker.

Errors

401
The API key is missing or invalid.
403
The API key lacks the required permission.

Retrieve a tag

View as Markdown
GET/api/v1/tags/{id}

Returns one tag by ID.

Permissions

Send your API key in X-API-Key. Required permissions are Tags → Read.

Path parameters

idintegerRequired
ID of the tag.

Returns

The tag is returned in data.

Errors

401
The API key is missing or invalid.
403
The API key lacks the required permission.
404
The requested record was not found.

Create a tag

View as Markdown
POST/api/v1/tags

Creates a tag.

Permissions

Send your API key in X-API-Key. Required permissions are Tags → Write.

Body parameters

namestringRequired
Name, up to 100 characters.
tag_typestring
Use tag or accounting_category. Defaults to tag.
directionstring or null
Use incoming or outgoing for accounting categories.
selectedboolean
Select this as the default accounting category.

Returns

The created tag is returned in data.

Errors

401
The API key is missing or invalid.
403
The API key lacks the required permission.
400
The accounting category needs a valid direction.
422
One or more fields failed validation.
500
The change could not be saved.

Update a tag

View as Markdown
PATCH / PUT / POST/api/v1/tags/{id}

Updates a tag by ID.

Permissions

Send your API key in X-API-Key. Required permissions are Tags → Write.

Path parameters

idintegerRequired
ID of the tag.

Body parameters

namestring
Name, up to 100 characters.
tag_typestring
Use tag or accounting_category. Defaults to tag.
directionstring or null
Use incoming or outgoing for accounting categories.
selectedboolean
Select this as the default accounting category.

Supply the intended name, type, direction, and default flag when updating the tag.

Returns

Returns a successful update response.

Errors

401
The API key is missing or invalid.
403
The API key lacks the required permission.
404
The requested record was not found.
400
The type or direction is invalid.
422
One or more fields failed validation.
500
The change could not be saved.

Delete a tag

View as Markdown
DELETE/api/v1/tags/{id}
POST/api/v1/tags/{id}/delete

Deletes a tag or accounting category if payments do not reference it.

Permissions

Send your API key in X-API-Key. Required permissions are Tags → Write.

Path parameters

idintegerRequired
ID of the tag.

Returns

Returns a successful removal response.

Errors

401
The API key is missing or invalid.
403
The API key lacks the required permission.
404
The requested record was not found.
400
The record is in use or could not be removed.