Sign in

v1

latestOpenAPI 3.0.02026-07-264636241.7 MB
Lotes

Retorna lote de pagamentos de 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)

A interface viabiliza a consulta de lote do sistema CV. A consulta é realizada através dos dados enviados na URL, podendo conter id do lote, podendo também passar o limite e a página por parâmetro. A requisição retorna os dados do(s) lote(s) caso seja especifícado um id do lote, caso não, retorna todos os lotes.

get/v1/financeiro/lotes/{idLote}

Path parameters

idLoteinteger required
Example:1

Identificador do lote de pagamento.

Query parameters

limiteinteger
Example:30

Limite de itens exibido por página

paginainteger
Example:1

Página que deseja visualizar os registros.

Headers

emailstring required
Example:email@email.com
tokenstring required
Example:79d965e5027b7423423f2471824e799949c75f9ce

Response

Lote retornado com sucesso.

totalinteger

Total de lotes da query disponível no banco de dados

limiteinteger

Limitar por página.<br/> *Este campo será ignorado caso seja passado <strong>id do lote</strong> e o lote já tenha sido encontrado.

paginainteger

Mostrar por página.<br/> *Este campo será ignorado caso seja passado <strong>id do lote</strong> e o lote já tenha sido encontrado.

Example response

{
  "total": 12340,
  "limite": 5,
  "pagina": 1,
  "lotes": [
    {
      "total": 12340,
      "limite": 5,
      "pagina": 1,
      "lotes": {
        "idlotepagamento": 123,
        "situacao_lote": 1,
        "valor_lote": "100.50",
        "nome": "Lote de Pagamento #123",
        "nota_fiscal": "0000",
        "descricao": "Descrição de teste",
        "observacao": "Observação de teste",
        "comissoes": [
          {
            "idcomissao": 456,
            "pagamentos": [
              {
                "idpagamento_comissao": 456,
                "data_pagamento": "2021-07-17",
                "idcomissao": "456",
                "nota_fiscal_pagamento": "000001",
                "situacao_comissao": "Pagamento Direto",
                "situacao_pagamamento": "Programado",
                "valor_pagamento": "90.37",
                "data_medicao_pagamento": "2021-07-17",
                "observacao_pagamento": "Observação de teste"
              }
            ]
          }
        ]
      }
    }
  ]
}