Contas a Receber

ContasReceber

Obter listagem de Contas a Receber

get

https://localhost/financeiro/v10http://localhost/financeiro/v10

/contasReceber

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de consulta

continuationTokenstringOpcional

Identificador da Paginação da Consulta

tipoTitulointegerOpcional

Tipo do Título (0 - Em aberto, 1 - Pagas, 3 - Todas)

dataEmissaoInistring · dateOpcional

Data de Emissão Início (YYYY-MM-DD)

dataEmissaoFimstring · dateOpcional

Data de Emissão Fim (YYYY-MM-DD)

dataVencimentoInistring · dateOpcional

Data de Vencimento Início (YYYY-MM-DD)

dataVencimentoFimstring · dateOpcional

Data de Vencimento Fim (YYYY-MM-DD)

listaClienteinteger[]Opcional

Lista de Clientes

listaChaveNfestring[]Opcional

Lista de Chave NFe

listaCnpjClientestring[]Opcional

Lista de Cnpj de Clientes

campoFiltroDinamicostringOpcional

Campo para filtrar dinamicamente no SQL

valorFiltroDinamicostringOpcional

Valor para filtrar dinamicamente no SQL

paginacaointegerOpcional

Quantidade de itens na paginação de retorno

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

OK

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/contasReceber

HTTPcURLJavaScriptPython

GET /financeiro/v10/contasReceber HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "continuationToken": "text",
  "data": [
    {
      "codTitulo": "text",
      "codCliente": 1,
      "codRepresentante": 1,
      "codPortador": 1,
      "tipoCobranca": 1,
      "dataEmissao": "2025-11-28",
      "notaFiscal": "text",
      "dataVenc": "2025-11-28",
      "dataPagamento": "2025-11-28",
      "valorTitulo": 1,
      "tipoBaixa": 1,
      "dataBaixaContabil": "2025-11-28",
      "valorJuros": 1,
      "valorDesconto": 1,
      "numeroBancario": "text",
      "agenciaBancaria": "text",
      "valorComissaoFaturamento": 1,
      "valorComissaoLiquidacao": 1,
      "percDesconto": 1,
      "percComissao": 1,
      "carteira": 1,
      "contaBancaria": 1,
      "dataFluxoCaixa": "2025-11-28",
      "centroCustos": 1,
      "numeroDuplicatas": 1,
      "chaveNfeNotaFiscal": "text",
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ]
}

Cadastrar uma Conta a Receber

put

https://localhost/financeiro/v10http://localhost/financeiro/v10

/contasReceber

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

application/json

codTitulostring · máx: 50Opcional

Código do Título

codClienteinteger · máx: 9999999Opcional

Código do Cliente

codRepresentanteinteger · máx: 999999Opcional

Código do Representante

codPortadorinteger · máx: 999999Opcional

Código do Portador

tipoCobrancainteger · máx: 999999Opcional

Tipo de Cobrança

dataEmissaostring · dateOpcional

Data de Emissão (YYYY-MM-DD)

dataVencstring · dateOpcional

Data de Vencimento (YYYY-MM-DD)

dataPagamentostring · dateOpcional

Data de Pagamento (YYYY-MM-DD)

valorTitulonumberOpcional

Valor do Título

tipoBaixainteger · máx: 999999Opcional

Tipo de Baixa

dataBaixaContabilstring · dateOpcional

Data da Baixa Contábil (YYYY-MM-DD)

valorJurosnumberOpcional

Valor de Juros do Título

valorDescontonumberOpcional

Valor de Desconto do Título

numeroBancariostring · máx: 50Opcional

Registro Bancário

agenciaBancariastring · máx: 50Opcional

Agência Bancária

comissaoLiquidainteger · máx: 999999Opcional

Valor de Comissão na Liquidação

percDescontonumberOpcional

Percentual do Desconto

percComissaonumberOpcional

Percentual de Comissão

carteirainteger · máx: 999999Opcional

Carteira

contaBancariainteger · máx: 999999Opcional

Conta Bancária

dataFluxoCaixastring · dateOpcional

Data do Fluxo de Caixa (YYYY-MM-DD)

centroCustosinteger · máx: 999999Opcional

Centro de Custos

numeroDuplicatasinteger · máx: 999999Opcional

Número de Duplicatas

flagReplicadobooleanOpcional

Flag Replicado

Respostas

200

OK

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/contasReceber

HTTPcURLJavaScriptPython

PUT /financeiro/v10/contasReceber HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 542

{
  "codTitulo": "text",
  "codCliente": 1,
  "codRepresentante": 1,
  "codPortador": 1,
  "tipoCobranca": 1,
  "dataEmissao": "2025-11-28",
  "dataVenc": "2025-11-28",
  "dataPagamento": "2025-11-28",
  "valorTitulo": 1,
  "tipoBaixa": 1,
  "dataBaixaContabil": "2025-11-28",
  "valorJuros": 1,
  "valorDesconto": 1,
  "numeroBancario": "text",
  "agenciaBancaria": "text",
  "comissaoLiquida": 1,
  "percDesconto": 1,
  "percComissao": 1,
  "carteira": 1,
  "contaBancaria": 1,
  "dataFluxoCaixa": "2025-11-28",
  "centroCustos": 1,
  "numeroDuplicatas": 1,
  "flagReplicado": true,
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Sem conteúdo

Obtem Títulos do Contas a Receber

get

https://localhost/financeiro/v10http://localhost/financeiro/v10

/contasReceber/{id}

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Título (Quando o identificador da parcela for '/', utilizar '|')

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

OK

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/contasReceber/{id}

HTTPcURLJavaScriptPython

GET /financeiro/v10/contasReceber/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

[
  {
    "codTitulo": "text",
    "codCliente": 1,
    "codRepresentante": 1,
    "codPortador": 1,
    "tipoCobranca": 1,
    "dataEmissao": "2025-11-28",
    "notaFiscal": "text",
    "dataVenc": "2025-11-28",
    "dataPagamento": "2025-11-28",
    "valorTitulo": 1,
    "tipoBaixa": 1,
    "dataBaixaContabil": "2025-11-28",
    "valorJuros": 1,
    "valorDesconto": 1,
    "numeroBancario": "text",
    "agenciaBancaria": "text",
    "valorComissaoFaturamento": 1,
    "valorComissaoLiquidacao": 1,
    "percDesconto": 1,
    "percComissao": 1,
    "carteira": 1,
    "contaBancaria": 1,
    "dataFluxoCaixa": "2025-11-28",
    "centroCustos": 1,
    "numeroDuplicatas": 1,
    "chaveNfeNotaFiscal": "text",
    "dadosCustomizados": [
      {
        "campo": "text",
        "valor": "text"
      }
    ]
  }
]

Alterar um Título do Contas a Receber

put

https://localhost/financeiro/v10http://localhost/financeiro/v10

/contasReceber/{id}

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Título (Quando o identificador da parcela for '/', utilizar '|')

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

application/json

codTitulostring · máx: 50Opcional

Código do Título

codClienteinteger · máx: 9999999Opcional

Código do Cliente

codRepresentanteinteger · máx: 999999Opcional

Código do Representante

codPortadorinteger · máx: 999999Opcional

Código do Portador

tipoCobrancainteger · máx: 999999Opcional

Tipo de Cobrança

dataEmissaostring · dateOpcional

Data de Emissão (YYYY-MM-DD)

dataVencstring · dateOpcional

Data de Vencimento (YYYY-MM-DD)

dataPagamentostring · dateOpcional

Data de Pagamento (YYYY-MM-DD)

valorTitulonumberOpcional

Valor do Título

tipoBaixainteger · máx: 999999Opcional

Tipo de Baixa

dataBaixaContabilstring · dateOpcional

Data da Baixa Contábil (YYYY-MM-DD)

valorJurosnumberOpcional

Valor de Juros do Título

valorDescontonumberOpcional

Valor de Desconto do Título

numeroBancariostring · máx: 50Opcional

Registro Bancário

agenciaBancariastring · máx: 50Opcional

Agência Bancária

comissaoLiquidainteger · máx: 999999Opcional

Valor de Comissão na Liquidação

percDescontonumberOpcional

Percentual do Desconto

percComissaonumberOpcional

Percentual de Comissão

carteirainteger · máx: 999999Opcional

Carteira

contaBancariainteger · máx: 999999Opcional

Conta Bancária

dataFluxoCaixastring · dateOpcional

Data do Fluxo de Caixa (YYYY-MM-DD)

centroCustosinteger · máx: 999999Opcional

Centro de Custos

numeroDuplicatasinteger · máx: 999999Opcional

Número de Duplicatas

flagReplicadobooleanOpcional

Flag Replicado

Respostas

200

OK

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/contasReceber/{id}

HTTPcURLJavaScriptPython

PUT /financeiro/v10/contasReceber/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 542

{
  "codTitulo": "text",
  "codCliente": 1,
  "codRepresentante": 1,
  "codPortador": 1,
  "tipoCobranca": 1,
  "dataEmissao": "2025-11-28",
  "dataVenc": "2025-11-28",
  "dataPagamento": "2025-11-28",
  "valorTitulo": 1,
  "tipoBaixa": 1,
  "dataBaixaContabil": "2025-11-28",
  "valorJuros": 1,
  "valorDesconto": 1,
  "numeroBancario": "text",
  "agenciaBancaria": "text",
  "comissaoLiquida": 1,
  "percDesconto": 1,
  "percComissao": 1,
  "carteira": 1,
  "contaBancaria": 1,
  "dataFluxoCaixa": "2025-11-28",
  "centroCustos": 1,
  "numeroDuplicatas": 1,
  "flagReplicado": true,
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

{
  "codTitulo": "text",
  "codCliente": 1,
  "codRepresentante": 1,
  "codPortador": 1,
  "tipoCobranca": 1,
  "dataEmissao": "2025-11-28",
  "notaFiscal": "text",
  "dataVenc": "2025-11-28",
  "dataPagamento": "2025-11-28",
  "valorTitulo": 1,
  "tipoBaixa": 1,
  "dataBaixaContabil": "2025-11-28",
  "valorJuros": 1,
  "valorDesconto": 1,
  "numeroBancario": "text",
  "agenciaBancaria": "text",
  "valorComissaoFaturamento": 1,
  "valorComissaoLiquidacao": 1,
  "percDesconto": 1,
  "percComissao": 1,
  "carteira": 1,
  "contaBancaria": 1,
  "dataFluxoCaixa": "2025-11-28",
  "centroCustos": 1,
  "numeroDuplicatas": 1,
  "chaveNfeNotaFiscal": "text",
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Exclui uma Conta a Receber

delete

https://localhost/financeiro/v10http://localhost/financeiro/v10

/contasReceber/{id}

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Título (Quando o identificador da parcela for '/', utilizar '|')

Parâmetros de consulta

tipoTitulointegerObrigatório

Tipo do Título (0 - Em aberto,1 - Pagas)

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

OK

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

delete

/contasReceber/{id}

HTTPcURLJavaScriptPython

DELETE /financeiro/v10/contasReceber/{id}?tipoTitulo=1 HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

Sem conteúdo

Obtem valor total vencido e a vencer dos boletos que estão em aberto.

get

https://localhost/financeiro/v10http://localhost/financeiro/v10

/somaBoletoAberto

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de consulta

clientestringObrigatório

CPF/CNPJ do Cliente

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

OK

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/somaBoletoAberto

HTTPcURLJavaScriptPython

GET /financeiro/v10/somaBoletoAberto?cliente=text HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "valorTotalVencido": 1,
  "valorTotalAberto": 1
}

Obter Listagem de Boletos

get

https://localhost/financeiro/v10http://localhost/financeiro/v10

/boleto

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de consulta

clientestringObrigatório

CPF/CNPJ do Cliente

dataIniciostringObrigatório

Data de Vencimento Inicial de um Intervalo de Tempo (YYYY-MM-DD)

dataFimstringObrigatório

Data de Vencimento Término de um Intervalo de Tempo (YYYY-MM-DD)

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

OK

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/boleto

HTTPcURLJavaScriptPython

GET /financeiro/v10/boleto?cliente=text&dataInicio=text&dataFim=text HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "arquivo": "binary"
}

Obter Boleto de Nota Fiscal de Saída

get

https://localhost/financeiro/v10http://localhost/financeiro/v10

/boletoNota/{notaFiscal}

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de rota

notaFiscalstringObrigatório

Número da Nota Fiscal de Saída.

Parâmetros de consulta

clientestringObrigatório

CPF/CNPJ do cliente

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

OK

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/boletoNota/{notaFiscal}

HTTPcURLJavaScriptPython

GET /financeiro/v10/boletoNota/{notaFiscal}?cliente=text HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "arquivo": "binary"
}

Obter Titulos Pagos

get

https://localhost/financeiro/v10http://localhost/financeiro/v10

/titulosPagos

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de consulta

dataIniciostring · dateObrigatório

Data Início (YYYY-MM-DD)

dataFimstring · dateObrigatório

Data Fim (YYYY-MM-DD)

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

OK

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/titulosPagos

HTTPcURLJavaScriptPython

GET /financeiro/v10/titulosPagos?dataInicio=2025-11-28&dataFim=2025-11-28 HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "titulosPagos": [
    {
      "codTitulo": "text",
      "cliente": "text",
      "vlrTitulo": 1,
      "dataVencimento": "2025-11-28",
      "dataPagamento": "2025-11-28",
      "vlrPago": 1,
      "portador": "text",
      "tipoCobranca": "text",
      "notaFiscal": "text",
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ]
}