Smart: Glosas Reapresentadas

Endpoints da WebApiAlcance para as glosas reapresentadas exportadas do produto Smart. Cada registro traz a NFS reapresentada (nfs_serie/nfs_tipo/nfs_numero, tipo NR) e a nota de saída original que ela reapresenta (nfs_ns_serie/nfs_ns_tipo/nfs_ns_numero, tipo NS), com os nomes de campo preservando a nomenclatura da planilha de origem. É um CRUD simples: listagem paginada com filtro opcional por CNPJ, busca por ID, criação, atualização e exclusão.

Todos os endpoints exigem autenticação. Veja Autenticação para o fluxo de API Key. O Swagger oficial está em api.contabilidadealcance.com.br/docs.

Base path

/api/v1/smart-glosas-reapresentadas

Escopos necessários

smart_glosas_reapresentadas:read - listagem e busca por ID
smart_glosas_reapresentadas:write - criação, atualização e exclusão

O escopo é derivado do prefixo público da rota: /smart-glosas-reapresentadas vira o recurso smart_glosas_reapresentadas (hífen → underscore), e o método HTTP define a ação (read para GET, write para POST/PUT/DELETE).

Endpoints

`GET /smart-glosas-reapresentadas/`

Lista as glosas reapresentadas, com filtro opcional por CNPJ e paginação.

Parâmetros

Parâmetro	Tipo	Local	Obrigatório	Descrição
`cnpj`	`string`	query	não	Filtra por CNPJ do cliente.
`limit`	`int`	query	não	Itens por página. `1..500`. Default `100`.
`offset`	`int`	query	não	Offset de paginação. `>= 0`. Default `0`.

Request

Sem corpo de requisição.

Response 200 OK

{
  "status": "success",
  "message": "Glosas reapresentadas recuperadas com sucesso",
  "data": [
    {
      "id": 1051,
      "cnpj": "12345678000199",
      "cfg_emp": "01 - HOSPITAL EXEMPLO",
      "nfs_serie": "R",
      "nfs_tipo": "NR",
      "nfs_numero": 3312,
      "nfs_valor": 610.0,
      "nfs_ns_tipo": "NS",
      "nfs_ns_serie": "U",
      "nfs_ns_numero": 3288,
      "nfs_emp_codigo": "04",
      "codigo_nome": "CONVENIO EXEMPLO SAUDE",
      "nfs_dt_emis": "2026-04-18T00:00:00",
      "data_hora_criacao": "2026-04-19T08:00:00"
    }
  ]
}

Se nenhum registro casar com o filtro, data volta [] com 200 OK e message: "Nenhuma glosa reapresentada encontrada.".

Escopo: smart_glosas_reapresentadas:read

`GET /smart-glosas-reapresentadas/{smart_glosa_id}`

Busca uma glosa reapresentada pelo ID.

Parâmetros

Parâmetro	Tipo	Local	Obrigatório	Descrição
`smart_glosa_id`	`int`	path	sim	ID da glosa reapresentada.

Request

Sem corpo de requisição.

Response 200 OK

{
  "status": "success",
  "message": "Glosa reapresentada recuperada com sucesso",
  "data": {
    "id": 1051,
    "cnpj": "12345678000199",
    "cfg_emp": "01 - HOSPITAL EXEMPLO",
    "nfs_serie": "R",
    "nfs_tipo": "NR",
    "nfs_numero": 3312,
    "nfs_valor": 610.0,
    "nfs_ns_tipo": "NS",
    "nfs_ns_serie": "U",
    "nfs_ns_numero": 3288,
    "nfs_emp_codigo": "04",
    "codigo_nome": "CONVENIO EXEMPLO SAUDE",
    "nfs_dt_emis": "2026-04-18T00:00:00",
    "data_hora_criacao": "2026-04-19T08:00:00"
  }
}

Quando o ID não existe, responde {"message": "Glosa reapresentada não encontrada."} com 404 Not Found.

Escopo: smart_glosas_reapresentadas:read

`POST /smart-glosas-reapresentadas/`

Cria uma nova glosa reapresentada.

Parâmetros

Este endpoint não recebe parâmetros de rota ou query. O corpo é um SmartGlosasReapresentadasCreate.

Request

{
  "cnpj": "12345678000199",
  "cfg_emp": "01 - HOSPITAL EXEMPLO",
  "nfs_serie": "R",
  "nfs_tipo": "NR",
  "nfs_numero": 3312,
  "nfs_valor": 610.0,
  "nfs_ns_tipo": "NS",
  "nfs_ns_serie": "U",
  "nfs_ns_numero": 3288,
  "nfs_emp_codigo": "04",
  "codigo_nome": "CONVENIO EXEMPLO SAUDE",
  "nfs_dt_emis": "2026-04-18T00:00:00"
}

Response 201 Created

{
  "status": "success",
  "message": "Glosa reapresentada criada com sucesso",
  "data": {
    "id": 1051,
    "cnpj": "12345678000199",
    "cfg_emp": "01 - HOSPITAL EXEMPLO",
    "nfs_serie": "R",
    "nfs_tipo": "NR",
    "nfs_numero": 3312,
    "nfs_valor": 610.0,
    "nfs_ns_tipo": "NS",
    "nfs_ns_serie": "U",
    "nfs_ns_numero": 3288,
    "nfs_emp_codigo": "04",
    "codigo_nome": "CONVENIO EXEMPLO SAUDE",
    "nfs_dt_emis": "2026-04-18T00:00:00",
    "data_hora_criacao": "2026-04-19T08:00:00"
  }
}

Escopo: smart_glosas_reapresentadas:write

`PUT /smart-glosas-reapresentadas/{smart_glosa_id}`

Atualiza uma glosa reapresentada (update parcial - cnpj não pode ser alterado por esta rota).

Parâmetros

Parâmetro	Tipo	Local	Obrigatório	Descrição
`smart_glosa_id`	`int`	path	sim	ID da glosa reapresentada.

O corpo é um SmartGlosasReapresentadasUpdate.

Request

{ "nfs_valor": 620.0 }

Response 200 OK

{
  "status": "success",
  "message": "Glosa reapresentada atualizada com sucesso",
  "data": {
    "id": 1051,
    "cnpj": "12345678000199",
    "cfg_emp": "01 - HOSPITAL EXEMPLO",
    "nfs_serie": "R",
    "nfs_tipo": "NR",
    "nfs_numero": 3312,
    "nfs_valor": 620.0,
    "nfs_ns_tipo": "NS",
    "nfs_ns_serie": "U",
    "nfs_ns_numero": 3288,
    "nfs_emp_codigo": "04",
    "codigo_nome": "CONVENIO EXEMPLO SAUDE",
    "nfs_dt_emis": "2026-04-18T00:00:00",
    "data_hora_criacao": "2026-04-19T08:00:00"
  }
}

Quando o ID não existe, responde {"message": "Glosa reapresentada não encontrada."} com 404 Not Found.

Escopo: smart_glosas_reapresentadas:write

`DELETE /smart-glosas-reapresentadas/{smart_glosa_id}`

Remove uma glosa reapresentada.

Parâmetros

Parâmetro	Tipo	Local	Obrigatório	Descrição
`smart_glosa_id`	`int`	path	sim	ID da glosa reapresentada.

Request

Sem corpo de requisição.

Response 200 OK

{
  "status": "success",
  "message": "Glosa reapresentada removida com sucesso",
  "data": null
}

Quando o ID não existe, responde {"message": "Glosa reapresentada não encontrada."} com 404 Not Found.

Escopo: smart_glosas_reapresentadas:write

Schemas

`SmartGlosasReapresentadasCreate`

Corpo do POST. Todos os campos são opcionais no envio (schema não exige nenhum obrigatório).

Campo	Tipo	Observações
`cnpj`	`string`	Máx. 30 caracteres. CNPJ/CPF do cliente.
`cfg_emp`	`string`	Máx. 300 caracteres. Identificação da empresa na origem.
`nfs_serie`	`string`	Máx. 20 caracteres. Série da NFS reapresentada (tipo `NR`); pode ser letra.
`nfs_tipo`	`string`	Máx. 20 caracteres. Tipo do documento reapresentado (`NR`).
`nfs_numero`	`int`	Número da NFS reapresentada.
`nfs_valor`	`float`	Valor da nota reapresentada.
`nfs_ns_tipo`	`string`	Máx. 20 caracteres. Tipo da nota de saída original (`NS`).
`nfs_ns_serie`	`string`	Máx. 20 caracteres. Série da nota de saída original; pode ser letra.
`nfs_ns_numero`	`int`	Número da nota de saída original.
`nfs_emp_codigo`	`string`	Máx. 20 caracteres. Código da empresa/convênio na origem (pode ter zeros à esquerda).
`codigo_nome`	`string`	Máx. 300 caracteres. Nome associado ao `nfs_emp_codigo` (ex.: convênio).
`nfs_dt_emis`	`datetime`	Data de emissão da NFS reapresentada.

`SmartGlosasReapresentadasUpdate`

Corpo do PUT. Mesmos campos de SmartGlosasReapresentadasCreate, exceto cnpj (o dono do registro não pode ser trocado por update).

`SmartGlosasReapresentadasRead`

Retorno de leitura. Estende SmartGlosasReapresentadasCreate com id e data_hora_criacao.

Campo	Tipo	Observações
`id`	`int`	Identificador do registro.
`data_hora_criacao`	`datetime`	Data/hora de criação do registro.
(demais campos)	-	Todos os campos de `SmartGlosasReapresentadasCreate`.

Notas

Sucesso segue o envelope { status: "success", message, data }. Erros levantados como HTTPException (404, 500) respondem { message } com o código HTTP correspondente.
nfs_valor é armazenado como DECIMAL(15,2) no banco, mas o schema o expõe como float; o valor trafega como número JSON de ponto flutuante.
nfs_serie/nfs_ns_serie e nfs_emp_codigo são string (não int) de propósito: a origem traz letras e/ou zeros à esquerda que não sobreviveriam num tipo numérico.
?cnpj= vazio ou sem dígitos é tratado como "sem filtro" (não gera WHERE cnpj = '').
GET /smart-glosas-reapresentadas/ sempre retorna 200 OK; lista vazia é estado normal.