# Contas a Pagar ContasPagar ## GET /contasPagar > Obter Listagem de Contas a Pagar ```json {"openapi":"3.0.1","info":{"title":"Financeiro","version":"1.0"},"tags":[{"name":"Contas a Pagar","description":"ContasPagar"}],"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":{"ListaContasPagar":{"type":"object","properties":{"continuationToken":{"maxLength":50,"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ContasPagar"}}}},"ContasPagar":{"type":"object","properties":{"codLancamento":{"maximum":999999,"type":"integer","description":"Código da Lançamento"},"numDocumento":{"maxLength":50,"type":"string","description":"Número do Documento"},"codFornecedor":{"maximum":999999,"type":"integer","description":"Código do Fornecedor"},"codBanco":{"maximum":999999,"type":"integer","description":"Código do Banco"},"dataEmissao":{"type":"string","description":"Data de Emissão (YYYY-MM-DD)","format":"date"},"dataEntrada":{"type":"string","description":"Data de Entrada (YYYY-MM-DD)","format":"date"},"dataVencimento":{"type":"string","description":"Data de Vencimento (YYYY-MM-DD)","format":"date"},"valorDocumento":{"multipleOf":0.01,"type":"number","description":"Valor do Documento"},"tipoMoeda":{"maximum":999999,"type":"integer","description":"Tipo de Moeda"},"tipoLancamento":{"maxLength":50,"type":"string","description":"Tipo de Lançamento"},"codHistorico":{"maximum":999999,"type":"integer","description":"Código do Histórico (Não obrigatório para tipo B - Baixa de Antecipação)"},"complementoHistorico":{"maxLength":50,"type":"string","description":"Complemento do Histórico"},"valorOriginal":{"multipleOf":0.01,"type":"number","description":"Valor Original"},"valorAtualizado":{"multipleOf":0.01,"type":"number","description":"Valor Atualizado"},"categoriaDoc":{"maxLength":50,"type":"string","description":"Categoria"},"codOrigem":{"maximum":99,"type":"integer","description":"Código da 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)"},"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":{"/contasPagar":{"get":{"tags":["Contas a Pagar"],"summary":"Obter Listagem de Contas a Pagar","operationId":"ObterContasPagar","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"situacao","in":"query","description":"Tipo do Documento (0 - Em aberto, 1 - Pagos ou Nulo para todos)","schema":{"type":"integer"}},{"name":"categoria","in":"query","description":"Lista de Categorias","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"portador","in":"query","description":"Lista de Portadores","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"origem","in":"query","description":"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)","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"tipoDocumento","in":"query","description":"Tipo do Documento (0 - Carteira, 1 - Agendados ou Nulo para todos)","schema":{"type":"integer"}},{"name":"venceApresentacao","in":"query","description":"Listar Documentos com Vencimento na Apresentação? (0 - Não,1 - Sim)","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":"dataPagamentoIni","in":"query","description":"Data de Pagamento Início (YYYY-MM-DD)","schema":{"type":"string","format":"date"}},{"name":"dataPagamentoFim","in":"query","description":"Data de Pagamento Fim (YYYY-MM-DD)","schema":{"type":"string","format":"date"}},{"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":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","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/ListaContasPagar"}}}},"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 /contasPagar > Cadastrar uma Conta a Pagar (Não Gera Contabilização) ```json {"openapi":"3.0.1","info":{"title":"Financeiro","version":"1.0"},"tags":[{"name":"Contas a Pagar","description":"ContasPagar"}],"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":{"ContaPagarPut":{"required":["valorDocumento"],"type":"object","properties":{"codLancamento":{"maximum":999999,"type":"integer","description":"Código da Lançamento"},"numDocumento":{"maxLength":50,"type":"string","description":"Número do Documento"},"codFornecedor":{"maximum":999999,"type":"integer","description":"Código do Fornecedor"},"codBanco":{"maximum":999999,"type":"integer","description":"Código do Banco"},"dataEmissao":{"type":"string","description":"Data de Emissão (YYYY-MM-DD)","format":"date"},"dataEntrada":{"type":"string","description":"Data de Entrada (YYYY-MM-DD)","format":"date"},"dataVencimento":{"type":"string","description":"Data de Vencimento (YYYY-MM-DD)","format":"date"},"valorDocumento":{"multipleOf":0.01,"type":"number","description":"Valor do Documento"},"tipoMoeda":{"maximum":999999,"type":"integer","description":"Tipo de Moeda"},"tipoLancamento":{"maxLength":50,"type":"string","description":"Tipo de Lançamento"},"codHistorico":{"maximum":999999,"type":"integer","description":"Código do Histórico (Não obrigatório para tipo B - Baixa de Antecipação)"},"complementoHistorico":{"maxLength":50,"type":"string","description":"Complemento do Histórico"},"valorOriginal":{"multipleOf":0.01,"type":"number","description":"Valor Original"},"categoriaDoc":{"maxLength":50,"type":"string","description":"Categoria do Documento"},"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":{"/contasPagar":{"put":{"tags":["Contas a Pagar"],"summary":"Cadastrar uma Conta a Pagar (Não Gera Contabilização)","operationId":"CadastrarContaPagar","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Conta a Pagar","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContaPagarPut"}}},"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 /contasPagar/{id} > Obtem uma Conta a Pagar ```json {"openapi":"3.0.1","info":{"title":"Financeiro","version":"1.0"},"tags":[{"name":"Contas a Pagar","description":"ContasPagar"}],"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":{"ContasPagar":{"type":"object","properties":{"codLancamento":{"maximum":999999,"type":"integer","description":"Código da Lançamento"},"numDocumento":{"maxLength":50,"type":"string","description":"Número do Documento"},"codFornecedor":{"maximum":999999,"type":"integer","description":"Código do Fornecedor"},"codBanco":{"maximum":999999,"type":"integer","description":"Código do Banco"},"dataEmissao":{"type":"string","description":"Data de Emissão (YYYY-MM-DD)","format":"date"},"dataEntrada":{"type":"string","description":"Data de Entrada (YYYY-MM-DD)","format":"date"},"dataVencimento":{"type":"string","description":"Data de Vencimento (YYYY-MM-DD)","format":"date"},"valorDocumento":{"multipleOf":0.01,"type":"number","description":"Valor do Documento"},"tipoMoeda":{"maximum":999999,"type":"integer","description":"Tipo de Moeda"},"tipoLancamento":{"maxLength":50,"type":"string","description":"Tipo de Lançamento"},"codHistorico":{"maximum":999999,"type":"integer","description":"Código do Histórico (Não obrigatório para tipo B - Baixa de Antecipação)"},"complementoHistorico":{"maxLength":50,"type":"string","description":"Complemento do Histórico"},"valorOriginal":{"multipleOf":0.01,"type":"number","description":"Valor Original"},"valorAtualizado":{"multipleOf":0.01,"type":"number","description":"Valor Atualizado"},"categoriaDoc":{"maxLength":50,"type":"string","description":"Categoria"},"codOrigem":{"maximum":99,"type":"integer","description":"Código da 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)"},"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":{"/contasPagar/{id}":{"get":{"tags":["Contas a Pagar"],"summary":"Obtem uma Conta a Pagar","operationId":"ObterContaPagar","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código da Conta","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContasPagar"}}}}},"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 /contasPagar/{id} > Alterar uma Conta a Pagar (Não Gera Contabilização) ```json {"openapi":"3.0.1","info":{"title":"Financeiro","version":"1.0"},"tags":[{"name":"Contas a Pagar","description":"ContasPagar"}],"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":{"ContaPagarPut":{"required":["valorDocumento"],"type":"object","properties":{"codLancamento":{"maximum":999999,"type":"integer","description":"Código da Lançamento"},"numDocumento":{"maxLength":50,"type":"string","description":"Número do Documento"},"codFornecedor":{"maximum":999999,"type":"integer","description":"Código do Fornecedor"},"codBanco":{"maximum":999999,"type":"integer","description":"Código do Banco"},"dataEmissao":{"type":"string","description":"Data de Emissão (YYYY-MM-DD)","format":"date"},"dataEntrada":{"type":"string","description":"Data de Entrada (YYYY-MM-DD)","format":"date"},"dataVencimento":{"type":"string","description":"Data de Vencimento (YYYY-MM-DD)","format":"date"},"valorDocumento":{"multipleOf":0.01,"type":"number","description":"Valor do Documento"},"tipoMoeda":{"maximum":999999,"type":"integer","description":"Tipo de Moeda"},"tipoLancamento":{"maxLength":50,"type":"string","description":"Tipo de Lançamento"},"codHistorico":{"maximum":999999,"type":"integer","description":"Código do Histórico (Não obrigatório para tipo B - Baixa de Antecipação)"},"complementoHistorico":{"maxLength":50,"type":"string","description":"Complemento do Histórico"},"valorOriginal":{"multipleOf":0.01,"type":"number","description":"Valor Original"},"categoriaDoc":{"maxLength":50,"type":"string","description":"Categoria do Documento"},"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"}}},"ContasPagar":{"type":"object","properties":{"codLancamento":{"maximum":999999,"type":"integer","description":"Código da Lançamento"},"numDocumento":{"maxLength":50,"type":"string","description":"Número do Documento"},"codFornecedor":{"maximum":999999,"type":"integer","description":"Código do Fornecedor"},"codBanco":{"maximum":999999,"type":"integer","description":"Código do Banco"},"dataEmissao":{"type":"string","description":"Data de Emissão (YYYY-MM-DD)","format":"date"},"dataEntrada":{"type":"string","description":"Data de Entrada (YYYY-MM-DD)","format":"date"},"dataVencimento":{"type":"string","description":"Data de Vencimento (YYYY-MM-DD)","format":"date"},"valorDocumento":{"multipleOf":0.01,"type":"number","description":"Valor do Documento"},"tipoMoeda":{"maximum":999999,"type":"integer","description":"Tipo de Moeda"},"tipoLancamento":{"maxLength":50,"type":"string","description":"Tipo de Lançamento"},"codHistorico":{"maximum":999999,"type":"integer","description":"Código do Histórico (Não obrigatório para tipo B - Baixa de Antecipação)"},"complementoHistorico":{"maxLength":50,"type":"string","description":"Complemento do Histórico"},"valorOriginal":{"multipleOf":0.01,"type":"number","description":"Valor Original"},"valorAtualizado":{"multipleOf":0.01,"type":"number","description":"Valor Atualizado"},"categoriaDoc":{"maxLength":50,"type":"string","description":"Categoria"},"codOrigem":{"maximum":99,"type":"integer","description":"Código da 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)"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/contasPagar/{id}":{"put":{"tags":["Contas a Pagar"],"summary":"Alterar uma Conta a Pagar (Não Gera Contabilização)","operationId":"AlterarContaPagar","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código da Conta a Pagar","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do Conta a Pagar","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContaPagarPut"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContasPagar"}}}},"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 /contasPagar/{id} > Exclui uma Conta a Pagar ```json {"openapi":"3.0.1","info":{"title":"Financeiro","version":"1.0"},"tags":[{"name":"Contas a Pagar","description":"ContasPagar"}],"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":{"/contasPagar/{id}":{"delete":{"tags":["Contas a Pagar"],"summary":"Exclui uma Conta a Pagar","operationId":"ExcluirContaPagar","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código da Conta","required":true,"schema":{"type":"string"}}],"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"}}}}}}}}} ``` --- # 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-pagar.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.