v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Pagamentos da comissão

Retorna os pagamentos da comissão

🔒 Autenticação necessária

Esta API utiliza autenticação via e-mail e token nos headers da requisição. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v1 — E-mail e Token)

Endpoint destinado à consulta das parcelas de pagamento das comissões registradas no sistema CVCRM.

A interface retorna informações detalhadas de cada parcela, incluindo os dados do pagador e do beneficiário, permitindo o acompanhamento completo do fluxo de pagamento das comissões. Permite-se consultar por identificadores dos sistemas parceiros, terminados em _int. A consulta suporta paginação e filtros por data de criação ou vencimento, garantindo controle sobre o volume de dados retornados.

A autenticação é realizada via headers utilizando e-mail e token.

get/v1/financeiro/comissoes/parcelas

Query parameters

limiteinteger

Example:30

Limite de itens exibido por página

paginainteger

Example:1

Quantidade de páginas para exibir os dados

tipoFiltrostring

Example:vencimento|criacao

Tipo de filtro de data que pode ser por vencimento ou criação (padrão por vencimento)

destring

Example:01/01/2022

Data início do vencimento a ser procurado

atestring

Example:01/02/2022

Data fim do vencimento a ser procurado

idUltimoPagamentointeger

Example:1

Id do último pagamento, ele deve ser informado ou as datas

somenteCanceladostring

Example:S|N

Traz somente as comissões que estão canceladas e ativo = N

idcomissao_cvinteger

Example:1

Retorna os pagamentos do ID da comissão informada.

idcomissao_intinteger

Example:1

Retorna os pagamentos do código interno da comissão informada.

idreserva_cvinteger

Example:1

Retorna os pagamentos da comissão do ID reserva informado.

idreserva_intinteger

Example:1

Retorna os pagamentos da comissão do código interno da reserva informado.

Headers

emailstring required

Example:email@email.com

Email de autenticação no CV

tokenstring required

Example:79d965e5027b7423423f2471824e799949c75f9ce

Token de autenticação no CV

Response

Operação realizada com sucesso no get de comissão

totalinteger

Total de resultados encontrados.

limiteinteger

Limite por página.

paginainteger

Página atual.

Example response

{
  "total": 1,
  "limite": 1,
  "pagina": 1,
  "pagamentos": [
    {
      "pagador": {
        "nome": "Teste teste",
        "documento": "00000000000",
        "telefone": "+5579999999999",
        "email": "teste@exemplo.org",
        "logradouro": "Rua",
        "numero": "200",
        "complemento": null,
        "bairro": "Farolândia",
        "cidade": "Aracaju",
        "estado": "Sergipe",
        "cep": "49030530"
      },
      "beneficiarios": [
        {
          "nome": "IMOB TESTE",
          "documento": "72034261000133",
          "telefone": "+5579981275780",
          "celular": "+5579981275780",
          "email": "cleiton_santos2@hotmail.com",
          "cep": "49160000",
          "endereco": "Avenida Carlos Burlamarqui",
          "bairro": "TAIÇOCA",
          "numero": "100",
          "complemento": "complemento",
          "cidade": "Nossa Senhora do Socorro",
          "estado": "SE",
          "logradouro": "1ª Avenida",
          "data_nasc": "1982-11-03",
          "para": "Imobiliária (Coordenação)",
          "idbeneficiario_cv": 1099,
          "idbeneficiario_int": "434",
          "parcelas": [
            {
              "idpagamento": 28585,
              "idcomissao": 10763,
              "valor": "450000.00",
              "vencimento": "2025-09-11",
              "bloco": "teste",
              "unidade": "teste 4"
            }
          ]
        }
      ]
    }
  ]
}