01. DADOS GERAIS

02. SITUAÇÃO/REQUISITO

O endpoint de listagem de estabelecimentos foi implementado para tornar as consultas mais responsivas e alinhadas às regras de negócio do produto, permitindo filtragem por grupos e ordenação.

03. SOLUÇÃO

API para Cadastro de Retorno de Emissão

Endpoint: {Ambiente}/v3/estabelecimentos/s/

Método: GET

Descrição: Essa API permite a busca de uma lista de estabelecimentos cadastros no TPF, possuindo variação em seus parâmetros e resultados dependendo do usuário que realiza a busca.

Para Usuário Administrador Bematech:

Exemplos:
GET {Ambiente}/api/v3/estabelecimentos?page=1&sortBy=nome&sortDirection=desc&grupoId=123&cnpj=123354543543543

GET {Ambiente}/api/v3/estabelecimentos?page=1&sortBy=nome&sortDirection=desc&cnpj=123354543543543

GET {Ambiente}/api/v3/estabelecimentos?cnpj=123354543543543

GET {Ambiente}/api/v3/estabelecimentos?grupoId=123

GET {Ambiente}/api/v3/estabelecimentos

Descrição:
A busca por grupoId como parâmetro é destinada a usuários com o perfil de Admin Bematech. Ele permite listar todos os estabelecimentos, com a possibilidade de filtrar por grupo e estabelecimento (caso os parâmetros sejam fornecidos).

Parâmetros:

• • grupoId (opcional query parameter): Quando fornecido, lista apenas os estabelecimentos do grupo especificado.
  • cnpj (opcional query parameter): Quando fornecido, lista apenas os estabelecimentos do cnpj especificado.
  • Pageable (query parameter): Para suportar paginação, ordenação e filtragem.

Para demais usuários:

Exemplo: 

GET {Ambiente}/api/v3/estabelecimentos?page=1&sortBy=nome&sortDirection=desc&cnpj=123354543543543

GET {Ambiente}/api/v3/estabelecimentos?cnpj=123354543543543

GET {Ambiente}/api/v3/estabelecimentos

Descrição:
Para os demais usuários o objetivo do endpoint é listar os estabelecimentos associados a um determinado grupo.

Parâmetros:

• • cnpj (opcional query parameter): Quando fornecido, lista apenas os estabelecimentos do cnpj especificado.

• • Pageable (query parameter): Para suporte à paginação, ordenação e filtragem.

04. DEMAIS INFORMAÇÕES

Não se aplica

05. ASSUNTOS RELACIONADOS

        Não se aplica