Financeiro

Contas a receber, contas a pagar e boletos. Cada recurso exige seu próprio escopo — não existe um escopo financeiro genérico.

Objeto cedente (contas a receber/pagar): quem deve ou vai receber pode ser um cliente, fornecedor, usuário, pré-cliente ou um texto livre (outro, sem id). Referência inexistente mantém tipo/id com nome: null.

GET/contas-receber

Escopo: contas-receber:ler

Filtros

Parâmetro	Regra
data_inicio, data_fim	Obrigatórios juntos. Filtram `vencimento`.
status	`aberto`, `pago` ou `vencido`.
cedente_tipo	`outro`, `fornecedor`, `cliente`, `usuario` ou `pre_cliente`.
cedente_id	Inteiro positivo. Exige `cedente_tipo` (exceto `outro`).

Ordenação: id, vencimento, valor, data_pagamento. Padrão vencimento desc, id desc.

Campos

Campo	Tipo	Regra
id	integer	Identificador da conta.
cedente	object	`{tipo, id, nome}`; `id` ou `nome` podem ser `null`.
descricao	string/null	Descrição cadastrada.
valor	number	Valor da conta.
vencimento	string	Data no formato `YYYY-MM-DD`.
status	string	`aberto`, `pago` ou `vencido`.
data_pagamento	string/null	Data no formato `YYYY-MM-DD`.

Requisição

curl -H "Authorization: Bearer SEU_TOKEN" \
  "https://web.synerasis.com.br/api/external/v1/contas-receber?data_inicio=2026-01-01&data_fim=2026-06-30&status=pago"

Resposta 200

{
  "data": [
    {
      "id": 901,
      "cedente": { "tipo": "cliente", "id": 123, "nome": "João da Silva" },
      "descricao": "OS-4501",
      "valor": 450.00,
      "vencimento": "2026-03-10",
      "status": "pago",
      "data_pagamento": "2026-03-08"
    }
  ],
  "meta": { "pagina": 1, "por_pagina": 50, "total": 1, "total_paginas": 1 }
}

GET/contas-pagar

Escopo: contas-pagar:ler

Mesmos filtros, ordenação, status e formato de /contas-receber, usando o escopo contas-pagar:ler.

Campos

O objeto retornado usa os mesmos campos de contas a receber: id, cedente, descricao, valor, vencimento, status e data_pagamento.

Requisição

curl -H "Authorization: Bearer SEU_TOKEN" \
                  "https://web.synerasis.com.br/api/external/v1/contas-pagar?data_inicio=2026-01-01&data_fim=2026-06-30&status=vencido"

Resposta 200

{
  "data": [
    {
      "id": 712,
      "cedente": { "tipo": "fornecedor", "id": 44, "nome": "Fornecedor Exemplo" },
      "descricao": "Compra de peças",
      "valor": 1200.00,
      "vencimento": "2026-03-15",
      "status": "vencido",
      "data_pagamento": null
    }
  ],
  "meta": { "pagina": 1, "por_pagina": 50, "total": 1, "total_paginas": 1 }
}

GET/boletos

Escopo: boletos:ler

Filtros

Parâmetro	Regra
data_inicio, data_fim	Obrigatórios juntos. Filtram `vencimento`.
status	`pendente`, `vencido`, `pago`, `cancelado`, `nao_autorizado`, `nao_realizado`, `rejeitado`, `aguardando_confirmacao`.
cliente_id	Inteiro positivo.

Ordenação: id, emissao, vencimento, pagamento, valor. Padrão vencimento desc, id desc.

Campos

Campo	Tipo	Regra
id	integer	Identificador do boleto.
cliente	object/null	`{id, nome}`; pode ser `null` se o cliente não estiver disponível.
numero_documento	string/null	Número do documento bancário.
linha_digitavel	string/null	Linha digitável do boleto.
valor	number	Valor do boleto.
emissao	string/null	Data no formato `YYYY-MM-DD`.
vencimento	string/null	Data usada pelo filtro de período.
status	string	Um dos valores aceitos no filtro `status`.
data_pagamento	string/null	Data do pagamento.
data_compensacao	string/null	Data da compensação.

Requisição

curl -H "Authorization: Bearer SEU_TOKEN" \
  "https://web.synerasis.com.br/api/external/v1/boletos?data_inicio=2026-01-01&data_fim=2026-06-30"

Resposta 200

{
  "data": [
    {
      "id": 300,
      "cliente": { "id": 123, "nome": "João da Silva" },
      "numero_documento": "00001",
      "linha_digitavel": "34191.79001 01043.510047 91020.150008 1 88770000004500",
      "valor": 450.00,
      "emissao": "2026-02-10",
      "vencimento": "2026-03-10",
      "status": "pago",
      "data_pagamento": "2026-03-08",
      "data_compensacao": "2026-03-09"
    }
  ],
  "meta": { "pagina": 1, "por_pagina": 50, "total": 1, "total_paginas": 1 }
}