API Smart Colliers — Documentação Técnica Consolidada

[fato] Smart Colliers ↔ Sienge: sem integração (confirmado por Robson). [fato] Smart Colliers → Power BI: via porta SQL Server (confirmado por Robson). [fato] Bancos integrados: Itaú, Bradesco, Santander, Safra, BB, Caixa, Sicredi, Sicoob.

Índice

Documentação API(s) - Geral Lista - Colliers (1).pdf
Documentação API(s) - Geral Lista - Colliers.pdf
Documentação da API - Baixa de Boleto.pdf
Documentação da API - Boletos.pdf
Documentação da API - Condôminos Com Endereços e Contatos.pdf
Documentação da API - Consulta de Contratos (1).pdf
Documentação da API - Consulta de Contratos.pdf
Documentação da API - Controle de Fechamento.pdf
Documentação da API - Geração de Ordem de Serviço (1).pdf
Documentação da API - Geração de Ordem de Serviço (2).pdf
Documentação da API - Geração de Ordem de Serviço.pdf
Documentação da API - Lista de Atividade.pdf
Documentação da API - Lista De Documentos.pdf
Documentação da API - Lista de Empreendimentos.pdf
Documentação da API - Lista Geral de Contas - Multa.pdf
Documentação da API - Lista Geral de Contas.pdf
Documentação da API - Mandatos.pdf
Documentação da API - Módulo de Inadimplência (1).pdf
Documentação da API - Módulo de Inadimplência.pdf
Documentação da API - Módulo de Prestação de Contas (Despesa).pdf
Documentação da API - Módulo de Prestação de Contas (Previsão).pdf
Documentação da API - Módulo de Prestação de Contas (Receita).pdf
Documentação da API - Lista Geral de Contas.doc

Conteúdo extraído

Documentação API(s) - Geral Lista - Colliers (1).pdf

Lista de API(s) disponíveis

API de Segunda via de boletos

Descrição: A API Boletos permite obter detalhes sobre boletos a vencer e/ou dentro do limite de pagamento bancário para envio por e-mail.

Método: Método HTTP: POST URL: https://services.livefacilities.com.br/mobile/api/ boleto/boletosDocumento

API de LOGIN

Descrição: A API de Login é necessária para acesso a plataforma e geração de sessão para consulta das demais API(s) do sistema.
https://services.livefacilities.com.br/mobile/api HEADERS Headers utilizados em todas as chamadas. LOGIN {POST} login/loginsistema/

API - /mandatoCompleto Descrição Este endpoint retorna informações detalhadas sobre mandatos vinculados a unidades de um condomínio específico. A API exige que a requisição seja feita em formato XML, com dados de autenticação e identificação do empreendimento e condomínio. Método HTTP • POST URL Base https://services4.livefacilities.com.br/mobile/api/mandato/mandatoCompleto

API - Módulo de Prestação de Contas (Despesa)

Descrição Este método exibira de informações detalhadas sobre despesas associadas ao fechamento em um determinado período, com base em parâmetros específicos, incluindo informações de autenticação, identificação do empreendimento, e configuração de datas.

Método Método HTTP: POST URL: https://services4.livefacilities.com.br/mobile/api/PrestacaoContas/despesas

API - Módulo de Prestação de Contas (Previsão)

Descrição Este método permite obter informações de previsão orçamentária da prestação de contas com base em parâmetros específicos, incluindo informações de autenticação, identificação do empreendimento e configuração de datas.

Método Método HTTP: POST URL: https://services4.livefacilities.com.br/mobile/api/OrdemServico/previsao

API - Módulo de Prestação de Contas (Receita)

Descrição Este método exibira de informações sobre receitas em um determinado período, com base em parâmetros específicos, incluindo informações de autenticação, identificação do empreendimento, e configuração de datas.

Método Método HTTP: POST URL: https://services4.livefacilities.com.br/mobile/api/PrestacaoContas/receitas

API - Módulo de Rateios

Descrição Este método exibira de informações sobre rateios em um determinado período, com base em parâmetros específicos, incluindo informações de autenticação, identificação do empreendimento, e configuração de datas.

Método Método HTTP: POST URL: https://services4.livefacilities.com.br/mobile/api/OrdemServico/receitas

API - Processos do Empreendimento

Descrição Este método permite recuperar informações de processos do empreendimento com base em parâmetros específicos, incluindo informações de autenticação, identificação do empreendimento e configuração de processos.

Método Método HTTP: POST URL: https://services.livefacilities.com.br/mobile/api/OrdemServico/ProcessoEmpreendimento

API de Ocupaç

… (+4,952 chars)

Documentação API(s) - Geral Lista - Colliers.pdf

Lista de API(s) disponíveis

API de Segunda via de boletos

Descrição: A API Boletos permite obter detalhes sobre boletos a vencer e/ou dentro do limite de pagamento bancário para envio por e-mail.

Método: Método HTTP: POST URL: https://services.livefacilities.com.br/mobile/api/ boleto/boletosDocumento

API de LOGIN

API - Módulo de Prestação de Contas (Despesa)

Método Método HTTP: POST URL: https://services4.livefacilities.com.br/mobile/api/PrestacaoContas/despesas

API - Módulo de Prestação de Contas (Previsão)

Método Método HTTP: POST URL: https://services4.livefacilities.com.br/mobile/api/OrdemServico/previsao

API - Módulo de Prestação de Contas (Receita)

Método Método HTTP: POST URL: https://services4.livefacilities.com.br/mobile/api/PrestacaoContas/receitas

API - Módulo de Rateios

Método Método HTTP: POST URL: https://services4.livefacilities.com.br/mobile/api/OrdemServico/receitas

API - Processos do Empreendimento

Método Método HTTP: POST URL: https://services.livefacilities.com.br/mobile/api/OrdemServico/ProcessoEmpreendimento

API de Ocupaç

… (+4,952 chars)

Documentação da API - Baixa de Boleto.pdf

Documentação da API - Processos de baixa e registro de boletos Descrição A seguir, você encontrará a documentação para a API que permite realizar a baixa e registro de boletos, utilizando um identificador de recibo (id_recibo) ou um código de integração (nu_integracao). Esta API é projetada para ser utilizada em sistemas financeiros para automatizar a baixa e registro de pagamentos de boletos. Método Método HTTP: POST URL: https://services4.livefacilities.com.br/mobile/api/Boleto/BaixaBoleto Parâmetros de Solicitação O método BaixaBoleto requer os seguintes parâmetros no corpo da solicitação: infoLogin (objeto): Contém informações de autenticação. nm_sistema (string): Nome do sistema. Solicitar ao responsável junto ao cliente. id_pessoafisica (int): ID da pessoa física, retornado pelo método de LoginSistema. id_sessao (string): ID da sessão, retornado pelo método de LoginSistema. id_chavedispositivo (string): Chave do dispositivo, geralmente definida como “bot”. id_recibo: Identificador único do recibo para baixa. cd_integracao: Código de integração usado para identificar o recibo. dt_registro: Data de registro do boleto. dt_baixa: Data de baixa do boleto. vl_reciboBaixa: Valor do boleto a ser baixado. cd_retornoCnab: Código CNAB para retorno, se aplicável. Exemplo de Corpo da Solicitação <nm_sistema>SIGLA</nm_sistema> <id_pessoafisica>1</id_pessoafisica> <id_sessao>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</id_sessao> <id_chavedispositivo>XXXXXXX</id_chavedispositivo> <id_recibo>123</id_ recibo> <cd_integracao>123</ cd_integracao>

<dt_registro>aaaa-MM-dd</dt_registro> <dt_baixa>aaaa-MM-dd </dt_baixa> <vl_reciboBaixa>0.00<vl_reciboBaixa> <cd_retornoCnab><cd_retornoCnab>

Resposta A resposta a esta solicitação conterá as informações dos recibos do empreendimento recuperados e informações relacionadas. A resposta é fornecida em um formato estruturado, geralmente em JSON, que pode ser processado pelo aplicativo que consome a API. Exemplo de Resposta { “id_erro”: 0, “ds_mensagemErro”: “Boleto Baixado”, }

id_erro: Código de erro (0 para sucesso). ds_mensagemErro: Mensagem de erro, se aplicável.

Códigos de Erro Código do recibo inválido: id_erro: -2, ds_mensagemErro: “Código do recibo inválido.” Data de pagamento inválida: id_erro: -3, ds_mensagemErro: “Data de pagamento inválida” Recibo não encontrado na base de dados: id_erro: 0, ds_mensagemErro: “Recibo não encontrado na base de dados.” Erro desconhecido (exceção): id_erro: -1, ds_mensagemErro: “Descrição do erro”

Suporte Para quaisquer dúvidas ou esclarecimentos, entre em contato com a nossa equipe de suporte: E-mail: suporte.live@suportti.net.br Telefone/WhatsApp: (11) 93091-1035 © LiveFacilities

Documentação da API - Boletos.pdf

DOCUMENTO BÁSICO SOBRE CONSUMO DAS API(s)

URL PADRÃO https://services.livefacilities.com.br/mobile/api

HEADERS Headers utilizados em todas as chamadas. livefacilities-apptoken:
1DF81E17-D766-4701-A16C-82BD6F51E377 Content-Type:

application/xml

LOGIN {POST} login/loginsistema/ __definição dos campos nm_sistema solicitar ao responsável junto ao cliente id_pessoafisica 0 id_sessao 0 id_chavedispositivo bot nm_usuario solicitar ao responsável junto ao cliente nm_senha solicitar ao responsável junto ao cliente

__body exemplo <nm_sistema>COLLIERS</nm_sistema> <id_pessoafisica>0</id_pessoafisica> <id_sessao>0</id_sessao> <id_chavedispositivo>bot</id_chavedispositivo> <nm_usuario></nm_usuario> <nm_senha></nm_senha>

BOLETOS {POST} /boleto/boletosDocumento/ __definição dos campos nm_sistema solicitar ao responsável junto ao cliente id_pessoafisica **retorno do método de login id_sessao **retorno do método de login id_chavedispositivo bot nu_documento CNPJ/CPF sem formatação sn_envioEmail 0 – não envia e-mail 1 – envia email

__body exemplo <nm_sistema>***</nm_sistema> <id_pessoafisica>XXXXXXXXXXXXX</id_pessoafisica> <id_sessao>XXXXXXXXXXXXX</id_sessao> <id_chavedispositivo>bot</id_chavedispositivo> <nu_documento>XXXXXXXXXXXXX</nu_documento> <sn_envioEmail>0</sn_envioEmail>

USUÁRIOS {POST} /proprietario/buscaUsuario/ __definição dos campos nm_sistema solicitar ao responsável junto ao cliente id_pessoafisica **retorno do método de login id_sessao **retorno do método de login id_chavedispositivo bot nu_documento CNPJ/CPF sem formatação nu_telefone Telefone com ddd sem formatação

ORDENS DE SERVIÇOS - PROCESSOS {POST} Retorna os processos configurados para o empreendimento para abertura de OSs.

POST <nm_sistema>DEV</nm_sistema> <id_pessoafisica>1</id_pessoafisica> <id_sessao>ad29dfb1-16f6-47d2-86c3-ccf1a09e160f</id_sessao> <id_chavedispositivo>teste</id_chavedispositivo> <id_empreendimento></id_empreendimento> <sn_publico>1</sn_publico>

ORDENS DE SERVIÇOS – ABERTURA DE ORDEM DE SERVIÇO {POST} Abre ordem de serviço.

id_empreendimento, id_bloco, id_unidade vem do método ProprietáriosInquilinosUnidades id_processo vem do método Processos do ProcessoEmpreendimento dt_ocorrência é a data da abertura nm_atividade deve ser informada (sugestão é ser o nome do pr

… (+1,547 chars)

Documentação da API - Condôminos Com Endereços e Contatos.pdf

Documentação da API: Consulta de Correspondências dos Condôminos

Visão Geral Esta API permite consultar e retornar dados de correspondências dos condôminos, incluindo informações sobre unidades, contatos e endereços. A comunicação é feita via POST para uma URL específica, enviando um corpo XML no formato descrito abaixo.

URL da Requisição https://services4.livefacilities.com.br/mobile/api/Unidade/EtiquetasProtocolosUnidades

Formato da Requisição <nm_sistema>COL</nm_sistema> <id_pessoafisica>XXX</id_pessoafisica> <id_sessao>XXXXXXXXXXXXXXXXXXXXXXXXX</id_sessao> <id_chavedispositivo>bot</id_chavedispositivo> <cd_condominio>0001</cd_condominio> <id_empreendimento></id_empreendimento> Descrição dos Parâmetros de Requisição • <nm_sistema>: Sistema que realiza a consulta (ex.: “ADM”). • <id_pessoafisica>: Identificador da pessoa física responsável. • <id_sessao>: Token de autenticação. • <id_chavedispositivo>: Identificação do dispositivo (ex.: “bot”). • <cd_condominio>: Código do condomínio. • <id_empreendimento>: Identificação opcional do empreendimento.

Exemplo de Retorno { “ds_mensagemErro”: "", “id_erro”: 0, “lsEtiqueta”: [ { “cd_bloco”: “1”, “cd_condominio”: “0001”, “cd_unidade”: “AP 0301”, “ce_endereco”: “22060-002”, “ce_enderecoadministradora”: “24020125”, “ce_enderecoempreendimento”: “24020125”, “dt_nascimento”: “1900-01-01”, “id_unidade”: “1”, “nm_administradora”: “ADMINISTRADORA”, “nm_aoscuidados”: "", “nm_bairro”: “PENHA”, “nm_bairroadministradora”: “CENTRO”, “nm_bairroempreendimento”: “CENTRO”, “nm_bloco”: “BLOCO 1”, “nm_cidade”: “RIO DE JANEIRO”, “nm_cidadeadministradora”: “RIO DE JANEIRO”, “nm_cidadeempreendimento”: “RIO DE JANEIRO”, “nm_contatocelular”: “(99) 9 9999-9999”, “nm_contatocelular2”: "", “nm_contatoemailcomercial”: "", “nm_contatoemailcomercial2”: "", “nm_contatoemailpessoal”: “EMAIL@EMAIL.COM”, “nm_contatoemailpessoal2”: "", “nm_contatotelefonecomercial”: "", “nm_contatotelefoneresidencial”: "", “nm_empreendimento”: “CONDOMÍNIO TESTE”, “nm_endereco”: “NOSSA SENHORA TESTE”, “nm_enderecoadministradora”: “ENDEREÇO ONZE”, “nm_enderecoempreendimento”: “ENDEREÇO DOZE”, “nm_grupousuario”: “PROPRIETÁRIO / OWNER”, “nm_logradouro”: “AVENIDA”, “nm_logradouroadministradora”: “RUA”, “nm_logradouroempreendimento”: “RUA”, “nm_pessoafisica”: “NOME DO CONDÔMINO”, “nu_endereco”: “999”, “nu_enderecoadministradora”: “4”,

… (+4,858 chars)

Documentação da API - Consulta de Contratos (1).pdf

Documentação da API – Consulta de Contratos Descrição A API “Consulta de Contratos” permite a obtenção de informações detalhadas sobre os contratos dos empreendimentos. Método Método HTTP: POST URL: https://services4.livefacilities.com.br/mobile/api/contrato/ContratoCompleto

Parâmetros de Solicitação O método ContratoCompleto requer os seguintes parâmetros no corpo da solicitação: infoLogin (objeto): Contém informações de autenticação. nm_sistema (string): Nome do sistema. Solicitar ao responsável junto ao cliente. id_pessoafisica (int): ID da pessoa física, retornado pelo método de LoginSistema. id_sessao (string): ID da sessão, retornado pelo método de LoginSistema. id_chavedispositivo (string): Chave do dispositivo, geralmente definida como “bot”. Id_empreendimento (string): ID do condomínio cd_condominio (string): Código do condomínio. dt_inicio (string): Data de início da vigência do contrato (formato: “AAAA-MM-DD”). dt_termino (string): Data fim da vigência do contrato (formato: “AAAA-MM-DD”).

Exemplo de Corpo da Solicitação { “infoLogin”: { “nm_sistema”: “COL”, “id_pessoafisica”: “1”, “id_sessao”: “XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX”, “id_chavedispositivo”: “XXXXXXXXXXXXX” }, <id_empreendimento></id_empreendimento> <cd_condominio>0042</cd_condominio> <dt_inicio>2000-01-01</dt_inicio>

<dt_termino>2024-07-08</dt_termino> }

Resposta A resposta da API “Consulta de Contratos” fornece detalhes sobre os contratos cadastrados nos empreendimentos.

Exemplo de Resposta { “dt_inicio”: “DATA DE INÍCIO DA VIGÊNCIA DO CONTRATO 01/01/2013”, “dt_termino”: “DATE DE TÉRMINO DA VIGÊNCIA DO CONTRATO 01/01/2018”, “dt_ultvencfinanc”: ”Data do último vencimento financeiro cadastrado”, “id_contrato”: “Número de identificação interna do contrato”, “id_pai”: “Número do contrato pai utilizado quando for aditivo”, “lsLogContratos”: [Log geral com as informações relacionadas a inclusão e alterações dos contratos]

“dt_conteudolog”: “Data da ação 08/09/2023 11:26:20”, “nm_usuarioLog”: “Nome do usuário responsável pela ação”, “tx_mensagemlog”: “Texto com um resumo da ação executada”, “nm_classificacao”: “NOME DA CLASSIFICAÇÃO DO CONTRATO”, “nm_contratado”: “NOME DO CONTRATADO”, “nm_contratante”: “NOME DO CONTRATANTE”, “nm_empreendimento”: “NOME DO EMPREENDIMENTO”, “nm_status”: “NOME DO STATUS DO CONTRATO”, “nm_tipocontrato”: “TIPO DE CONTRATO”, “nu_contrato”: “NÚMERO DE IDENTIFICAÇÃO DO CONTRATO”, “tipoClassificacao”: “TIPO DE CLASSIFICAÇÃO”, “tx_objeto”: “TEXTO DO OBJETO DO CONTRATO”

Códigos de Erro -1: Parâmetro de entrada não preenchido. -2: Usuário não permitido. -3: Empreendimento não preenchido. -4: Data início de deic

… (+263 chars)

Documentação da API - Consulta de Contratos.pdf

<dt_termino>2024-07-08</dt_termino> }

Resposta A resposta da API “Consulta de Contratos” fornece detalhes sobre os contratos cadastrados nos empreendimentos.

Códigos de Erro -1: Parâmetro de entrada não preenchido. -2: Usuário não permitido. -3: Empreendimento não preenchido. -4: Data início de deic

… (+263 chars)

Documentação da API - Controle de Fechamento.pdf

Documentação da API – Controle de Fechamento

Descrição A seguir está a documentação da API para o controle de fechamento de empreendimentos. Essa API permite que os usuários obtenham detalhes sobre fechamentos de empreendimentos, incluindo registros detalhados de logs de fechamento. Método Método HTTP: POST URL: https://services4.livefacilities.com.br/mobile/api/ControleFechamento/Empreendimento Parâmetros de Solicitação O método Empreendimento requer os seguintes parâmetros no corpo da solicitação: infoLogin (objeto): Contém informações de autenticação. nm_sistema (string): Nome do sistema. Solicitar ao responsável junto ao cliente. id_pessoafisica (int): ID da pessoa física, retornado pelo método de LoginSistema. id_sessao (string): ID da sessão, retornado pelo método de LoginSistema. id_chavedispositivo (string): Chave do dispositivo, geralmente definida como “bot”. cd_condominio: O código do condomínio. id_empreendimento: O ID do empreendimento no sistema. dt_inicio: A data de início do período. dt_fim: A data de fim do período.

Exemplo de Corpo da Solicitação <nm_sistema>COL</nm_sistema> <id_pessoafisica>1</id_pessoafisica> <id_sessao>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</id_sessao> <id_chavedispositivo>XXXXXXX</id_chavedispositivo> <cd_condominio>123</cd_condominio>

<id_empreendimento>123</id_empreendimento> <dt_inicio>aaaa-MM-dd</dt_inicio> <dt_fim>aaaa-MM-dd</dt_fim>

Exemplo de Resposta { “ControleFechamento”: [ { “Log”: [ { “dt_log”: “aaaa/MM/dd HH:mm”, “nm_usuario”: “Nome do usuário que alterou”, “tx_historico”: “Histórico do log” } ], “dt_fim”: “aaaa/MM/dd”, “dt_inicio”: “aaaa/MM/dd”, “nm_centrocusto”: “Nome do centro de custo”, “nm_statusfechamento”: “Nome do status do fechamento”, “sn_fechado”: “Sim ou Não”, “sn_revistagerada”: “Sim ou Não”, “tx_observacao”: “Observação do controle de fechamento” } ], “ds_mensagemErro”: "", “id_erro”: 0 }

id_erro: Código de erro (0 para sucesso). ds_mensagemErro: Mensagem de erro, se aplicável.

Códigos de Erro Empreendimento não encontrado: id_erro: -1, ds_mensagemErro: ” Empreendimento não encontrado” Data início ou fim inválida: id_erro: -1, ds_mensagemErro: “Data inicio do período não preenchido” ou “Data fim do período não preenchido” Período inconsistente: id_erro: -1, ds_mensagemErro: “Data inicio do período não pode ser maior que a data fim do período” Nenhum resultado encontrado: id_erro: -1, ds_mensagemErro: “Nenhum resultado Encontrado”

Suporte Para quaisquer dúvidas ou esclarecimentos, entre em contato com a nossa equipe de suporte: E-mail: suporte.live@suportti.net.br Telefone/Wha

… (+42 chars)

Documentação da API - Geração de Ordem de Serviço (1).pdf

Documentação da API - Geração de Ordem de Serviço Descrição Este método permite gerar uma atividade da ordem de serviço com base em parâmetros específicos, incluindo informações de autenticação, empreendimento, processo, tipo de atividade e detalhes da atividade. Método Método HTTP: POST URL: https://services.livefacilities.com.br/mobile/api/OrdemServico/GeraAtividade Parâmetros de Solicitação O método GeraAtividade requer os seguintes parâmetros no corpo da solicitação: infoLogin (objeto): Contém informações de autenticação. nm_sistema (string): Nome do sistema. Solicitar ao responsável junto ao cliente. id_pessoafisica (int): ID da pessoa física, retornado pelo método de LoginSistema. id_sessao (string): ID da sessão, retornado pelo método de LoginSistema. id_chavedispositivo (string): Chave do dispositivo, geralmente definida como “bot”. id_empreendimento (string): ID do empreendimento onde a atividade será gerada. id_processo (string): ID do processo relacionado à atividade. dt_ocorrencia (string): Data da ocorrência da atividade no formato “DD-MM-YYYY HH:MM:SS”. nm_atividade (string): Nome da atividade a ser criada. ds_atividade (string): Descrição da atividade. idSolicitante (string): ID do solicitante. idAtividadeTipo (string): ID do tipo de atividade (1-Preventiva/2-Corretiva). id_item (string): ID do item relacionado à localidade (opcional). id_Localidade (string): ID da localidade (opcional). sn_responsavel (bool): Indicador de responsável (true/false) (opcional). nm_imagem (array): Lista de imagens em formato Base64 relacionadas à atividade(opcional). snSomenteRegistro (bool): Indicador de atividade de somente registro (true/false) (opcional). txShortURL (string): URL curta relacionada à atividade(opcional). id_processoParametroTipo (string): Tipo de parâmetro do processo (opcional). cd_atividade (string): Código da atividade (opcional). id_processo_servico (string): ID do serviço do processo (opcional). idConta (string): ID da conta (Centro de Custo) (opcional). idBloco (string): ID do bloco (opcional). idUnidade (string): ID da unidade (opcional). nuLacre (string): Número do lacre (opcional).

nmSolicitante (string): Nome do solicitante (opcional). nmNo (string): Nome do No (opcional). cdRastreamento (string): Código de rastreamento do correios (opcional). idMensageriaTipo (string): ID do tipo de mensageria (1-Carta Simples/2-Sedex/3-Caixa/5-Sacola/
6-Outros) (opcional). idPrioridade (string): ID da prioridade (1-Baixa/2-Média/3-Alta)(opcional). id_projeto (int): ID do projeto (opcional). Exemplo de Corpo da Solicitação <nm_sistema>colliers</nm_sistema> <id_pessoafisica>2</id_pessoafisica> <id_sessao>XXXXXXXX-XXXX-XXXX-XXXXX-XXXXXXXX</id_sessao> <id_chavedispositivo>XXXXX</id_chavedispositivo> <id_empreendimento>123</id_empreendimento> <id_processo>123</id_processo> <dt_ocorrencia>dd/mm/yy

… (+1,014 chars)

Documentação da API - Geração de Ordem de Serviço (2).pdf

… (+1,014 chars)

Documentação da API - Geração de Ordem de Serviço.pdf

… (+1,014 chars)

Documentação da API - Lista de Atividade.pdf

Documentação da API – Lista de Ordens Serviço Descrição Esta API permite a listagem de ordens de serviço relacionadas a um determinado empreendimento. Os dados são filtrados com base no empreendimento e período especificado. Método Método HTTP: POST URL: https://services4.livefacilities.com.br/mobile/api/OrdemServico/ListaAtividade Parâmetros de Solicitação A requisição ListaAtividade deve conter um objeto JSON com as seguintes propriedades: infoLogin (objeto): Contém informações de autenticação. nm_sistema (string): Nome do sistema. Solicitar ao responsável junto ao cliente. id_pessoafisica (int): ID da pessoa física, retornado pelo método de LoginSistema. id_sessao (string): ID da sessão, retornado pelo método de LoginSistema. id_chavedispositivo (string): Chave do dispositivo, geralmente definida como “bot”. cd_condominio (string): Código do condomínio. dt_inicio (string): Data de início do filtro da ocorrência (formato: “AAAA-MM-DD”). dt_fim (string): Data de fim do filtro da ocorrência (formato: “AAAA-MM-DD”).

Exemplo de Corpo da Solicitação { “infoLogin”: { “nm_sistema”: “COL”, “id_pessoafisica”: “1”, “id_sessao”: “XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX”, “id_chavedispositivo”: “XXXXXXXXXXXXX” }, “cd_condominio”: “1”, “dt_inicio”: “AAAA-MM-DD”, “dt_fim”: “AAAA-MM-DD” }

Resposta A resposta da API “Lista Atividade” fornece detalhes sobre as ordens de serviços disponíveis no período da requisição.
Exemplo de Resposta { “ds_mensagemErro”: "", “id_erro”: 0, “lsAtividade”: [ { “nm_administradora”: “Nome Administradora”,
“cd_condominio”: “Código Empreendimento”, “nm_empreendimento”: “Nome Empreendimento”, “nm_bloco”: “Nome Bloco”, “cd_unidade”: “Código Unidade”, “nm_executante”: “Nome do Executante”, “ds_atividade”: “Descrição da Atividade”, “dt_conclusao”: “dd/mm/aaaa hh:mm:ss”, “dt_fechamento”: “dd/mm/aaaa hh:mm:ss”, “dt_fimocorrencia”: “dd/mm/aaaa hh:mm:ss”, “dt_ocorrencia”: “dd/mm/aaaa hh:mm:ss”, “nm_gerente”: “Nome do Gerente”, “nm_responsavel”: “Nome do Responsável”, “nm_statusatividade”: “Status da Atividade”, “tx_processocaminho”: “Processo e Sub Processo da Atividade”, “tx_statusatividade”: “Texto do Andamento da Atividade” } ] }

id_erro: Código de erro (0 para sucesso). ds_mensagemErro: Mensagem de erro, vazia em caso de sucesso. listaAtividade: Lista de Atividade, contendo as seguintes informações: nm_administradora: Nome da administradora (tipo String). cd_condominio: Código do condomínio (tipo String). nm_empreendimento: Nome do empreendimento (tipo String). nm_bloco: Nome do bloco (tipo String). cd_unidade: Código da unidade (tipo String). nm_gerente: Nome do gerente (tipo String). tx_processocaminho: Caminho do processo (tipo String). nm_executante: Nome do executante (tipo String). nm_responsavel: Nome do responsável

… (+969 chars)

Documentação da API - Lista De Documentos.pdf

Documentação da API – Consulta de Documentos Descrição A API “Consulta de Documentos” permite a obtenção de informações detalhadas sobre a documentação dos empreendimentos, inclusive os LOG´s. Método Método HTTP: POST URL: https://services4.livefacilities.com.br/mobile/api/documento/DocumentoCompleto Parâmetros de Solicitação O método DocumentoCompleto requer os seguintes parâmetros no corpo da solicitação: infoLogin (objeto): Contém informações de autenticação. nm_sistema (string): Nome do sistema. Solicitar ao responsável junto ao cliente. id_pessoafisica (int): ID da pessoa física, retornado pelo método de LoginSistema. id_sessao (string): ID da sessão, retornado pelo método de LoginSistema. id_chavedispositivo (string): Chave do dispositivo, geralmente definida como “bot”. Id_empreendimento (string): ID do condomínio cd_condominio (string): Código do condomínio. dt_inicioveiculacao (string): Data de início da veiculação do documento (formato: “AAAA-MM-DD”). dt_fimveiculacao (string): Data fim da veiculação do documento (formato: “AAAA-MM-DD”).

Exemplo de Corpo da Solicitação { “infoLogin”: { “nm_sistema”: “COL”, “id_pessoafisica”: “1”, “id_sessao”: “XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX”, “id_chavedispositivo”: “XXXXXXXXXXXXX” }, <id_empreendimento></id_empreendimento> <cd_condominio>42</cd_condominio> <dt_inicioveiculacao>2000-01-01</dt_inicioveiculacao> <dt_fimveiculacao>2024-07-01</dt_fimveiculacao> }

Resposta A resposta da API “Lista de Documentos” fornece detalhes sobre o cadastro do documentos e seus respectivos logs.
Exemplo de Resposta { “ds_mensagemErro”: "",
“id_erro”: 0, “lsDocumento”: [ { “dt_criacao”: “01/09/2023 09:09:00”, “dt_fimveiculacao”: “01/09/2023 23:59:00”, “dt_inicioveiculacao”: “01/09/2023”, “dt_validade”: null, “id_conteudo”: “11352”, “lsLogDocumentos”: [ { “dt_conteudolog”: “01/09/2023 09:08:59”, “nm_usuarioLog”: “Nome do Usuário”, “tx_mensagemlog”: “Criou o conteúdo” }, { “dt_conteudolog”: “01/09/2023 09:09:00”, “nm_usuarioLog”: “Nome do Usuário”, “tx_mensagemlog”: “Anexou o arquivo: ‘0000011352-202309010904190582241.pdf’” }, { “dt_conteudolog”: “01/09/2023 09:09:00”, “nm_usuarioLog”: “Nome do Usuário”, “tx_mensagemlog”: “Vinculou o bloco ‘A’” }, { “dt_conteudolog”: “01/09/2023 09:09:00”, “nm_usuarioLog”: “Nome do Usuário”, “tx_mensagemlog”: “Vinculou o(s) bloco(s):
<span

A” }

… (+1,854 chars)

Documentação da API - Lista de Empreendimentos.pdf

Documentação da API – Lista de Empreendimentos Descrição A API “Lista de Empreendimentos” permite a obtenção de informações detalhadas sobre os empreendimentos da carteira do usuário com seus respectivos status e outras informações. Método Método HTTP: POST URL: https://services4.livefacilities.com.br/mobile/api/Empreendimento/EmpreendimentoLista Parâmetros de Solicitação O método EmpreendimentoLista requer os seguintes parâmetros no corpo da solicitação: infoLogin (objeto): Contém informações de autenticação. nm_sistema (string): Nome do sistema. Solicitar ao responsável junto ao cliente. id_pessoafisica (int): ID da pessoa física, retornado pelo método de LoginSistema. id_sessao (string): ID da sessão, retornado pelo método de LoginSistema. id_chavedispositivo (string): Chave do dispositivo, geralmente definida como “bot”. id_empreendimento: ID do condomínio.

Exemplo de Corpo da Solicitação { “infoLogin”: { “nm_sistema”: “COL”, “id_pessoafisica”: “1”, “id_sessao”: “XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX”, “id_chavedispositivo”: “XXXXXXXXXXXXX” }, “id_empreendimento”: “0”, }

Resposta A resposta da API “Lista de Empreendimentos” fornece detalhes sobre os empreendimentos da carteira do usuário.
Exemplo de Resposta { “ds_mensagemErro”: "", “id_erro”: 0, “listaMulta”: [ { “cd_condominio”: “9999”, “centrocusto”: [], “cn_empreendimento”: "", “id_empreendimento”: “9”, “nm_administradora”: “Nome da Administradora”, “nm_empreendimento”: “Nome do Empreendimento”, “nm_gerente”: “Gerente do Empreendimento”, “nm_gerentegeral”: “Gerente Geral do Empreendimento”, “nm_statusempreendimento”: “Status do Empreendimento”, “sn_ativo”: “Sim ou Não” } ] }

id_erro: Código de erro (0 para sucesso).

ds_mensagemErro: Mensagem de erro, vazia em caso de sucesso.

cd_condominio: Código do empreendimento.

centrocusto: Centros de custos disponíveis para o empreendimento.

cn_empreendimento: CNPJ do empreendimento.

id_empreendimento: Identificador do empreendimento.

nm_empreendimento: Nome do empreendimento.

nm_gerente: Nome do gerente do empreendimento.

nm_gerentegeral: Nome do gerente geral do empreendimento.

nm_statusempreendimento: Nome do status do empreendimento.

sn_ativo: Situação do empreendimento.

Códigos de Erro -1: Parâmetro de entrada não preenchido. -2: Usuário não permitido.

Suporte Para quaisquer dúvidas ou esclarecimentos, entre em contato com a nossa equipe de suporte: E-mail: suporte.live@suportti.net.br Telefone/WhatsApp: (11) 93091-1035 © LiveFacilities

Documentação da API - Lista Geral de Contas - Multa.pdf

Documentação da API – Lista Geral de Contas - Multa Descrição A API “Lista Geral de Contas - Multas” permite a obtenção de informações detalhadas sobre multas associadas aos pagamentos dentro de um determinado período e empreendimento. Abaixo estão detalhadas as chamadas aceitas pela API e a estrutura da resposta. Método Método HTTP: POST URL: https://services4.livefacilities.com.br/mobile/api/ContasPagar/ConsultaMulta Parâmetros de Solicitação O método ConsultaMulta requer os seguintes parâmetros no corpo da solicitação: infoLogin (objeto): Contém informações de autenticação. nm_sistema (string): Nome do sistema. Solicitar ao responsável junto ao cliente. id_pessoafisica (int): ID da pessoa física, retornado pelo método de LoginSistema. id_sessao (string): ID da sessão, retornado pelo método de LoginSistema. id_chavedispositivo (string): Chave do dispositivo, geralmente definida como “bot”. cd_condominio (string): Código do condomínio. dt_baixainicio (string): Data de início do período do vencimento (formato: “AAAA-MM-DD”). dt_baixafim (string): Data de fim do período do vencimento (formato: “AAAA-MM-DD”).

Exemplo de Corpo da Solicitação { “infoLogin”: { “nm_sistema”: “COL”, “id_pessoafisica”: “1”, “id_sessao”: “XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX”, “id_chavedispositivo”: “XXXXXXXXXXXXX” }, “cd_condominio”: “1”, “dt_baixainicio”: “AAAA-MM-DD”, “dt_baixafim”: “AAAA-MM-DD” }

Resposta A resposta da API “Lista Geral de Contas - Multa” fornece detalhes sobre as multas de acordo com a chamada realizada.
Exemplo de Resposta { “ds_mensagemErro”: "", “id_erro”: 0, “listaMulta”: [ { “ds_multa”: “Descrição da Multa”, “dt_pagamentoparcelaagenda”: “DD/MM/AAAA”, “dt_vencimento”: “DD/MM/AAAA”, “id_empreendimento”: “1”, “id_gerente”: “1”, “id_pagamento”: “1”, “id_responsavel”: “1”, “nm_gerente”: “Nome do Gerente”, “nm_pagamentoparcelamultatipo”: “Tipo de Pagamento”, “nm_responsavel”: “Nome do Responsável”, “nu_protocoloDigitalizado”: "", “tx_empreendimento”: “1 – Nome do Empreendimento”, “tx_historico”: “Histórico da Multa”, “vl_documentototal”: “0,00”, “vl_pagamentooutrosvalores”: “0,00”, “vl_pagamentoparcelamulta”: “0,00” } ] }

id_erro: Código de erro (0 para sucesso). ds_mensagemErro: Mensagem de erro, vazia em caso de sucesso. listaMulta: Lista de informações detalhadas sobre as multas associadas a pagamentos. ds_multa: Descrição da multa. dt_pagamentoparcelaagenda: Data agendada para pagamento da parcela da multa. dt_vencimento: Data de vencimento da multa. id_empreendimento: Identificador do empreendimento. id_gerente: Identificador do gerente associado ao pagamento. id_pagamento: Identificador do pagamento. id_responsavel: I

… (+1,023 chars)

Documentação da API - Lista Geral de Contas.pdf

Documentação da API – Lista Geral de Contas Descrição A API “Lista Geral de Contas” permite obter informações sobre contas a pagar em um determinado período e empreendimento. Abaixo, estão detalhadas as chamadas aceitas pela API e a estrutura da resposta. Método Método HTTP: POST URL: https://services4.livefacilities.com.br/mobile/api/ContasPagar/ConsultaPagamento Parâmetros de Solicitação O método ConsultaPagamento requer os seguintes parâmetros no corpo da solicitação: infoLogin (objeto): Contém informações de autenticação. nm_sistema (string): Nome do sistema. Solicitar ao responsável junto ao cliente. id_pessoafisica (int): ID da pessoa física, retornado pelo método de LoginSistema. id_sessao (string): ID da sessão, retornado pelo método de LoginSistema. id_chavedispositivo (string): Chave do dispositivo, geralmente definida como “bot”. cd_condominio (string): Código do condomínio. dt_vencimentoinicio (string): Data de início do período do vencimento (formato: “AAAA-MM-DD”). dt_vencimentofim (string): Data de fim do período do vencimento (formato: “AAAA-MM-DD”).

Exemplo de Corpo da Solicitação { “infoLogin”: { “nm_sistema”: “COL”, “id_pessoafisica”: “1”, “id_sessao”: “XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX”, “id_chavedispositivo”: “XXXXXXXXXXXXX” }, “cd_condominio”: “1”, “dt_vencimentoinicio”: “AAAA-MM-DD”, “dt_vencimentofim”: “AAAA-MM-DD” }

Resposta A resposta da API “Lista Geral de Contas” fornece detalhes sobre as contas a pagar de acordo com a chamada realizada.
Exemplo de Resposta { “ds_mensagemErro”: "", “id_erro”: 0, “listaContasPagar”: [ { “cd_contacontabil”: “1 – Nome da Conta Contábil”, “cd_empreendimento”: “0010 – Nome do Empreendimento”, “cd_pagamento”: “1”, “ds_competencia”: “MM/AAAA”, “dt_documentoemissao”: “DD/MM/AAAA”, “dt_pagamentoparcelaagenda”: “DD/MM/AAAA”, “dt_pagamentoparcelabaixado”: “DD/MM/AAAA”, “dt_pagamentoparcelacadastro”: “DD/MM/AAAA HH:MM:SS”, “dt_vencimento”: “DD/MM/AAAA”, “nm_centrocusto”: “Nome do Centro de Custo”, “nm_contacompleto”: “Nome da Conta”, “nm_documentotipo”: “Tipo do Documento”, “nm_fornecedor”: “Nome do Fornecedor”, “nm_gerente”: “Nome do Gerente”, “nm_pagamentoclassificacao”: “Classificação do Pagamento”, “nm_pagamentoclassificacaoanteriorexibe”: "", “nm_pagamentoparcelastatus”: “Status da Parcela”, “nm_pagamentoparcelatipo”: “Tipo do Pagamento”, “nm_solicitante”: “Nome do Solicitante”, “nu_chequefolha”: "", “nu_documento”: “1”, “nu_fornecedordocumento”: “CPF/CNPJ Fornecedor”, “nu_parcela”: “1”, “nu_protocoloDigitalizado”: "", “tx_historico”: "", “vl_bruto”: “0,00”, “vl_documentototal”: “0,00”, “vl_impostopagar”: “0,00”, “vl_liquido”: “0,00” } ] }

id_erro: Código de erro (0 para sucesso). ds_mensag

… (+2,012 chars)

Documentação da API - Mandatos.pdf

Documentação da API - /mandatoCompleto

Descrição Este endpoint retorna informações detalhadas sobre mandatos vinculados a unidades de um condomínio específico. A API exige que a requisição seja feita em formato XML, com dados de autenticação e identificação do empreendimento e condomínio.

Método HTTP • POST

URL Base https://services4.livefacilities.com.br/mobile/api/mandato/mandatoCompleto

Cabeçalhos Requeridos { “Content-Type”: “application/xml” }

Corpo da Requisição (XML)
COL XX XX XX XXXX XXXX Descrição dos Campos Campo Tipo Obrigatório Descrição nm_sistema String Sim Nome do sistema (ex.: HML). id_pessoafisica Int Sim ID do usuário autenticado. id_sessao UUID Sim Identificador único da sessão ativa. id_chavedispositivo String Sim Chave única do dispositivo solicitante. id_empreendimento String Não ID do empreendimento (opcional). cd_condominio String Sim Código do condomínio alvo.
Exemplo de Requisição (cURL) curl -X POST https://services4.livefacilities.com.br/mobile/api/mandato/mandatoCompleto \ -H “Content-Type: application/xml” \ -d ’ <nm_sistema>COL</nm_sistema> <id_pessoafisica>XXX</id_pessoafisica> <id_sessao>XXX</id_sessao> <id_chavedispositivo>XXX</id_chavedispositivo> <id_empreendimento>XXXX</id_empreendimento> <cd_condominio>XXXX</cd_condominio> ’

Resposta de Sucesso { “ds_mensagemErro”: "", “id_erro”: 0, “lsMandato”: [

{ "cd_unidade": "000011", "dt_fimmandato": "31/12/2024", "dt_iniciomandato": "01/01/2024", "nm_bloco": "RESIDENCIAL", "nm_empreendimento": "COND. MANSÃO DUARTE´S", "nm_grupousuario": "SUB-SÍNDICO", "nm_usuario": "NOME DO USUÁRIO", "sn_ativo": "True" }, { "cd_unidade": "VG001", "dt_fimmandato": "31/12/2024", "dt_iniciomandato": "01/01/2024", "nm_bloco": "RESIDENCIAL", "nm_empreendimento": "COND. MANSÃO DUARTE´S", "nm_grupousuario": "SÍNDICO / SYNDIC", "nm_usuario": "NOME DO USUÁRIO", "nm_tipoisencao": "Isenção da cota percentual", "sn_ativo": "True" } ]

} Descrição dos Campos de Resposta Campo Tipo Descrição cd_unidade String Código da unidade. dt_fimmandato String Data de término do mandato. dt_iniciomandato String Data de início do mandato. nm_bloco String Nome do bloco associado à unidade. nm_empreendimento String Nome do empreendimento. nm_grupousuario String Gr

… (+1,066 chars)

Documentação da API - Módulo de Inadimplência (1).pdf

Des A API espec Mét Méto URL: h Par O mét infoLo nm_s id_pe id_ses id_ch id_em id_blo id_un dt_ini dt_fin Exem <paco <

<

<i < < < Docum scrição I Devedor De cíficos, como todo do HTTP: POS https://servi âmetros todo Devedor ogin (objeto): istema (string essoafisica (int ssao (string): avedispositiv mpreendimen oco (int): Iden nidade (int): Id icioperiodo (s nalperiodo (st mplo de C ote> <infoLogin <nm_si <id_pe <id_se <id_ch </infoLogin id_empreen <id_bloco> <id_unidad <dt_iniciop mentaç etalhado per o empreendi ST ices4.livefaci s de Solic rDetalhado re : Contém info g): Nome do s t): ID da pesso ID da sessão, vo (string): Ch nto (int): Ident ntificador do b dentificador d string): Data d tring): Data de Corpo da S

stema>SIGLA ssoafisica ssao>XXXXX avedisposi n> dimento>10 0</id_bloc e>0</id_un periodo>01 ção da rmite obter d mento, perío ilities.com.br citação quer os segui rmações de a sistema. Solici oa física, reto retornado pe ave do dispos tificador do em bloco (opciona da unidade (op de início do pe e fim do perío Solicitação A</nm_sist

1</id_pes XXX-XXXX-X tivo>XXXXX </id_empre o> idade> -11-2023</

API – D detalhes sob odo e outros r/mobile/ap ntes parâmet utenticação. itar ao respon rnado pelo m elo método de sitivo, geralme mpreendimen al). pcional). eríodo desejad odo desejado o ema> soafisica> XXX-XXXX-X XX</id_cha endimento> dt_iniciop Devedo re devedore s filtros relev i/ Devedor/D tros no corpo nsável junto ao étodo de Log e LoginSistem ente definida nto. do (formato: d (formato: dd-

XXXXXXXXXX vedisposit

eriodo>

or Deta s com base e vantes.
DevedorDeta da solicitação o cliente. inSistema. a. como “bot”. dd-mm-yyyy) -mm-yyyy). XX</id_sess ivo> alhado em parâmetr alhado o: . ao> ros

<dt_finalperiodo>30-01-2024</dt_finalperiodo>

Resposta A resposta a esta solicitação conterá as informações dos devedores e informações relacionadas. A resposta é fornecida em um formato estruturado, geralmente em JSON, que pode ser processado pelo aplicativo que consome a API. Exemplo de Resposta { “ds_mensagemErro”: "", “id_erro”: 0, “infoDevedor”: [ { “cd_unidade”: “000001”, “dt_vencimento”: “dd/mm/aaaa”, “id_empreendimento”: “0”, “id_pagador”: “0”, “id_pessoafisica”: “0”, “id_recibo”: “0”, “nm_bloco”: “Nome do Galpão”, “nm_pagador”: “Nome do Pagador”, “nm_pessoafisica”: “Nome do Devedor”, “tx_historico”: “Histórico do Recibo”, “vl_correcao”: “0,00”, “vl_juros”: “0,00”, “vl_multa”: “0,00”, “vl_recibodetalhe”: “0,00”, “vl_recibototal”: “0,00” }
] }

id_erro: Código de erro (0 para sucesso). ds_mensagemErro (String): Mensagem de erro, se aplicável. id_empreendimento (String): Identificador único d

… (+1,732 chars)

Documentação da API - Módulo de Inadimplência.pdf

Des A API espec Mét Méto URL: h Par O mét infoLo nm_s id_pe id_ses id_ch id_em id_blo id_un dt_ini dt_fin Exem <paco <

<

<i < < < Docum scrição I Devedor De cíficos, como todo do HTTP: POS https://servi âmetros todo Devedor ogin (objeto): istema (string essoafisica (int ssao (string): avedispositiv mpreendimen oco (int): Iden nidade (int): Id icioperiodo (s nalperiodo (st mplo de C ote> <infoLogin <nm_si <id_pe <id_se <id_ch </infoLogin id_empreen <id_bloco> <id_unidad <dt_iniciop mentaç etalhado per o empreendi ST ices4.livefaci s de Solic rDetalhado re : Contém info g): Nome do s t): ID da pesso ID da sessão, vo (string): Ch nto (int): Ident ntificador do b dentificador d string): Data d tring): Data de Corpo da S

stema>SIGLA ssoafisica ssao>XXXXX avedisposi n> dimento>10 0</id_bloc e>0</id_un periodo>01 ção da rmite obter d mento, perío ilities.com.br citação quer os segui rmações de a sistema. Solici oa física, reto retornado pe ave do dispos tificador do em bloco (opciona da unidade (op de início do pe e fim do perío Solicitação A</nm_sist

1</id_pes XXX-XXXX-X tivo>XXXXX </id_empre o> idade> -11-2023</

API – D detalhes sob odo e outros r/mobile/ap ntes parâmet utenticação. itar ao respon rnado pelo m elo método de sitivo, geralme mpreendimen al). pcional). eríodo desejad odo desejado o ema> soafisica> XXX-XXXX-X XX</id_cha endimento> dt_iniciop Devedo re devedore s filtros relev i/ Devedor/D tros no corpo nsável junto ao étodo de Log e LoginSistem ente definida nto. do (formato: d (formato: dd-

XXXXXXXXXX vedisposit

eriodo>

or Deta s com base e vantes.
DevedorDeta da solicitação o cliente. inSistema. a. como “bot”. dd-mm-yyyy) -mm-yyyy). XX</id_sess ivo> alhado em parâmetr alhado o: . ao> ros

<dt_finalperiodo>30-01-2024</dt_finalperiodo>

Resposta A resposta a esta solicitação conterá as informações dos devedores e informações relacionadas. A resposta é fornecida em um formato estruturado, geralmente em JSON, que pode ser processado pelo aplicativo que consome a API. Exemplo de Resposta { “ds_mensagemErro”: "", “id_erro”: 0, “infoDevedor”: [ { “cd_unidade”: “000001”, “dt_vencimento”: “dd/mm/aaaa”, “id_empreendimento”: “0”, “id_pagador”: “0”, “id_pessoafisica”: “0”, “id_recibo”: “0”, “nm_bloco”: “Nome do Galpão”, “nm_pagador”: “Nome do Pagador”, “nm_pessoafisica”: “Nome do Devedor”, “tx_historico”: “Histórico do Recibo”, “vl_correcao”: “0,00”, “vl_juros”: “0,00”, “vl_multa”: “0,00”, “vl_recibodetalhe”: “0,00”, “vl_recibototal”: “0,00” }
] }

id_erro: Código de erro (0 para sucesso). ds_mensagemErro (String): Mensagem de erro, se aplicável. id_empreendimento (String): Identificador único d

… (+1,732 chars)

Documentação da API - Módulo de Prestação de Contas (Despesa).pdf

D Des Este m um d auten Mét Méto URL: h Par O mét infoLo nm_s id_pe id_ses id_ch cd_co dt_ini dt_fim sn_co nm_d Exem <paco <

< < <

Docume scrição método exib eterminado nticação, ide todo do HTTP: POS https://servi âmetros todo despesas ogin (objeto): istema (string essoafisica (int ssao (string): avedispositiv ondominio (st icio (string): D m (string): Dat ompetencia (s dePara (string mplo de C ote> <infoLogin <nm_si <id_pe <id_se <id_ch </infoLogin <cd_condom <dt_inicio entação bira de inform período, com entificação do ST ices4.livefaci s de Solic s requer os se : Contém info g): Nome do s t): ID da pesso ID da sessão, vo (string): Ch tring): Código Data de início ta de fim do p string): Indicad g): Nome do si Corpo da S

stema>SIGLA ssoafisica ssao>XXXXX avedisposi n> inio>123</

AAAA-MM-D o da AP Conta mações deta m base em p o empreend ilities.com.br citação eguintes parâm rmações de a sistema. Solici oa física, reto retornado pe ave do dispos do condomín do período de período de de dor se a despe istema para in Solicitação A</nm_sist 1</id_pes XXX-XXXX-X tivo>XXXXX cd_condomi D</dt_inic

PI - Mó as (Des lhadas sobre parâmetros e imento, e co r/mobile/ap metros no cor utenticação. itar ao respon rnado pelo m elo método de sitivo, geralme nio. e despesas (fo spesas (forma esa é por com ntegração ent o ema> soafisica> XXX-XXXX-X XX</id_cha nio> io> ódulo d spesa) e despesas a específicos, i onfiguração d i/OrdemServ rpo da solicita nsável junto ao étodo de Log e LoginSistem ente definida ormato: “AAA ato: “AAAA-M mpetência (1 o re conta cont

XXXXXXXXXX vedisposit

e Prest ssociadas ao ncluindo info de datas. vico/despesa ação: o cliente. inSistema. a. como “bot”. AA-MM-DD”). MM-DD”). ou 0). tábil, se aplicá XX</id_sess ivo> tação d o fechamento ormações de as ável. ao> de o em e

<dt_fim>AAAA-MM-DD</dt_fim> <sn_competencia>0</sn_competencia>

Resposta A resposta a esta solicitação exibirá as informações das despesas recuperadas e informações relacionadas. A resposta é fornecida em um formato estruturado, geralmente em JSON, que pode ser processado pelo aplicativo que consome a API. Exemplo de Resposta { “PrestacaoContasDespesas”: [ { “dt_pagamento”: “dd/mm/aaaa”, “dt_vencimento”: “dd/mm/aaaa”, “id_centrocusto”: 1234, “id_conta1”: 1234, “id_conta2”: 1234.1, “id_conta3”: 1234.1.2, “nm_centrocusto”: “Centro de Custo”, “nm_conta1”: “Conta Contábil 1”, “nm_conta2”: “Conta Contábil 2”, “nm_conta3”: “Conta Contábil 3”, “nu_integracao1”: null, “nu_integracao2”: null, “nu_integracao3”: null, “nu_integracaoCliente”: null, “tx_historico”: “Descrição da Despesa”, “valor”: “0,00” } “PrestacaoContasPrevistoRealizado”: [], “PrestacaoCont

… (+1,619 chars)

Documentação da API - Módulo de Prestação de Contas (Previsão).pdf

D Des Este m base empr Mét Méto URL: h Par O mét infoLo nm_s id_pe id_ses id_ch cd_co dt_ini dt_fim sn_co nm_d Exem <paco <

< < <

Docume scrição método perm em parâmet reendimento todo do HTTP: POS https://servi âmetros todo previsao ogin (objeto): istema (string essoafisica (int ssao (string): avedispositiv ondominio (st icio (string): D m (string): Dat ompetencia (s dePara (string mplo de C ote> <infoLogin <nm_si <id_pe <id_se <id_ch </infoLogin <cd_condom <dt_inicio entação mite obter in tros específic o e configura ST ices4.livefaci s de Solic o requer os se : Contém info g): Nome do s t): ID da pesso ID da sessão, vo (string): Ch tring): Código Data de início ta de fim do p string): Indicad g): Nome do si Corpo da S

stema>SIGLA ssoafisica ssao>XXXXX avedisposi n> inio>123</

AAAA-MM-D o da AP Conta nformações d cos, incluind ação de datas ilities.com.br citação guintes parâm rmações de a sistema. Solici oa física, reto retornado pe ave do dispos do condomín do período de período de pre dor se a previ istema para in Solicitação A</nm_sist 1</id_pes XXX-XXXX-X tivo>XXXXX cd_condomi D</dt_inic

PI - Mó as (Prev de previsão o o informaçõ s. r/mobile/ap metros no cor utenticação. itar ao respon rnado pelo m elo método de sitivo, geralme nio. e previsão (fo evisão (forma são é por com ntegração ent o ema> soafisica> XXX-XXXX-X XX</id_cha nio> io> ódulo d visão) orçamentári es de autent i/OrdemServ po da solicitaç nsável junto ao étodo de Log e LoginSistem ente definida ormato: “AAAA to: “AAAA-MM mpetência (1 o re conta cont

XXXXXXXXXX vedisposit

e Prest a da prestaç ticação, iden vico/previsao ção: o cliente. inSistema. a. como “bot”. A-MM-DD”). M-DD”). ou 0). tábil, se aplicá XX</id_sess ivo> tação d ção de contas ntificação do o ável. ao> de s com

<dt_fim>AAAA-MM-DD</dt_fim> <sn_competencia>0</sn_competencia>

Resposta A resposta a esta solicitação exibirá as informações da previsão de prestação de contas. A resposta é fornecida em um formato estruturado, geralmente em JSON, que pode ser processado pelo aplicativo que consome a API. Exemplo de Resposta { “PrestacaoContasDespesas”: [], “PrestacaoContasPrevistoRealizado”: [ { “dt_periodo”: “12/2023”, “id_centrocusto”: “0”, “id_conta”: “1234”, “nm_centrocusto”: ” Centro de Custo”, “nm_conta”: “1234 – Conta Contábil”, “nu_integracaoCliente”: null, “pc_estouro”: “100,00”, “tx_sinal”: “D”, “vl_diferenca”: “0,00”, “vl_previsto”: “0,00”, “vl_realizado”: “0,00” } ], “PrestacaoContasReceitas”: [], “ds_mensagemErro”: "", “id_erro”: 0 }

id_erro: Código de erro (0 para sucesso). ds_mensagemErro: Mensagem de erro, se aplicável. PrestacaoContasPrevistoRealizado: Lista de informações de previsão real

… (+1,126 chars)

Documentação da API - Módulo de Prestação de Contas (Receita).pdf

D Des Este m parâm empr Mét Méto URL: h Par O mét infoLo nm_s id_pe id_ses id_ch cd_co dt_ini dt_fim sn_co nm_d Exem <paco <

< < <

Docume scrição método exib metros espec reendimento todo do HTTP: POS https://servi âmetros todo receitas ogin (objeto): istema (string essoafisica (int ssao (string): avedispositiv ondominio (st icio (string): D m (string): Dat ompetencia (s dePara (string mplo de C ote> <infoLogin <nm_si <id_pe <id_se <id_ch </infoLogin <cd_condom <dt_inicio entação bira de inform cíficos, inclu o, e configura ST ices4.livefaci s de Solic requer os seg : Contém info g): Nome do s t): ID da pesso ID da sessão, vo (string): Ch tring): Código Data de início ta de fim do p string): Indicad g): Nome do si Corpo da S

stema>SIGLA ssoafisica ssao>XXXXX avedisposi n> inio>123</

AAAA-MM-D o da AP Cont mações sobre indo informa ação de data ilities.com.br citação guintes parâm rmações de a sistema. Solici oa física, reto retornado pe ave do dispos do condomín do período de período de pre dor se a previ istema para in Solicitação A</nm_sist 1</id_pes XXX-XXXX-X tivo>XXXXX cd_condomi D</dt_inic

PI - Mó as (Rec e receitas em ações de aut as. r/mobile/ap metros no corp utenticação. itar ao respon rnado pelo m elo método de sitivo, geralme nio. e previsão (fo evisão (forma são é por com ntegração ent o ema> soafisica> XXX-XXXX-X XX</id_cha nio> io> ódulo d ceita) m um determ tenticação, id i/OrdemServ po da solicitaç nsável junto ao étodo de Log e LoginSistem ente definida ormato: “AAAA to: “AAAA-MM mpetência (1 o re conta cont

XXXXXXXXXX vedisposit

e Prest minado perío dentificação vico/receitas ção: o cliente. inSistema. a. como “bot”. A-MM-DD”). M-DD”). ou 0). tábil, se aplicá XX</id_sess ivo> tação d odo, com bas do ável. ao> de se em

<dt_fim>AAAA-MM-DD</dt_fim> <sn_competencia>0</sn_competencia>

Resposta A resposta a esta solicitação conterá as informações das receitas recuperadas e informações relacionadas. A resposta é fornecida em um formato estruturado, geralmente em JSON, que pode ser processado pelo aplicativo que consome a API. Exemplo de Resposta {

“PrestacaoContasDespesas”: [], “PrestacaoContasPrevistoRealizado”: [], “PrestacaoContasReceitas”: [ { “cd_bloco”: "", “cd_unidade”: "", “dt_pagamento”: “dd/mm/aaaa”, “dt_vencimento”: “dd/mm/aaaa”, “id_centrocusto”: 1234, “id_conta1”: 1234, “id_conta2”: 1234.1, “id_conta3”: 1234.1.2, “nm_centrocusto”: “Centro de Custo”, “nm_condomino”: “Nome Condomínio”, “nm_conta1”: “Nome da Conta Contábil 1”, “nm_conta2”: “Nome da Conta Contábil 2”, “nm_conta3”: “Nome da Conta Contábil 3”, “nm_contratante”: “Nome Contratante”, “nu_integracao1”: "", “nu_integracao2”: "",

… (+2,105 chars)

Documentação da API - Lista Geral de Contas.doc

Documentação da API – Lista Geral de Contas Descrição A API “Lista Geral de Contas” permite obter informações sobre contas a pagar em um determinado período e empreendimento. Abaixo, estão detalhadas as chamadas aceitas pela API e a estrutura da resposta. Método Método HTTP: POST URL: https://services4.livefacilities.com.br/mobile/api/ContasPagar/ConsultaPagamento Parâmetros de Solicitação O método ConsultaPagamento requer os seguintes parâmetros no corpo da solicitação: infoLogin (objeto): Contém informações de autenticação. nm_sistema (string): Nome do sistema. Solicitar ao responsável junto ao cliente. id_pessoafisica (int): ID da pessoa física, retornado pelo método de LoginSistema. id_sessao (string): ID da sessão, retornado pelo método de LoginSistema. id_chavedispositivo (string): Chave do dispositivo, geralmente definida como “bot”. cd_condominio (string): Código do condomínio. dt_vencimentoinicio (string): Data de início do período do vencimento (formato: “AAAA-MM-DD”). dt_vencimentofim (string): Data de fim do período do vencimento (formato: “AAAA-MM-DD”).

Exemplo de Corpo da Solicitação { “infoLogin”: { “nm_sistema”: “COL”, “id_pessoafisica”: “1”, “id_sessao”: “XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX”, “id_chavedispositivo”: “XXXXXXXXXXXXX” }, “cd_condominio”: “1”, “dt_vencimentoinicio”: “AAAA-MM-DD”, “dt_vencimentofim”: “AAAA-MM-DD” }

Resposta A resposta da API “Lista Geral de Contas” fornece detalhes sobre as contas a pagar de acordo com a chamada realizada.
Exemplo de Resposta { “ds_mensagemErro”: "", “id_erro”: 0, “listaContasPagar”: [ { “cd_contacontabil”: “1 – Nome da Conta Contábil”, “cd_empreendimento”: “0010 – Nome do Empreendimento”, “cd_pagamento”: “1”, “ds_competencia”: “MM/AAAA”, “dt_documentoemissao”: “DD/MM/AAAA”, “dt_pagamentoparcelaagenda”: “DD/MM/AAAA”, “dt_pagamentoparcelabaixado”: “DD/MM/AAAA”, “dt_pagamentoparcelacadastro”: “DD/MM/AAAA HH:MM:SS”, “dt_vencimento”: “DD/MM/AAAA”, “nm_centrocusto”: “Nome do Centro de Custo”, “nm_contacompleto”: “Nome da Conta”, “nm_documentotipo”: “Tipo do Documento”, “nm_fornecedor”: “Nome do Fornecedor”, “nm_gerente”: “Nome do Gerente”, “nm_pagamentoclassificacao”: “Classificação do Pagamento”, “nm_pagamentoclassificacaoanteriorexibe”: "", “nm_pagamentoparcelastatus”: “Status da Parcela”, “nm_pagamentoparcelatipo”: “Tipo do Pagamento”, “nm_solicitante”: “Nome do Solicitante”, “nu_chequefolha”: "", “nu_documento”: “1”, “nu_fornecedordocumento”: “CPF/CNPJ Fornecedor”, “nu_parcela”: “1”, “nu_protocoloDigitalizado”: "", “tx_historico”: "", “vl_bruto”: “0,00”, “vl_documentototal”: “0,00”, “vl_impostopagar”: “0,00”, “vl_liquido”: “0,00” } ] }

id_erro: Código de erro (0 para sucesso). ds_mensag

… (+2,012 chars)

Ver também

PM Spec

Consolidado

Colliers × Costal — Interno

Explorador

API Smart Colliers — Schema Técnico

API Smart Colliers — Documentação Técnica Consolidada

Índice

Conteúdo extraído

Documentação API(s) - Geral Lista - Colliers (1).pdf

Documentação API(s) - Geral Lista - Colliers.pdf

Documentação da API - Baixa de Boleto.pdf

Documentação da API - Boletos.pdf

Documentação da API - Condôminos Com Endereços e Contatos.pdf

Documentação da API - Consulta de Contratos (1).pdf

Documentação da API - Consulta de Contratos.pdf

Documentação da API - Controle de Fechamento.pdf

Documentação da API - Geração de Ordem de Serviço (1).pdf

Documentação da API - Geração de Ordem de Serviço (2).pdf

Documentação da API - Geração de Ordem de Serviço.pdf

Documentação da API - Lista de Atividade.pdf

Documentação da API - Lista De Documentos.pdf

Documentação da API - Lista de Empreendimentos.pdf

Documentação da API - Lista Geral de Contas - Multa.pdf

Documentação da API - Lista Geral de Contas.pdf

Documentação da API - Mandatos.pdf

Documentação da API - Módulo de Inadimplência (1).pdf

Documentação da API - Módulo de Inadimplência.pdf

Documentação da API - Módulo de Prestação de Contas (Despesa).pdf

Documentação da API - Módulo de Prestação de Contas (Previsão).pdf

Documentação da API - Módulo de Prestação de Contas (Receita).pdf

Documentação da API - Lista Geral de Contas.doc

Ver também

Visão de gráfico

Sumário

Backlinks