API do Demander - Formas de Pagamento

Este artigo faz parte da documentação da API de Integração REST.

Documentação para consultar, inserir, atualizar e excluir formas de pagamento.

Consulta

Lista as formas de pagamento da empresa. Sem filtro, considera dataAlteracao dos últimos 6 meses.

Rota: {host}/public/v1/formas-de-pagamento?pagina={pagina}&limite={limite}&filtroDataAlteracao={data}&operadorFiltro={operador}
Método: GET

Cuidado

Paginação

• pagina — base 1 (padrão 1)
• limite — padrão 100, máximo 500

Filtros

• filtroDataAlteracao — formato Y-m-d
• operadorFiltro (opcional) — <, >, =, <=, >= (padrão >=)

Retorno:

{
  "formasDePagamento": [
    {
      "codigo": "1",
      "descricao": "BOLETO",
      "ativo": 1,
      "valorMinimoPedido": 8.5,
      "percJurosDesconto": 5.0,
      "consideraLimiteCredito": 1,
      "dataAlteracao": "2026-07-15 14:00:00"
    }
  ]
}

Inserir ou atualizar

POST upsert pela chave codigo.

Rota: {host}/public/v1/formas-de-pagamento
Método: POST
Body: json

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
codigo	string	20	✓	Código da forma de pagamento. Identificador único usado para inserir ou atualizar (upsert).
descricao	string	255	✓	Nome da forma de pagamento.
ativo	int			Valores: 0 ou 1. Padrão na inclusão: 1.
valorMinimoPedido	decimal			Valor mínimo do pedido para usar esta forma.
percJurosDesconto	decimal			Percentual de juros ou desconto.
consideraLimiteCredito	int			Valores: 0 ou 1. Padrão na inclusão: 0.

Cuidado

Inclusão

• É necessário enviar todos os atributos que são obrigatórios. Retorno 201.

Atualização

• Apenas o atributo codigo é obrigatório. Retorno 200.

Body:

{
  "codigo": "1",
  "descricao": "BOLETO",
  "ativo": 1,
  "valorMinimoPedido": 8.5,
  "percJurosDesconto": 5.0,
  "consideraLimiteCredito": 1
}

Retorno:

{
  "codigo": "1",
  "descricao": "BOLETO",
  "ativo": 1,
  "valorMinimoPedido": 8.5,
  "percJurosDesconto": 5.0,
  "consideraLimiteCredito": 1,
  "dataAlteracao": "2026-07-15 14:00:00"
}

Excluir

Remove a forma de pagamento.

Rota: {host}/public/v1/formas-de-pagamento?codigo={codigo}
Método: DELETE

Retorno:

{
  "mensagem": "Registro excluído com sucesso."
}