Lista categorias de um estabelecimento.
GET /api/{userId}/establishment/{establishmentId}/categories
Parâmetros de rota
| Nome | Tipo | Descrição |
|---|---|---|
userId | number | Identificador do usuário |
establishmentId | number | Identificador do estabelecimento |
Requisição
- Método:
GET - Path:
/api/\{userId\}/establishment/\{establishmentId\}/categories - Headers:
Authorization,Accept: application/json - Autorização: informe o
userIddo token na URL e envie o token no headerAuthorization: Bearer <YOUR_API_TOKEN>(gerados no painel de API do Site Admin).
Parâmetros de consulta (query string)
| Nome | Tipo | Descrição |
|---|---|---|
search | string | Busca parcial por categoryName. |
categoryName | string | Busca exata por categoryName. |
mainCategory | number | Filtra categorias principais. |
costCenter / costCenterId | number | Filtra pelo centro de custo. |
categorySource / categorySourceId | number | Filtra pela origem da categoria. |
transactionType / transactionTypeId | number | 1 = receita, 2 = despesa. |
status | number | 1 = ativa (padrão), 0 = inativa. |
orderBy | string | Campo de ordenação. Padrão: categoryName. |
sort | string | asc (padrão) ou desc. |
page | number | Número da página. Padrão: 1. |
Resposta
- Status:
200 OK - Content-Type:
application/json
Exemplo de resposta
{
"response": "success",
"data": {
"content": [
{
"categoryId": 201,
"categoryName": "Estacionamento Rotativo",
"establishmentId": 1234,
"transactionTypeId": 1,
"categorySourceId": 1,
"openingCashier": 1,
"closingCashier": 1,
"subcategoryId": null,
"costCenterId": 10,
"mainCategory": 1,
"status": 1
},
{
"categoryId": 312,
"categoryName": "Fornecedores",
"establishmentId": 1234,
"transactionTypeId": 2,
"categorySourceId": 3,
"openingCashier": 0,
"closingCashier": 0,
"subcategoryId": null,
"costCenterId": 11,
"mainCategory": 0,
"status": 1
}
],
"total": 38,
"perPage": 20,
"currentPage": 1,
"lastPage": 2
}
}
Origens da categoria (categorySourceId)
| Valor | Descrição |
|---|---|
1 | Operacional (estacionamento) |
2 | Serviços |
3 | Financeiro (criado pelo usuário) |
4 | Transferência entre contas |
5 | Faturas (pós-pago) |
6 | Aportes/Sangrias |
7 | Taxa de cartão |
Tipos de transação (transactionTypeId)
| Valor | Descrição |
|---|---|
1 | Receita |
2 | Despesa |