Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

1. Exemplo do json:

{
  "codigo": 1,
  "descricao": "Cartão de Crédito",
  "tipo": "C",
  "codigo_externo": "EXT123",
  "data_alteracao": "2024-08-31T21:00:39.640Z",
  "ativo": "S"
}

Campos:

  • codigo: Identificador único da forma de pagamento

  • descricao: Descrição da forma de pagamento

  • tipo: Tipo da forma de pagamento. Valores aceitos: D (Dinheiro), RC (Recebimento com Cheque), PC (Pagamento com Cheque), C (Cartão), DR (Duplicatas A Receber), DP (Duplicatas A Pagar), CM (Conta Movimento), SV (Sem Valor), PR (Provisão A Receber), PP (Provisão A Pagar), CD (Carteira Digital)

  • codigo_externo: Código externo da forma de pagamento

  • data_alteracao: Data da última alteração do registro

  • ativo: Indica se a forma de pagamento está ativa. Valores aceitos: S (Sim), N (Não)

Todos os endpoints, com exceção do deletar, retornam o json nesse formato.

2. Endpoints

2.1 - Buscar uma forma de pagamento pelo código

Endpoint: /forma-pagamento

Tipo: get

Parâmetros:

  • codigoInterno: Tipo: Inteiro. Código da forma de pagamento no banco de dados do CRM.

  • codigoExterno: Tipo: String. Código da forma de pagamento no banco de dados do sistema integrado

Validações: É necessário informar pelo menos um dos parâmetros. Caso informado os dois o sistema prioriza o código externo.

Resposta: Status 200 - Retorna a forma de pagamento no formato documentado na sessão Exemplo do json

2.2 - Buscar todas as formas de pagamento

Endpoint: /forma-pagamento/todos

Tipo: get

Resposta: Status 200 - Retorna a lista das forma de pagamento no formato documentado na sessão Exemplo do json

2.3 - Cadastrar ou editar forma de pagamento

Endpoint: /forma-pagamento

Tipo: post

Notas:

  • Informe no corpo da requisição o json conforme exemplo na sessão 1.

  • Para cadastrar uma nova forma de pagamento não informe o campo “codigo”;

  • Para editar uma forma de pagamento já existente informe o campo “codigo” com o código da forma de pagamento que deseja editar;

Resposta: Status 200 - Retorna a forma de pagamento cadastrada, no formato documentado na sessão Exemplo do json

2.4 - Inativar uma forma de pagamento

Não é possível deletar uma forma de pagamento, apenas inativar, pois a forma de pagamento pode ter vinculo com um pedido ou outros registros. Nesse caso, a forma de pagamento continuar no banco de dados porém com o status inativo.

Endpoint: /forma-pagamento

Tipo: delete

Parâmetros:

  • codigoInterno: Tipo: Inteiro. Código da forma de pagamento no banco de dados do CRM.

  • codigoExterno: Tipo: String. Código da forma de pagamento no banco de dados do sistema integrado, caso existir.

Resposta: Status 200 - Mensagem: Registro inativado com sucesso.

2.5 - Retornar os metadados da forma de pagamento

Endpoint: /forma-pagamento/metadados

Tipo: get

Descrição: Retorna os campos do json, com as informações de tipo, tamanho máximo, se o campo é requerido, filtrável e/ou ordenável

Resposta: Status 200 - Retorna um json com as informações dos campos da forma de pagamento

2.6 - Pesquisar

Endpoint: /forma-pagamento/pesquisa

Tipo: post

Notas:

  • Esse endpoint retorna as formas de pagamento baseado nos filtros e na ordenação informados;

  • Exemplo do corpo da requisição:

  • {
    "pagina": 1,
    "quantidadeRegistros": 2,
    "filtros": [
        {
            "campo": "descricao",
            "comparacao": "CONTEM",
            "valor": "C"
        }
    ],
    "ordenacao": [
        {
            "campo": "descricao",
            "ordenacao": "ASC"
        }
    ]
}

  • Nesse exemplo, estamos filtrando todas as formas de pagamento cuja descrição possua o texto “C”, também estamos ordenando os registros pela descrição de forma ascendente.

  • No labels