Skip to main content
POST
/
tag_groups
Create a tag group
curl --request POST \
  --url https://sandbox.nmbr.co/services/payroll/tag_groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "business_entity_id": "<id>",
  "label": "Department",
  "description": "Departments within the organization"
}
'
{
  "id": "<id>",
  "object": "tag_group",
  "data": {
    "label": "Department",
    "label_translations": null,
    "label_translated": "Department",
    "description": "Departments within the organization",
    "description_translations": null,
    "description_translated": "Departments within the organization",
    "color": null,
    "archived_at": null,
    "is_deletable": null,
    "is_component_locked": null,
    "is_journal_entry_dimension": null,
    "integrations": {
      "xero": {
        "id": null,
        "type": null
      },
      "quickbooks": {
        "type": null
      }
    },
    "business_entity": {
      "id": "<id>",
      "object": "business_entity",
      "links": {
        "self": "/business_entities/<id>"
      }
    },
    "created_at": "2026-01-01T00:00:00.000000Z",
    "updated_at": "2026-01-01T00:00:00.000000Z"
  },
  "links": {
    "self": "/tag_groups/<id>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
business_entity_id
string
required
​
label
string
required
Maximum string length: 255
​
label_translations
object

Optional translations for the label property.

​
description
string | null
​
description_translations
object

Optional translations for the description property.

​
color
string | null

A hex colour code for the tag group (e.g. #AABBCC or #ABC). Used for display.

​
is_component_locked
boolean

When true, prevents modification of tags in this group through the embedded portal. Tags can still be managed through the API.

​
is_journal_entry_dimension
boolean

When true, marks this tag group as a journal entry dimension. A maximum of three tag groups per business entity can be journal entry dimensions.

​
integrations
object

Identifiers and object types for this tag group in external accounting integrations, used to sync tag groups imported from those systems. QuickBooks does not expose a group-level identifier, so only the type is accepted for QuickBooks.

Response

201 - application/json

Created

​
id
string
read-only

The unique identifier of the object in Nmbr.

​
object
string
read-only

The type of the object in Nmbr ("tag_group").

​
data
Tag Group · object