Acessorias Config

Endpoints da WebApiAlcance para gerenciar a configuração global de integração com o sistema Acessórias. Cada configuração define os parâmetros por área da contabilidade - pessoal, fiscal, contábil, comercial, financeiro e sucesso do cliente - utilizados na sincronização com o Acessórias. Os endpoints cobrem listagem, 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/acessorias-config

Escopos necessários

acessorias_config:read - listagem das configurações
acessorias_config:write - criação, atualização e exclusão

O escopo é derivado da rota: o prefixo /acessorias-config vira o recurso acessorias_config (hífen → underscore), e o método HTTP define a ação (read para GET, write para POST/PUT/DELETE).

Endpoints

`GET /acessorias-config/`

Lista todas as configurações de acessorias cadastradas. Lista vazia é um estado válido - sempre retorna 200 OK, inclusive com data: [] e a mensagem "Nenhuma configuração encontrada.".

Parâmetros

Este endpoint não recebe parâmetros de rota ou query. A resposta traz data como array de AcessoriasConfigResponse.

Request

Sem corpo de requisição.

Response 200 OK

{
  "success": true,
  "message": "Configurações recuperadas com sucesso",
  "data": [
    {
      "id": 1,
      "pessoal": 3,
      "fiscal": 5,
      "contabil": 2,
      "comercial": 7,
      "financeiro": 4,
      "sucesso_cliente": 9
    }
  ]
}

Escopo: acessorias_config:read

`POST /acessorias-config/`

Cria uma nova configuração de acessorias. A resposta retorna a configuração criada no formato AcessoriasConfigResponse (sem envelope).

Parâmetros

Este endpoint não recebe parâmetros de rota ou query - os dados vão no corpo da requisição (AcessoriasConfigCreate). Todos os campos são obrigatórios: pessoal, fiscal, contabil, comercial, financeiro e sucesso_cliente.

Request

{
  "pessoal": 3,
  "fiscal": 5,
  "contabil": 2,
  "comercial": 7,
  "financeiro": 4,
  "sucesso_cliente": 9
}

Response 200 OK

{
  "id": 1,
  "pessoal": 3,
  "fiscal": 5,
  "contabil": 2,
  "comercial": 7,
  "financeiro": 4,
  "sucesso_cliente": 9
}

Escopo: acessorias_config:write

`PUT /acessorias-config/{id}`

Atualiza uma configuração existente pelo ID inteiro. Quando não encontrada, retorna o envelope de erro com "Configuração não encontrada." e details: { "id": <id> }.

Parâmetros

Parâmetro	Tipo	Local	Obrigatório	Descrição
`id`	`int`	path	sim	ID interno da configuração

Request (AcessoriasConfigUpdate - pessoal, fiscal, contabil, comercial, financeiro e sucesso_cliente)

{
  "pessoal": 3,
  "fiscal": 5,
  "contabil": 2,
  "comercial": 7,
  "financeiro": 4,
  "sucesso_cliente": 9
}

Response 200 OK

{
  "success": true,
  "message": "Configuração atualizada com sucesso",
  "data": {
    "id": 1,
    "pessoal": 3,
    "fiscal": 5,
    "contabil": 2,
    "comercial": 7,
    "financeiro": 4,
    "sucesso_cliente": 9
  }
}

Escopo: acessorias_config:write

`DELETE /acessorias-config/{config_id}`

Remove uma configuração de acessorias pelo ID. Em caso de falha, retorna o envelope de erro com a mensagem correspondente.

Parâmetros

Parâmetro	Tipo	Local	Obrigatório	Descrição
`config_id`	`int`	path	sim	ID interno da configuração

Request

Sem corpo de requisição.

Response 200 OK

{
  "success": true,
  "message": "Configuração deletada com sucesso",
  "data": null
}

Escopo: acessorias_config:write

Schemas

`AcessoriasConfigCreate`

Todos os campos são obrigatórios.

Campo	Tipo	Obrigatório	Observações
`pessoal`	`int`	sim	Parâmetro da área de pessoal.
`fiscal`	`int`	sim	Parâmetro da área fiscal.
`contabil`	`int`	sim	Parâmetro da área contábil.
`comercial`	`int`	sim	Parâmetro da área comercial.
`financeiro`	`int`	sim	Parâmetro da área financeira.
`sucesso_cliente`	`int`	sim	Parâmetro da área de sucesso do cliente.

`AcessoriasConfigUpdate`

Mesma estrutura do AcessoriasConfigCreate - todos os campos por área usados na atualização.

Campo	Tipo	Observações
`pessoal`	`int`	Parâmetro da área de pessoal.
`fiscal`	`int`	Parâmetro da área fiscal.
`contabil`	`int`	Parâmetro da área contábil.
`comercial`	`int`	Parâmetro da área comercial.
`financeiro`	`int`	Parâmetro da área financeira.
`sucesso_cliente`	`int`	Parâmetro da área de sucesso do cliente.

`AcessoriasConfigResponse`

Campo	Tipo	Notas
`id`	`int`	Identificador da configuração.
`pessoal`	`int \| null`	Parâmetro da área de pessoal.
`fiscal`	`int \| null`	Parâmetro da área fiscal.
`contabil`	`int \| null`	Parâmetro da área contábil.
`comercial`	`int \| null`	Parâmetro da área comercial.
`financeiro`	`int \| null`	Parâmetro da área financeira.
`sucesso_cliente`	`int \| null`	Parâmetro da área de sucesso do cliente.

Notas

Toda resposta segue o envelope { success, message, data } (ou { success: false, message, details } em erro).
Na criação (POST), os campos são obrigatórios; já na resposta (AcessoriasConfigResponse), todos os campos por área são opcionais e podem retornar null.
A atualização de uma configuração inexistente não gera exceção: retorna o envelope de erro com "Configuração não encontrada." e details: { "id": <id> }.