Lançamento Contas a Pagar

LancamentoContasPagar

Obter Listagem de Lançamentos do Contas a Pagar

get

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

/lancamentoContasPagar

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de consulta

situacaointegerOpcional

Tipo do Documento (0 - Em aberto, 1 - Pagos ou Nulo para todos)

categoriainteger[]Opcional

Lista de Categorias

portadorinteger[]Opcional

Lista de Portadores

origeminteger[]Opcional

Lista de Origem do Documento (0 - Contas a Pagar, 1 - Entradas,2 - Tranportes, 3 - Conta Corrente Grãos, 4 - Fretes, 5 - PPCP Confecção, 6 - Folha de Pagamento, 7 - Importação, 8 - Escrita Fiscal, 9 - Customização, 10 - Contábil, 11 - Empréstimos/Financiamentos)

tipoDocumentointegerOpcional

Tipo do Documento (0 - Carteira, 1 - Agendados ou Nulo para todos)

venceApresentacaointegerOpcional

Listar Documentos com Vencimento na Apresentação? (0 - Não,1 - Sim)

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)

dataPagamentoInistring · dateOpcional

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

dataPagamentoFimstring · dateOpcional

fornecedorinteger[]Opcional

Lista de Fornecedores

campoFiltroDinamicostringOpcional

Campo para filtrar dinamicamente no SQL

valorFiltroDinamicostringOpcional

Valor para filtrar dinamicamente no SQL

continuationTokenstringOpcional

Identificador da Paginação da Consulta

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

/lancamentoContasPagar

HTTPcURLJavaScriptPython

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

{
  "continuationToken": "text",
  "data": [
    {
      "codLancamento": 1,
      "codFornecedor": 1,
      "categoriaDoc": 1,
      "codDocumento": "text",
      "codPortador": 1,
      "dataEmissao": "2025-11-29",
      "dataEntrada": "2025-11-29",
      "dataVencimento": "2025-11-29",
      "dataVencimentoOriginal": "2025-11-29",
      "dataPagamento": "2025-11-29",
      "diasPrazo": 1,
      "valorDocumento": 1,
      "valorDesconto": 1,
      "valorJuros": 1,
      "valorMulta": 1,
      "valorPago": 1,
      "tipoMoeda": 1,
      "codHistorico": 1,
      "complementoHistorico": "text",
      "grupoContaFluxoCaixa": 1,
      "contaFluxoCaixa": 1,
      "valorOriginalDocumento": 1,
      "tipoLancamento": "D",
      "codOrigem": 1,
      "codBarras": "text",
      "qrCodePix": "text",
      "dadosContabilidade": {
        "contaContabilDebito": 1,
        "contaContabilCredito": 1,
        "listaCentroCustoContab": [
          {
            "contaContabil": 1,
            "centroCusto": "text",
            "evento": "text",
            "valor": 1,
            "dadosCustomizados": [
              {
                "campo": "text",
                "valor": "text"
              }
            ]
          }
        ]
      },
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ]
}

Gerar um Lançamento de Contas a Pagar

put

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

/lancamentoContasPagar

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

application/json

codFornecedorintegerObrigatório

Código do Fornecedor

categoriaDocintegerOpcional

Categoria do Documento

codDocumentostring · máx: 50Obrigatório

Número do Documento

codPortadorintegerOpcional

Código do Portador

dataEmissaostring · dateObrigatório

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

dataEntradastring · dateObrigatório

Data de Entrada (YYYY-MM-DD)

dataVencimentostring · dateOpcional

Data de Vencimento (YYYY-MM-DD)

diasPrazointeger · máx: 3Opcional

valorDocumentonumberObrigatório

Valor do Documento

valorDescontonumberOpcional

Valor do Desconto

valorJurosnumberOpcional

Valor dos Juros

valorMultanumberOpcional

Valor do Multa

tipoMoedaintegerOpcional

Tipo de Moeda

codHistoricointegerOpcional

Código do Histórico

complementoHistoricostring · máx: 70Opcional

Complemento do Histórico

grupoContaFluxoCaixaintegerOpcional

Código do Grupo da Conta de Fluxo de Caixa

contaFluxoCaixaintegerOpcional

Código da Conta de Fluxo de Caixa

valorOriginalDocumentonumberOpcional

Valor Original do Documento

codBarrasstringOpcional

Código de Barras para Pagamento

qrCodePixstringOpcional

Código do QR Code Pix

Respostas

200

OK

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/lancamentoContasPagar

HTTPcURLJavaScriptPython

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

{
  "codFornecedor": 1,
  "categoriaDoc": 1,
  "codDocumento": "text",
  "codPortador": 1,
  "dataEmissao": "2025-11-29",
  "dataEntrada": "2025-11-29",
  "dataVencimento": "2025-11-29",
  "diasPrazo": 1,
  "valorDocumento": 1,
  "valorDesconto": 1,
  "valorJuros": 1,
  "valorMulta": 1,
  "tipoMoeda": 1,
  "codHistorico": 1,
  "complementoHistorico": "text",
  "grupoContaFluxoCaixa": 1,
  "contaFluxoCaixa": 1,
  "valorOriginalDocumento": 1,
  "codBarras": "text",
  "qrCodePix": "text",
  "dadosContabilidade": {
    "contaContabilDebito": 1,
    "contaContabilCredito": 1,
    "listaCentroCustoContab": [
      {
        "contaContabil": 1,
        "centroCusto": "text",
        "evento": "text",
        "valor": 1,
        "dadosCustomizados": [
          {
            "campo": "text",
            "valor": "text"
          }
        ]
      }
    ]
  },
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

{
  "codLancamento": 1,
  "codFornecedor": 1,
  "categoriaDoc": 1,
  "codDocumento": "text",
  "codPortador": 1,
  "dataEmissao": "2025-11-29",
  "dataEntrada": "2025-11-29",
  "dataVencimento": "2025-11-29",
  "dataVencimentoOriginal": "2025-11-29",
  "dataPagamento": "2025-11-29",
  "diasPrazo": 1,
  "valorDocumento": 1,
  "valorDesconto": 1,
  "valorJuros": 1,
  "valorMulta": 1,
  "valorPago": 1,
  "tipoMoeda": 1,
  "codHistorico": 1,
  "complementoHistorico": "text",
  "grupoContaFluxoCaixa": 1,
  "contaFluxoCaixa": 1,
  "valorOriginalDocumento": 1,
  "tipoLancamento": "D",
  "codOrigem": 1,
  "codBarras": "text",
  "qrCodePix": "text",
  "dadosContabilidade": {
    "contaContabilDebito": 1,
    "contaContabilCredito": 1,
    "listaCentroCustoContab": [
      {
        "contaContabil": 1,
        "centroCusto": "text",
        "evento": "text",
        "valor": 1,
        "dadosCustomizados": [
          {
            "campo": "text",
            "valor": "text"
          }
        ]
      }
    ]
  },
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Obtem um Lançamento de Contas a Pagar

get

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

/lancamentoContasPagar/{id}

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do lançamento

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

/lancamentoContasPagar/{id}

HTTPcURLJavaScriptPython

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

[
  {
    "codLancamento": 1,
    "codFornecedor": 1,
    "categoriaDoc": 1,
    "codDocumento": "text",
    "codPortador": 1,
    "dataEmissao": "2025-11-29",
    "dataEntrada": "2025-11-29",
    "dataVencimento": "2025-11-29",
    "dataVencimentoOriginal": "2025-11-29",
    "dataPagamento": "2025-11-29",
    "diasPrazo": 1,
    "valorDocumento": 1,
    "valorDesconto": 1,
    "valorJuros": 1,
    "valorMulta": 1,
    "valorPago": 1,
    "tipoMoeda": 1,
    "codHistorico": 1,
    "complementoHistorico": "text",
    "grupoContaFluxoCaixa": 1,
    "contaFluxoCaixa": 1,
    "valorOriginalDocumento": 1,
    "tipoLancamento": "D",
    "codOrigem": 1,
    "codBarras": "text",
    "qrCodePix": "text",
    "dadosContabilidade": {
      "contaContabilDebito": 1,
      "contaContabilCredito": 1,
      "listaCentroCustoContab": [
        {
          "contaContabil": 1,
          "centroCusto": "text",
          "evento": "text",
          "valor": 1,
          "dadosCustomizados": [
            {
              "campo": "text",
              "valor": "text"
            }
          ]
        }
      ]
    },
    "dadosCustomizados": [
      {
        "campo": "text",
        "valor": "text"
      }
    ]
  }
]

Alterar Lançamento de uma Conta a Pagar

put

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

/lancamentoContasPagar/{id}

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Lançamento

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

application/json

codPortadorintegerOpcional

Código do Portador

dataEmissaostring · dateOpcional

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

dataEntradastring · dateOpcional

Data de Entrada (YYYY-MM-DD). Para Alteração Necessário Informar Conta Contábil de Débito Nos Dados da Contabilidade.

dataVencimentostring · dateOpcional

Data de Vencimento (YYYY-MM-DD)

diasPrazointeger · máx: 3Opcional

valorDocumentonumberOpcional

Valor do Documento. Para Alteração Necessário Informar Conta Contábil de Débito Nos Dados da Contabilidade.

valorDescontonumberOpcional

Valor do Desconto

valorJurosnumberOpcional

Valor dos Juros

valorMultanumberOpcional

Valor do Multa

tipoMoedaintegerOpcional

Tipo de Moeda

codHistoricointegerOpcional

Código do Histórico

complementoHistoricostring · máx: 70Opcional

Complemento do Histórico

grupoContaFluxoCaixaintegerOpcional

Código do Grupo da Conta de Fluxo de Caixa

contaFluxoCaixaintegerOpcional

Código da Conta de Fluxo de Caixa

valorOriginalDocumentonumberOpcional

Valor Original do Documento

codBarrasstringOpcional

Código de Barras para Pagamento

qrCodePixstringOpcional

Código do QR Code Pix

Respostas

200

OK

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/lancamentoContasPagar/{id}

HTTPcURLJavaScriptPython

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

{
  "codPortador": 1,
  "dataEmissao": "2025-11-29",
  "dataEntrada": "2025-11-29",
  "dataVencimento": "2025-11-29",
  "diasPrazo": 1,
  "valorDocumento": 1,
  "valorDesconto": 1,
  "valorJuros": 1,
  "valorMulta": 1,
  "tipoMoeda": 1,
  "codHistorico": 1,
  "complementoHistorico": "text",
  "grupoContaFluxoCaixa": 1,
  "contaFluxoCaixa": 1,
  "valorOriginalDocumento": 1,
  "codBarras": "text",
  "qrCodePix": "text",
  "dadosContabilidade": {
    "contaContabilDebito": 1,
    "contaContabilCredito": 1,
    "listaCentroCustoContab": [
      {
        "contaContabil": 1,
        "centroCusto": "text",
        "evento": "text",
        "valor": 1,
        "dadosCustomizados": [
          {
            "campo": "text",
            "valor": "text"
          }
        ]
      }
    ]
  },
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

{
  "codLancamento": 1,
  "codFornecedor": 1,
  "categoriaDoc": 1,
  "codDocumento": "text",
  "codPortador": 1,
  "dataEmissao": "2025-11-29",
  "dataEntrada": "2025-11-29",
  "dataVencimento": "2025-11-29",
  "dataVencimentoOriginal": "2025-11-29",
  "dataPagamento": "2025-11-29",
  "diasPrazo": 1,
  "valorDocumento": 1,
  "valorDesconto": 1,
  "valorJuros": 1,
  "valorMulta": 1,
  "valorPago": 1,
  "tipoMoeda": 1,
  "codHistorico": 1,
  "complementoHistorico": "text",
  "grupoContaFluxoCaixa": 1,
  "contaFluxoCaixa": 1,
  "valorOriginalDocumento": 1,
  "tipoLancamento": "D",
  "codOrigem": 1,
  "codBarras": "text",
  "qrCodePix": "text",
  "dadosContabilidade": {
    "contaContabilDebito": 1,
    "contaContabilCredito": 1,
    "listaCentroCustoContab": [
      {
        "contaContabil": 1,
        "centroCusto": "text",
        "evento": "text",
        "valor": 1,
        "dadosCustomizados": [
          {
            "campo": "text",
            "valor": "text"
          }
        ]
      }
    ]
  },
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Exclui um Lançamento de Conta a Pagar

delete

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

/lancamentoContasPagar/{id}

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Lançamento

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

/lancamentoContasPagar/{id}

HTTPcURLJavaScriptPython

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

Sem conteúdo