GET - Consulta de Contas a Receber

Este método realiza a consulta de títulos a receber, com base nos filtros informados no corpo da requisição.

OBS: Este método precisa ser habitado via o parâmetro 15 - API-LIBERA-CONTAS-A-RECEBER . (Solicitar a Prosyst)

/api/contas-receber

Exemplo URL

 <IP do Serviço>:<Porta liberada para o serviço>/api/contas-receber

Parâmetros do Header

auth	Token de autenticação obtido via login.

Exemplo de Body

 {
  "CodigosCliente": ["123", "456"],
  "CpfCnpjClientes": ["12345678901", "98765432000199"],
  "PeriodoEmissao": {
    "DataInicial": "2024-01-01T00:00:00",
    "DataFinal": "2024-12-31T00:00:00"
  },
  "PeriodoVencimento": {
    "DataInicial": "2024-02-01T00:00:00",
    "DataFinal": "2024-12-31T00:00:00"
  },
  "TipoDocumento": 0,
  "Situacao": 0
}

Explicação dos campos do Body

CodigosCliente → Lista de String → Códigos internos dos clientes
CpfCnpjClientes → Lista de String → CPF ou CNPJ dos clientes sem formatação
PeriodoEmissao → Objeto → Intervalo de emissão dos títulos
DataInicial → Data inicial do período
DataFinal → Data final do período
PeriodoVencimento → Objeto → Intervalo de vencimento dos títulos
DataInicial → Data inicial do período
DataFinal → Data final do período
TipoDocumento → Número → Tipo do documento (0 = TitulosNormais, 1 = Adiantamentos, 2 = AdiantamentosSaldoApropriar, 3 = TitulosAgrupamento)
Situacao → Número → Situação dos títulos (0 = EmAberto, 1 = Liquidado, 2 = Todos)

Exemplos de Retorno

Sucesso

 {
  "bemSucedido": true,
  "mensagemFalha": null,
  "novoCodigo": null,
  "dados": [
    {
      "codigoCliente": 10001,
      "descriaoCliente": "TESTE TECNOLOGIA LTDA",
      "cpfCnpjCliente": "12.345.678/0001-01",
      "numeroTitulo": 200001,
      "serieTitulo": "A1",
      "nrParcela": 1,
      "valorParcela": 1500.00,
      "valorRecebido": 0.0,
      "valorDesconto": 0.0,
      "valorAbatimento": 0.0,
      "valorAcrescimo": 0.0,
      "valorAntecipado": 0.0,
      "dataEmissao": "2024-11-10T00:00:00-03:00",
      "dataEmissaoDuplicata": "2024-11-10T00:00:00-03:00",
      "dataLiquidacao": null,
      "dataVencimentoOriginal": "2024-12-10T00:00:00-03:00",
      "dataVencimentoSemDesc": "2024-12-10T00:00:00-03:00",
      "dataVencimentoComDesc": null,
      "dataCancelamento": null,
      "numeroFatura": 0,
      "observacaoParcela": "PARCELA EM ABERTO",
      "pctDescontoTitulo": 0.0,
      "qtdDuplicatas": 1,
      "pctDesconto": 0,
      "codigoPortador": 10,
      "nomePortador": "CARTEIRA PADRÃO",
      "codigoRepresentante": 45,
      "nomeRepresentante": "JOÃO SILVA",
      "codigoVendedor": 45,
      "nomeVendedor": "JOÃO SILVA",
      "codigoCondicaoPgto": "30DDL",
      "descricaoCondigoPgto": "30 Dias Data de Lançamento",
      "nomeEstabelecimento": "TESTE MATRIZ"
    }
  ]
}