CategoriasObter Categoria por ID

Obter Categoria por ID

Retorna os dados de uma categoria da empresa pelo identificador numérico, incluindo estabelecimentos vinculados e metadados de tipo. O escopo é sempre a empresa associada ao token.

curl -X GET "https://api-sandbox.contasimples.com/categories/v1/categories/1146" \
  -H "Content-Type: application/json" \
  -H "Signature-Input: example_string" \
  -H "Signature: example_string" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "id": 1146,
  "createdAt": "2024-12-25T10:00:00Z",
  "updatedAt": "2024-12-25T10:00:00Z",
  "companyId": "7c61b3f6-7353-46aa-80ef-3e27d95150ab",
  "name": "Eletrônicos",
  "establishments": [
    {
      "id": 16,
      "createdAt": "2024-12-25T10:00:00Z",
      "updatedAt": "2024-12-25T10:00:00Z",
      "name": "Amazon Prime Aluguel",
      "type": {
        "id": 1,
        "createdAt": "2024-12-25T10:00:00Z",
        "updatedAt": "2024-12-25T10:00:00Z",
        "type": "CUSTOM"
      },
      "establishmentCategoryId": 1039
    }
  ],
  "type": {
    "id": 1,
    "createdAt": "2024-12-25T10:00:00Z",
    "updatedAt": "2024-12-25T10:00:00Z",
    "type": "CUSTOM"
  }
}
GET
/categories/v1/categories/{id}
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN
path
idinteger
Required

Identificador numérico da categoria.

header
Signature-Inputstring

O que foi assinado e os parâmetros da assinatura, no formato da RFC 9421. Uma credencial com chave pública precisa enviar este header em todas as chamadas, inclusive as de leitura, ou a requisição é recusada com 401. A assinatura cobre os componentes @method, @path e @query, e também content-digest quando houver corpo. created e alg são obrigatórios, e o created vale por 300 segundos. O formato completo, com exemplos, está em Assinatura de Requisições.

header
Signaturestring

A assinatura da base definida pela RFC 9421, em base64, entre : e com o mesmo rótulo usado no Signature-Input, por exemplo sig=:SGVsbG8gd29ybGQ=:. Vai sempre junto com o Signature-Input.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN

Path Parameters

idinteger
Required

Identificador numérico da categoria.

Example:
1146

Headers

Signature-Inputstring

O que foi assinado e os parâmetros da assinatura, no formato da RFC 9421. Uma credencial com chave pública precisa enviar este header em todas as chamadas, inclusive as de leitura, ou a requisição é recusada com 401. A assinatura cobre os componentes @method, @path e @query, e também content-digest quando houver corpo. created e alg são obrigatórios, e o created vale por 300 segundos. O formato completo, com exemplos, está em Assinatura de Requisições.

Signaturestring

A assinatura da base definida pela RFC 9421, em base64, entre : e com o mesmo rótulo usado no Signature-Input, por exemplo sig=:SGVsbG8gd29ybGQ=:. Vai sempre junto com o Signature-Input.

Responses

idinteger
Required

Identificador numérico da categoria.

createdAtstring
Required

Data e hora de criação da categoria (ISO 8601).

updatedAtstring
Required

Data e hora da última atualização da categoria (ISO 8601).

companyIdstring
Required

Identificador da empresa proprietária da categoria.

namestring
Required

Nome completo ou código contábil exibido da categoria.

establishmentsarray
Required

Lista de estabelecimentos associados a esta categoria, com vínculo e tipo.

typestring
Required

Metadados do tipo da categoria (por exemplo, CUSTOM ou DEFAULT).