Pular para o conteúdo principal

Lista categorias de um estabelecimento.

GET /api/{userId}/establishment/{establishmentId}/categories

Parâmetros de rota

NomeTipoDescrição
userIdnumberIdentificador do usuário
establishmentIdnumberIdentificador do estabelecimento

Requisição

  • Método: GET
  • Path: /api/\{userId\}/establishment/\{establishmentId\}/categories
  • Headers: Authorization, Accept: application/json
  • Autorização: informe o userId do token na URL e envie o token no header Authorization: Bearer <YOUR_API_TOKEN> (gerados no painel de API do Site Admin).

Parâmetros de consulta (query string)

NomeTipoDescrição
searchstringBusca parcial por categoryName.
categoryNamestringBusca exata por categoryName.
mainCategorynumberFiltra categorias principais.
costCenter / costCenterIdnumberFiltra pelo centro de custo.
categorySource / categorySourceIdnumberFiltra pela origem da categoria.
transactionType / transactionTypeIdnumber1 = receita, 2 = despesa.
statusnumber1 = ativa (padrão), 0 = inativa.
orderBystringCampo de ordenação. Padrão: categoryName.
sortstringasc (padrão) ou desc.
pagenumberNú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)

ValorDescrição
1Operacional (estacionamento)
2Serviços
3Financeiro (criado pelo usuário)
4Transferência entre contas
5Faturas (pós-pago)
6Aportes/Sangrias
7Taxa de cartão

Tipos de transação (transactionTypeId)

ValorDescrição
1Receita
2Despesa