# Contas a Receber ContasReceber ## GET /contasReceber > Obter listagem de Contas a Receber ```json {"openapi":"3.0.1","info":{"title":"Financeiro","version":"1.0"},"tags":[{"name":"Contas a Receber","description":"ContasReceber"}],"servers":[{"url":"https://localhost/financeiro/v10"},{"url":"http://localhost/financeiro/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaContasReceber":{"type":"object","properties":{"continuationToken":{"maxLength":50,"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ContasReceber"}}}},"ContasReceber":{"type":"object","properties":{"codTitulo":{"maxLength":50,"type":"string","description":"Código do Título"},"codCliente":{"maximum":9999999,"type":"integer","description":"Código do Cliente"},"codRepresentante":{"maximum":999999,"type":"integer","description":"Código do Representante"},"codPortador":{"maximum":999999,"type":"integer","description":"Código do Portador"},"tipoCobranca":{"maximum":999999,"type":"integer","description":"Tipo de Cobrança"},"dataEmissao":{"type":"string","description":"Data de Emissão (YYYY-MM-DD)","format":"date"},"notaFiscal":{"type":"string","description":"Código da Nota Fiscal"},"dataVenc":{"type":"string","description":"Data de Vencimento (YYYY-MM-DD)","format":"date"},"dataPagamento":{"type":"string","description":"Data de Pagamento (YYYY-MM-DD)","format":"date"},"valorTitulo":{"multipleOf":0.01,"type":"number","description":"Valor do Título"},"tipoBaixa":{"maximum":999999,"type":"integer","description":"Tipo de Baixa"},"dataBaixaContabil":{"type":"string","description":"Data da Baixa Contábil (YYYY-MM-DD)","format":"date"},"valorJuros":{"multipleOf":0.01,"type":"number","description":"Valor de Juros do Título"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor de Desconto do Título"},"numeroBancario":{"maxLength":50,"type":"string","description":"Registro Bancário"},"agenciaBancaria":{"maxLength":50,"type":"string","description":"Agência Bancária"},"valorComissaoFaturamento":{"multipleOf":0.01,"type":"number","description":"Valor de Comissão no Faturamento"},"valorComissaoLiquidacao":{"multipleOf":0.01,"type":"number","description":"Valor de Comissão na Liquidação"},"percDesconto":{"multipleOf":0.01,"type":"number","description":"Percentual do Desconto"},"percComissao":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"carteira":{"maximum":999999,"type":"integer","description":"Carteira"},"contaBancaria":{"maximum":999999,"type":"integer","description":"Conta Bancária"},"dataFluxoCaixa":{"type":"string","description":"Data do Fluxo de Caixa (YYYY-MM-DD)","format":"date"},"centroCustos":{"maximum":999999,"type":"integer","description":"Centro de Custos"},"numeroDuplicatas":{"maximum":999999,"type":"integer","description":"Número de Duplicatas"},"chaveNfeNotaFiscal":{"type":"string","description":"Chave de Acesso NF-e da Nota Fiscal"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/contasReceber":{"get":{"tags":["Contas a Receber"],"summary":"Obter listagem de Contas a Receber","operationId":"ObterContasReceber","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}},{"name":"tipoTitulo","in":"query","description":"Tipo do Título (0 - Em aberto, 1 - Pagas, 3 - Todas)","schema":{"type":"integer"}},{"name":"dataEmissaoIni","in":"query","description":"Data de Emissão Início (YYYY-MM-DD)","schema":{"type":"string","format":"date"}},{"name":"dataEmissaoFim","in":"query","description":"Data de Emissão Fim (YYYY-MM-DD)","schema":{"type":"string","format":"date"}},{"name":"dataVencimentoIni","in":"query","description":"Data de Vencimento Início (YYYY-MM-DD)","schema":{"type":"string","format":"date"}},{"name":"dataVencimentoFim","in":"query","description":"Data de Vencimento Fim (YYYY-MM-DD)","schema":{"type":"string","format":"date"}},{"name":"listaCliente","in":"query","description":"Lista de Clientes","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"listaChaveNfe","in":"query","description":"Lista de Chave NFe","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"listaCnpjCliente","in":"query","description":"Lista de Cnpj de Clientes","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"campoFiltroDinamico","in":"query","description":"Campo para filtrar dinamicamente no SQL","schema":{"type":"string"}},{"name":"valorFiltroDinamico","in":"query","description":"Valor para filtrar dinamicamente no SQL","schema":{"type":"string"}},{"name":"paginacao","in":"query","description":"Quantidade de itens na paginação de retorno","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaContasReceber"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /contasReceber > Cadastrar uma Conta a Receber ```json {"openapi":"3.0.1","info":{"title":"Financeiro","version":"1.0"},"tags":[{"name":"Contas a Receber","description":"ContasReceber"}],"servers":[{"url":"https://localhost/financeiro/v10"},{"url":"http://localhost/financeiro/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ContaReceberPut":{"type":"object","properties":{"codTitulo":{"maxLength":50,"type":"string","description":"Código do Título"},"codCliente":{"maximum":9999999,"type":"integer","description":"Código do Cliente"},"codRepresentante":{"maximum":999999,"type":"integer","description":"Código do Representante"},"codPortador":{"maximum":999999,"type":"integer","description":"Código do Portador"},"tipoCobranca":{"maximum":999999,"type":"integer","description":"Tipo de Cobrança"},"dataEmissao":{"type":"string","description":"Data de Emissão (YYYY-MM-DD)","format":"date"},"dataVenc":{"type":"string","description":"Data de Vencimento (YYYY-MM-DD)","format":"date"},"dataPagamento":{"type":"string","description":"Data de Pagamento (YYYY-MM-DD)","format":"date"},"valorTitulo":{"multipleOf":0.01,"type":"number","description":"Valor do Título"},"tipoBaixa":{"maximum":999999,"type":"integer","description":"Tipo de Baixa"},"dataBaixaContabil":{"type":"string","description":"Data da Baixa Contábil (YYYY-MM-DD)","format":"date"},"valorJuros":{"multipleOf":0.01,"type":"number","description":"Valor de Juros do Título"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor de Desconto do Título"},"numeroBancario":{"maxLength":50,"type":"string","description":"Registro Bancário"},"agenciaBancaria":{"maxLength":50,"type":"string","description":"Agência Bancária"},"comissaoLiquida":{"maximum":999999,"type":"integer","description":"Valor de Comissão na Liquidação"},"percDesconto":{"multipleOf":0.01,"type":"number","description":"Percentual do Desconto"},"percComissao":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"carteira":{"maximum":999999,"type":"integer","description":"Carteira"},"contaBancaria":{"maximum":999999,"type":"integer","description":"Conta Bancária"},"dataFluxoCaixa":{"type":"string","description":"Data do Fluxo de Caixa (YYYY-MM-DD)","format":"date"},"centroCustos":{"maximum":999999,"type":"integer","description":"Centro de Custos"},"numeroDuplicatas":{"maximum":999999,"type":"integer","description":"Número de Duplicatas"},"flagReplicado":{"type":"boolean","description":"Flag Replicado"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/contasReceber":{"put":{"tags":["Contas a Receber"],"summary":"Cadastrar uma Conta a Receber","operationId":"CadastrarContaReceber","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Conta a Receber","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContaReceberPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /contasReceber/{id} > Obtem Títulos do Contas a Receber ```json {"openapi":"3.0.1","info":{"title":"Financeiro","version":"1.0"},"tags":[{"name":"Contas a Receber","description":"ContasReceber"}],"servers":[{"url":"https://localhost/financeiro/v10"},{"url":"http://localhost/financeiro/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ContasReceber":{"type":"object","properties":{"codTitulo":{"maxLength":50,"type":"string","description":"Código do Título"},"codCliente":{"maximum":9999999,"type":"integer","description":"Código do Cliente"},"codRepresentante":{"maximum":999999,"type":"integer","description":"Código do Representante"},"codPortador":{"maximum":999999,"type":"integer","description":"Código do Portador"},"tipoCobranca":{"maximum":999999,"type":"integer","description":"Tipo de Cobrança"},"dataEmissao":{"type":"string","description":"Data de Emissão (YYYY-MM-DD)","format":"date"},"notaFiscal":{"type":"string","description":"Código da Nota Fiscal"},"dataVenc":{"type":"string","description":"Data de Vencimento (YYYY-MM-DD)","format":"date"},"dataPagamento":{"type":"string","description":"Data de Pagamento (YYYY-MM-DD)","format":"date"},"valorTitulo":{"multipleOf":0.01,"type":"number","description":"Valor do Título"},"tipoBaixa":{"maximum":999999,"type":"integer","description":"Tipo de Baixa"},"dataBaixaContabil":{"type":"string","description":"Data da Baixa Contábil (YYYY-MM-DD)","format":"date"},"valorJuros":{"multipleOf":0.01,"type":"number","description":"Valor de Juros do Título"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor de Desconto do Título"},"numeroBancario":{"maxLength":50,"type":"string","description":"Registro Bancário"},"agenciaBancaria":{"maxLength":50,"type":"string","description":"Agência Bancária"},"valorComissaoFaturamento":{"multipleOf":0.01,"type":"number","description":"Valor de Comissão no Faturamento"},"valorComissaoLiquidacao":{"multipleOf":0.01,"type":"number","description":"Valor de Comissão na Liquidação"},"percDesconto":{"multipleOf":0.01,"type":"number","description":"Percentual do Desconto"},"percComissao":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"carteira":{"maximum":999999,"type":"integer","description":"Carteira"},"contaBancaria":{"maximum":999999,"type":"integer","description":"Conta Bancária"},"dataFluxoCaixa":{"type":"string","description":"Data do Fluxo de Caixa (YYYY-MM-DD)","format":"date"},"centroCustos":{"maximum":999999,"type":"integer","description":"Centro de Custos"},"numeroDuplicatas":{"maximum":999999,"type":"integer","description":"Número de Duplicatas"},"chaveNfeNotaFiscal":{"type":"string","description":"Chave de Acesso NF-e da Nota Fiscal"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/contasReceber/{id}":{"get":{"tags":["Contas a Receber"],"summary":"Obtem Títulos do Contas a Receber","operationId":"ObterContaReceber","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Título (Quando o identificador da parcela for '/', utilizar '|')","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContasReceber"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /contasReceber/{id} > Alterar um Título do Contas a Receber ```json {"openapi":"3.0.1","info":{"title":"Financeiro","version":"1.0"},"tags":[{"name":"Contas a Receber","description":"ContasReceber"}],"servers":[{"url":"https://localhost/financeiro/v10"},{"url":"http://localhost/financeiro/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ContaReceberPut":{"type":"object","properties":{"codTitulo":{"maxLength":50,"type":"string","description":"Código do Título"},"codCliente":{"maximum":9999999,"type":"integer","description":"Código do Cliente"},"codRepresentante":{"maximum":999999,"type":"integer","description":"Código do Representante"},"codPortador":{"maximum":999999,"type":"integer","description":"Código do Portador"},"tipoCobranca":{"maximum":999999,"type":"integer","description":"Tipo de Cobrança"},"dataEmissao":{"type":"string","description":"Data de Emissão (YYYY-MM-DD)","format":"date"},"dataVenc":{"type":"string","description":"Data de Vencimento (YYYY-MM-DD)","format":"date"},"dataPagamento":{"type":"string","description":"Data de Pagamento (YYYY-MM-DD)","format":"date"},"valorTitulo":{"multipleOf":0.01,"type":"number","description":"Valor do Título"},"tipoBaixa":{"maximum":999999,"type":"integer","description":"Tipo de Baixa"},"dataBaixaContabil":{"type":"string","description":"Data da Baixa Contábil (YYYY-MM-DD)","format":"date"},"valorJuros":{"multipleOf":0.01,"type":"number","description":"Valor de Juros do Título"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor de Desconto do Título"},"numeroBancario":{"maxLength":50,"type":"string","description":"Registro Bancário"},"agenciaBancaria":{"maxLength":50,"type":"string","description":"Agência Bancária"},"comissaoLiquida":{"maximum":999999,"type":"integer","description":"Valor de Comissão na Liquidação"},"percDesconto":{"multipleOf":0.01,"type":"number","description":"Percentual do Desconto"},"percComissao":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"carteira":{"maximum":999999,"type":"integer","description":"Carteira"},"contaBancaria":{"maximum":999999,"type":"integer","description":"Conta Bancária"},"dataFluxoCaixa":{"type":"string","description":"Data do Fluxo de Caixa (YYYY-MM-DD)","format":"date"},"centroCustos":{"maximum":999999,"type":"integer","description":"Centro de Custos"},"numeroDuplicatas":{"maximum":999999,"type":"integer","description":"Número de Duplicatas"},"flagReplicado":{"type":"boolean","description":"Flag Replicado"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"ContasReceber":{"type":"object","properties":{"codTitulo":{"maxLength":50,"type":"string","description":"Código do Título"},"codCliente":{"maximum":9999999,"type":"integer","description":"Código do Cliente"},"codRepresentante":{"maximum":999999,"type":"integer","description":"Código do Representante"},"codPortador":{"maximum":999999,"type":"integer","description":"Código do Portador"},"tipoCobranca":{"maximum":999999,"type":"integer","description":"Tipo de Cobrança"},"dataEmissao":{"type":"string","description":"Data de Emissão (YYYY-MM-DD)","format":"date"},"notaFiscal":{"type":"string","description":"Código da Nota Fiscal"},"dataVenc":{"type":"string","description":"Data de Vencimento (YYYY-MM-DD)","format":"date"},"dataPagamento":{"type":"string","description":"Data de Pagamento (YYYY-MM-DD)","format":"date"},"valorTitulo":{"multipleOf":0.01,"type":"number","description":"Valor do Título"},"tipoBaixa":{"maximum":999999,"type":"integer","description":"Tipo de Baixa"},"dataBaixaContabil":{"type":"string","description":"Data da Baixa Contábil (YYYY-MM-DD)","format":"date"},"valorJuros":{"multipleOf":0.01,"type":"number","description":"Valor de Juros do Título"},"valorDesconto":{"multipleOf":0.01,"type":"number","description":"Valor de Desconto do Título"},"numeroBancario":{"maxLength":50,"type":"string","description":"Registro Bancário"},"agenciaBancaria":{"maxLength":50,"type":"string","description":"Agência Bancária"},"valorComissaoFaturamento":{"multipleOf":0.01,"type":"number","description":"Valor de Comissão no Faturamento"},"valorComissaoLiquidacao":{"multipleOf":0.01,"type":"number","description":"Valor de Comissão na Liquidação"},"percDesconto":{"multipleOf":0.01,"type":"number","description":"Percentual do Desconto"},"percComissao":{"multipleOf":0.01,"type":"number","description":"Percentual de Comissão"},"carteira":{"maximum":999999,"type":"integer","description":"Carteira"},"contaBancaria":{"maximum":999999,"type":"integer","description":"Conta Bancária"},"dataFluxoCaixa":{"type":"string","description":"Data do Fluxo de Caixa (YYYY-MM-DD)","format":"date"},"centroCustos":{"maximum":999999,"type":"integer","description":"Centro de Custos"},"numeroDuplicatas":{"maximum":999999,"type":"integer","description":"Número de Duplicatas"},"chaveNfeNotaFiscal":{"type":"string","description":"Chave de Acesso NF-e da Nota Fiscal"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/contasReceber/{id}":{"put":{"tags":["Contas a Receber"],"summary":"Alterar um Título do Contas a Receber","operationId":"AlterarContaReceber","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Título (Quando o identificador da parcela for '/', utilizar '|')","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Conta a Receber","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContaReceberPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContasReceber"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## DELETE /contasReceber/{id} > Exclui uma Conta a Receber ```json {"openapi":"3.0.1","info":{"title":"Financeiro","version":"1.0"},"tags":[{"name":"Contas a Receber","description":"ContasReceber"}],"servers":[{"url":"https://localhost/financeiro/v10"},{"url":"http://localhost/financeiro/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/contasReceber/{id}":{"delete":{"tags":["Contas a Receber"],"summary":"Exclui uma Conta a Receber","operationId":"ExcluirContaReceber","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Título (Quando o identificador da parcela for '/', utilizar '|')","required":true,"schema":{"type":"string"}},{"name":"tipoTitulo","in":"query","description":"Tipo do Título (0 - Em aberto,1 - Pagas)","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /somaBoletoAberto > Obtem valor total vencido e a vencer dos boletos que estão em aberto. ```json {"openapi":"3.0.1","info":{"title":"Financeiro","version":"1.0"},"tags":[{"name":"Contas a Receber","description":"ContasReceber"}],"servers":[{"url":"https://localhost/financeiro/v10"},{"url":"http://localhost/financeiro/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"SomaBoletoAberto":{"type":"object","properties":{"valorTotalVencido":{"multipleOf":0.01,"type":"number","description":"Valor Total do Vencimento"},"valorTotalAberto":{"multipleOf":0.01,"type":"number","description":"Valor Total em Aberto"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/somaBoletoAberto":{"get":{"tags":["Contas a Receber"],"summary":"Obtem valor total vencido e a vencer dos boletos que estão em aberto.","operationId":"ObterSomaBoletoAberto","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"cliente","in":"query","description":"CPF/CNPJ do Cliente","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SomaBoletoAberto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /boleto > Obter Listagem de Boletos ```json {"openapi":"3.0.1","info":{"title":"Financeiro","version":"1.0"},"tags":[{"name":"Contas a Receber","description":"ContasReceber"}],"servers":[{"url":"https://localhost/financeiro/v10"},{"url":"http://localhost/financeiro/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Boleto":{"type":"object","properties":{"arquivo":{"type":"string","description":"Arquivo do Boleto","format":"binary"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/boleto":{"get":{"tags":["Contas a Receber"],"summary":"Obter Listagem de Boletos","operationId":"ObterBoletos","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"cliente","in":"query","description":"CPF/CNPJ do Cliente","required":true,"schema":{"type":"string"}},{"name":"dataInicio","in":"query","description":"Data de Vencimento Inicial de um Intervalo de Tempo (YYYY-MM-DD)","required":true,"schema":{"type":"string"}},{"name":"dataFim","in":"query","description":"Data de Vencimento Término de um Intervalo de Tempo (YYYY-MM-DD)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Boleto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /boletoNota/{notaFiscal} > Obter Boleto de Nota Fiscal de Saída ```json {"openapi":"3.0.1","info":{"title":"Financeiro","version":"1.0"},"tags":[{"name":"Contas a Receber","description":"ContasReceber"}],"servers":[{"url":"https://localhost/financeiro/v10"},{"url":"http://localhost/financeiro/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Boleto":{"type":"object","properties":{"arquivo":{"type":"string","description":"Arquivo do Boleto","format":"binary"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/boletoNota/{notaFiscal}":{"get":{"tags":["Contas a Receber"],"summary":"Obter Boleto de Nota Fiscal de Saída","operationId":"ObterBoletoNota","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"notaFiscal","in":"path","description":"Número da Nota Fiscal de Saída.","required":true,"schema":{"type":"string"}},{"name":"cliente","in":"query","description":"CPF/CNPJ do cliente","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Boleto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /titulosPagos > Obter Titulos Pagos ```json {"openapi":"3.0.1","info":{"title":"Financeiro","version":"1.0"},"tags":[{"name":"Contas a Receber","description":"ContasReceber"}],"servers":[{"url":"https://localhost/financeiro/v10"},{"url":"http://localhost/financeiro/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaTitulosPagosGet":{"type":"object","properties":{"titulosPagos":{"type":"array","items":{"$ref":"#/components/schemas/TitulosPagosGet"}}}},"TitulosPagosGet":{"type":"object","properties":{"codTitulo":{"type":"string","description":"Código do Titulo"},"cliente":{"type":"string","description":"Código do Cliente"},"vlrTitulo":{"multipleOf":0.01,"type":"number","description":"Valor do Titulo"},"dataVencimento":{"type":"string","description":"Data de Vencimento (YYYY-MM-DD)","format":"date"},"dataPagamento":{"type":"string","description":"Data de Pagamento (YYYY-MM-DD)","format":"date"},"vlrPago":{"multipleOf":0.01,"type":"number","description":"Valor Pago"},"portador":{"type":"string","description":"Código do Portador"},"tipoCobranca":{"type":"string","description":"Tipo de Cobrança"},"notaFiscal":{"type":"string","description":"Valor Pago"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/titulosPagos":{"get":{"tags":["Contas a Receber"],"summary":"Obter Titulos Pagos","operationId":"TitulosPagos","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"dataInicio","in":"query","description":"Data Início (YYYY-MM-DD)","required":true,"schema":{"type":"string","format":"date"}},{"name":"dataFim","in":"query","description":"Data Fim (YYYY-MM-DD)","required":true,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaTitulosPagosGet"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://ajuda.consistem.com.br/consistem-api/consistem-erp-api/financeiro/financeiro-v1.0/contas-a-receber.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.