Contas a Pagar

ContasPagar

Obter Listagem de Contas a Pagar

get

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

/contasPagar

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

Data de Pagamento Fim (YYYY-MM-DD)

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

/contasPagar

HTTPcURLJavaScriptPython

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

{
  "continuationToken": "text",
  "data": [
    {
      "codLancamento": 1,
      "numDocumento": "text",
      "codFornecedor": 1,
      "codBanco": 1,
      "dataEmissao": "2025-11-28",
      "dataEntrada": "2025-11-28",
      "dataVencimento": "2025-11-28",
      "valorDocumento": 1,
      "tipoMoeda": 1,
      "tipoLancamento": "text",
      "codHistorico": 1,
      "complementoHistorico": "text",
      "valorOriginal": 1,
      "valorAtualizado": 1,
      "categoriaDoc": "text",
      "codOrigem": 1,
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ]
}

Cadastrar uma Conta a Pagar (Não Gera Contabilização)

put

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

/contasPagar

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

application/json

codLancamentointeger · máx: 999999Opcional

Código da Lançamento

numDocumentostring · máx: 50Opcional

Número do Documento

codFornecedorinteger · máx: 999999Opcional

Código do Fornecedor

codBancointeger · máx: 999999Opcional

Código do Banco

dataEmissaostring · dateOpcional

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

dataEntradastring · dateOpcional

Data de Entrada (YYYY-MM-DD)

dataVencimentostring · dateOpcional

Data de Vencimento (YYYY-MM-DD)

valorDocumentonumberObrigatório

Valor do Documento

tipoMoedainteger · máx: 999999Opcional

Tipo de Moeda

tipoLancamentostring · máx: 50Opcional

Tipo de Lançamento

codHistoricointeger · máx: 999999Opcional

Código do Histórico (Não obrigatório para tipo B - Baixa de Antecipação)

complementoHistoricostring · máx: 50Opcional

Complemento do Histórico

valorOriginalnumberOpcional

Valor Original

categoriaDocstring · máx: 50Opcional

Categoria do Documento

flagReplicadobooleanOpcional

Flag Replicado

Respostas

200

OK

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/contasPagar

HTTPcURLJavaScriptPython

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

{
  "codLancamento": 1,
  "numDocumento": "text",
  "codFornecedor": 1,
  "codBanco": 1,
  "dataEmissao": "2025-11-28",
  "dataEntrada": "2025-11-28",
  "dataVencimento": "2025-11-28",
  "valorDocumento": 1,
  "tipoMoeda": 1,
  "tipoLancamento": "text",
  "codHistorico": 1,
  "complementoHistorico": "text",
  "valorOriginal": 1,
  "categoriaDoc": "text",
  "flagReplicado": true,
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Sem conteúdo

Obtem uma Conta a Pagar

get

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

/contasPagar/{id}

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código da Conta

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

/contasPagar/{id}

HTTPcURLJavaScriptPython

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

[
  {
    "codLancamento": 1,
    "numDocumento": "text",
    "codFornecedor": 1,
    "codBanco": 1,
    "dataEmissao": "2025-11-28",
    "dataEntrada": "2025-11-28",
    "dataVencimento": "2025-11-28",
    "valorDocumento": 1,
    "tipoMoeda": 1,
    "tipoLancamento": "text",
    "codHistorico": 1,
    "complementoHistorico": "text",
    "valorOriginal": 1,
    "valorAtualizado": 1,
    "categoriaDoc": "text",
    "codOrigem": 1,
    "dadosCustomizados": [
      {
        "campo": "text",
        "valor": "text"
      }
    ]
  }
]

Alterar uma Conta a Pagar (Não Gera Contabilização)

put

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

/contasPagar/{id}

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código da Conta a Pagar

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

application/json

codLancamentointeger · máx: 999999Opcional

Código da Lançamento

numDocumentostring · máx: 50Opcional

Número do Documento

codFornecedorinteger · máx: 999999Opcional

Código do Fornecedor

codBancointeger · máx: 999999Opcional

Código do Banco

dataEmissaostring · dateOpcional

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

dataEntradastring · dateOpcional

Data de Entrada (YYYY-MM-DD)

dataVencimentostring · dateOpcional

Data de Vencimento (YYYY-MM-DD)

valorDocumentonumberObrigatório

Valor do Documento

tipoMoedainteger · máx: 999999Opcional

Tipo de Moeda

tipoLancamentostring · máx: 50Opcional

Tipo de Lançamento

codHistoricointeger · máx: 999999Opcional

Código do Histórico (Não obrigatório para tipo B - Baixa de Antecipação)

complementoHistoricostring · máx: 50Opcional

Complemento do Histórico

valorOriginalnumberOpcional

Valor Original

categoriaDocstring · máx: 50Opcional

Categoria do Documento

flagReplicadobooleanOpcional

Flag Replicado

Respostas

200

OK

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/contasPagar/{id}

HTTPcURLJavaScriptPython

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

{
  "codLancamento": 1,
  "numDocumento": "text",
  "codFornecedor": 1,
  "codBanco": 1,
  "dataEmissao": "2025-11-28",
  "dataEntrada": "2025-11-28",
  "dataVencimento": "2025-11-28",
  "valorDocumento": 1,
  "tipoMoeda": 1,
  "tipoLancamento": "text",
  "codHistorico": 1,
  "complementoHistorico": "text",
  "valorOriginal": 1,
  "categoriaDoc": "text",
  "flagReplicado": true,
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

{
  "codLancamento": 1,
  "numDocumento": "text",
  "codFornecedor": 1,
  "codBanco": 1,
  "dataEmissao": "2025-11-28",
  "dataEntrada": "2025-11-28",
  "dataVencimento": "2025-11-28",
  "valorDocumento": 1,
  "tipoMoeda": 1,
  "tipoLancamento": "text",
  "codHistorico": 1,
  "complementoHistorico": "text",
  "valorOriginal": 1,
  "valorAtualizado": 1,
  "categoriaDoc": "text",
  "codOrigem": 1,
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Exclui uma Conta a Pagar

delete

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

/contasPagar/{id}

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código da Conta

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

/contasPagar/{id}

HTTPcURLJavaScriptPython

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

Sem conteúdo