--- title: "Retorna os movimentos do Imoview" method: GET path: "/Movimento/RetornarMovimentos" tags: ["Movimento"] --- # Retorna os movimentos do Imoview `GET /Movimento/RetornarMovimentos` ## Request - Base URL: `https://api.imoview.com.br` - URL: `https://api.imoview.com.br/Movimento/RetornarMovimentos` - Auth: API key in header `chave` Retorno JSON lista de movimentos do imoview ADM ## Query parameters - `numeroPagina` integer, required - `numeroRegistros` integer, required - `codigoCliente` integer - `codigoImovel` integer - `codigoContratoAluguel` integer - `codigoContratoVenda` integer - `dataVencimentoInicial` string, string - `dataVencimentoFinal` string, string - `dataHoraInicialUltimaAlteracao` string, string - `dataHoraFinalUltimaAlteracao` string, string - `situacaoConta` integer - `temBoleto` boolean - `codigoTipoGarantia` integer - `situacao` integer ## Response `200` Retornado com sucesso - object - `quantidade` integer: Total de movimentos encontrados pelo filtro (para paginação), independente da página retornada - `lista` object[]: Movimentos da página solicitada - `codigo` integer: Código do movimento financeiro (conta a receber/pagar) - `codigoauxiliar` string, string: Código auxiliar (identificador externo/legado) do movimento. Vazio quando não informado - `unidadecodigo` integer: Código da unidade (filial) da imobiliária dona do movimento - `unidade` string, string: Nome fantasia da unidade - `modulo` integer: Módulo que gerou o movimento: 2 = ADM (aluguel), 3 = FIN (financeiro), 4 = PÓS-VENDA, 5 = LANÇAMENTO - `situacao` string, string: Situação do cadastro do movimento: Ativo ou Desativado - `tipocliente` string, string: Tipo do envolvido principal: Locatário, Locador, Fornecedor, Cliente, Transferência entre contas, Vendedor, Comprador ou Parceiro - `codigocliente` integer: Código do cliente (pessoa) envolvido principal - `nomecliente` string, string: Nome do cliente envolvido principal - `codigocontratoaluguel` integer: Código do contrato de aluguel de origem; 0 quando não vinculado - `codigocontratovenda` integer: Código do contrato de venda de origem; 0 quando não vinculado - `codigoimovel` integer: Código do imóvel vinculado; 0 quando não vinculado - `numerodocumento` string, string: Número do documento (nosso número/referência) do movimento. Vazio quando não informado - `historico` string, string: Histórico/descrição do movimento (ex.: "Aluguel ref. 09/2026") - `linhadigitavel` string, string: Linha digitável do boleto vinculado ao movimento. Vazio quando não há boleto - `datahorainclusao` string, string: Data no formato dd/MM/yyyy de inclusão do movimento (somente data, apesar do nome) - `datahoraultimaalteracao` string, string: Data no formato dd/MM/yyyy da última alteração do movimento (somente data, apesar do nome) - `datavencimento` string, string: Data no formato dd/MM/yyyy de vencimento - `datapagamento` string, string: Data no formato dd/MM/yyyy do pagamento. Vazio quando em aberto - `saldo` string, string: Valor em texto no formato pt-BR com 2 casas (ex.: 1.234,56). Soma dos lançamentos do envolvido principal (valor da conta) - `temboletoativo` boolean: true quando existe boleto ativo (não cancelado/quitado) para o movimento - `detalhes` object[]: Lançamentos (plano de contas) que compõem o valor do envolvido principal - `codigodetalhe` integer: Código do lançamento (detalhe) do movimento - `codigoplanoconta` integer: Código do plano de contas do lançamento - `nomeplanoconta` string, string: Nome do plano de contas - `codigocontabilplanoconta` string, string: Código contábil do plano de contas (texto livre cadastrado na imobiliária) - `descricao` string, string: Descrição/histórico do lançamento. Vazio quando não informado - `observacao` string, string: Observação do lançamento. Vazio quando não informado - `valor` string, string: Valor em texto no formato pt-BR com 2 casas (ex.: 1.234,56). Valor do lançamento para o envolvido (negativo = dedução/desconto) - `deduzirir` boolean: true quando o lançamento deduz da base do IR do locador (DIMOB/informe) - `centrocustos` object[]: Rateio do lançamento por centro de custos (vazio quando não rateado) - `codigocentrocusto` integer: Código do centro de custos - `nomecentrocusto` string, string: Nome do centro de custos - `valor` string, string: Valor em texto no formato pt-BR com 2 casas (ex.: 1.234,56). Parcela do lançamento atribuída ao centro de custos - `formasquitacao` object[]: Quitações efetivadas do envolvido principal (vazio quando em aberto) - `forma` string, string: Forma de quitação: Boleto, Dinheiro, Cheque, Transf./dep., Débito em conta, Cartão de crédito, Cartão de débito ou Pix - `situacao` string, string: Situação da quitação: Ativo, Quitado, Cancelado ou Moderação (aqui sempre Quitado, só quitações efetivadas são retornadas) - `data` string, string: Data no formato dd/MM/yyyy da quitação. Vazio quando não quitado - `valor` string, string: Valor em texto no formato pt-BR com 2 casas (ex.: 1.234,56). Valor quitado nessa forma - `deduzirir` boolean: true quando a quitação deduz da base do IR - `codigoboleto` integer: Código do boleto quando a forma é Boleto; 0 caso contrário - `codigotransferencia` integer: Código da transferência bancária quando a forma é Transf./dep.; 0 caso contrário - `resumo` string, string: Resumo textual da quitação (forma, conta/banco e data), pronto para exibição - `repasses` object[]: Repasses do movimento aos demais envolvidos (locadores, fornecedores, parceiros). Vazio quando não há repasse - `tipocliente` string, string: Tipo do envolvido do repasse (ver tipocliente do movimento) - `codigocliente` integer: Código do cliente (pessoa) que recebe o repasse - `nomecliente` string, string: Nome do cliente que recebe o repasse - `numerodocumento` string, string: Número do documento do repasse. Vazio quando não informado - `bloqueado` boolean: true quando o repasse está bloqueado (não será pago até liberação manual) - `linhadigitavel` string, string: Linha digitável do boleto do repasse, quando houver. Vazio caso contrário - `datavencimento` string, string: Data no formato dd/MM/yyyy de vencimento do repasse - `datapagamento` string, string: Data no formato dd/MM/yyyy do pagamento do repasse. Vazio quando em aberto - `saldo` string, string: Valor em texto no formato pt-BR com 2 casas (ex.: 1.234,56). Soma dos lançamentos do envolvido do repasse - `detalhes` object[]: Lançamentos que compõem o repasse - `codigodetalhe` integer: Código do lançamento (detalhe) do movimento - `codigoplanoconta` integer: Código do plano de contas do lançamento - `nomeplanoconta` string, string: Nome do plano de contas - `codigocontabilplanoconta` string, string: Código contábil do plano de contas (texto livre cadastrado na imobiliária) - `descricao` string, string: Descrição/histórico do lançamento. Vazio quando não informado - `observacao` string, string: Observação do lançamento. Vazio quando não informado - `valor` string, string: Valor em texto no formato pt-BR com 2 casas (ex.: 1.234,56). Valor do lançamento para o envolvido (negativo = dedução/desconto) - `deduzirir` boolean: true quando o lançamento deduz da base do IR do locador (DIMOB/informe) - `centrocustos` object[]: Rateio do lançamento por centro de custos (vazio quando não rateado) - `codigocentrocusto` integer: Código do centro de custos - `nomecentrocusto` string, string: Nome do centro de custos - `valor` string, string: Valor em texto no formato pt-BR com 2 casas (ex.: 1.234,56). Parcela do lançamento atribuída ao centro de custos - `formasquitacao` object[]: Quitações efetivadas do repasse (vazio quando em aberto) - `forma` string, string: Forma de quitação: Boleto, Dinheiro, Cheque, Transf./dep., Débito em conta, Cartão de crédito, Cartão de débito ou Pix - `situacao` string, string: Situação da quitação: Ativo, Quitado, Cancelado ou Moderação (aqui sempre Quitado, só quitações efetivadas são retornadas) - `data` string, string: Data no formato dd/MM/yyyy da quitação. Vazio quando não quitado - `valor` string, string: Valor em texto no formato pt-BR com 2 casas (ex.: 1.234,56). Valor quitado nessa forma - `deduzirir` boolean: true quando a quitação deduz da base do IR - `codigoboleto` integer: Código do boleto quando a forma é Boleto; 0 caso contrário - `codigotransferencia` integer: Código da transferência bancária quando a forma é Transf./dep.; 0 caso contrário - `resumo` string, string: Resumo textual da quitação (forma, conta/banco e data), pronto para exibição ## Other responses - `401`: Header 'chave' ausente ou inválido, ou chave/usuário sem permissão para a operação - `403`: Regra de negócio violada ou limite de paginação excedido - `404`: Parâmetro obrigatório ausente ou inválido, registro não encontrado ou consulta sem resultado - `429`: Limite de requisições da chave excedido - `500`: Falha interna não prevista ## Changes - **2026-10-09** `d7f65bff1506`: 37 breaking, 5 info - for the `query` request parameter `codigoCliente`, the format changed from `Int64` to `int64` - for the `query` request parameter `codigoContratoAluguel`, the format changed from `Int64` to `int64` - for the `query` request parameter `codigoContratoVenda`, the format changed from `Int64` to `int64` - for the `query` request parameter `codigoImovel`, the format changed from `Int64` to `int64` - …38 more - **2026-10-06** `9e1aab2d1c72`: 2 info - added the new optional `query` request parameter `situacao` - added the optional property `lista/items/situacao` to the response with the `200` status [Operation history](https://skmtc.dev/imoview/apis/imoview-api/changes/Movimento/RetornarMovimentos/get.md) --- [API](https://skmtc.dev/imoview/apis/imoview-api.md) - [All operations](https://skmtc.dev/imoview/apis/imoview-api/llms.txt) - [OpenAPI document](https://skmtc.dev/imoview/apis/imoview-api/revisions/436e609983d0?raw)