Business API
626 operações em 117 recursos. Escolha um recurso para ver os pedidos, as respostas e quem os pode fazer.
URL base: $BUSINESS_API
Facturação e pagamentos
- FacturasListar facturas · Emitir uma factura · Reconciliar o consumo de uma factura · Emitir uma factura manual · Ajustar uma factura …13 operações
- Valores a receberListar valores a receber1 operação
- PagamentosListar pagamentos · Registar um pagamento · Registar o pagamento de uma factura · Obter os metadados de um pagamento · Actualizar os metadados de um pagamento …9 operações
- Imputações de pagamentosListar imputações de pagamentos1 operação
- Meios de pagamentoListar meios de pagamento1 operação
- RecibosListar recibos · Descarregar um recibo em PDF · Obter um recibo3 operações
- TarifasListar tarifas · Criar uma tarifa · Obter uma tarifa · Activar uma tarifa · Obter os metadados de uma tarifa …6 operações
- Ciclos de facturaçãoListar ciclos de facturação · Iniciar um ciclo de facturação · Obter um ciclo de facturação · Pré-visualizar um ciclo de facturação · Repetir um ciclo de facturação …10 operações
- AjustesListar ajustes de facturas1 operação
- Planos de pagamentoListar planos de pagamento · Criar um plano de pagamento · Obter um plano de pagamento · Declarar um plano de pagamento em incumprimento4 operações
- Avisos de corteListar avisos de corte1 operação
- Política de facturaçãoObter a política de facturação · Actualizar a política de facturação · Aplicar penalizações por atraso3 operações
- CréditosListar créditos · Atribuir um crédito · Aprovar um crédito · Rejeitar um crédito · Atribuir créditos a várias contas …6 operações
- Agendamentos de facturaçãoListar agendamentos de facturação · Criar um agendamento de facturação · Obter um agendamento de facturação · Actualizar um agendamento de facturação4 operações
- PlanosListar planos1 operação
- ContabilidadeListar o plano de contas · Adicionar uma conta ao plano · Obter o balancete · Obter a reconciliação contabilística · Listar lançamentos …7 operações
- CaixaListar turnos de caixa · Abrir um turno de caixa · Fechar um turno de caixa · Obter o turno de caixa aberto · Obter um turno de caixa …6 operações
- Extractos bancáriosListar extractos bancários · Importar um extracto bancário · Listar linhas bancárias por conciliar · Obter um extracto bancário · Listar linhas de um extracto …9 operações
- CobrançaListar contas elegíveis para corte · Gerar ordens de corte · Obter a antiguidade da dívida · Obter a política de corte · Actualizar a política de corte …10 operações
- Conectores de pagamentoCriar um código de registo de conector · Listar conectores de pagamento · Remover um conector de pagamento3 operações
- Comprovativos de pagamentoListar comprovativos de pagamento · Obter um comprovativo de pagamento · Descarregar um comprovativo de pagamento · Aprovar um comprovativo de pagamento · Rejeitar um comprovativo de pagamento5 operações
- Pré-pagoListar contadores pré-pagos · Tornar um contador pré-pago · Obter um contador pré-pago · Suspender ou retomar um contador pré-pago · Listar movimentos do saldo pré-pago …10 operações
- Revisões de preçosListar revisões de preços · Propor uma revisão de preços · Obter uma revisão de preços · Aprovar uma revisão de preços · Rejeitar uma revisão de preços5 operações
Leituras e contadores
- ContadoresListar contadores · Registar um contador · Instalar um contador · Substituir um contador · Listar instalações de um contador …17 operações
- Instalações de contadoresListar instalações de contadores1 operação
- LeiturasListar leituras por validar · Listar leituras · Submeter uma leitura manual · Obter uma leitura · Aceitar uma leitura …7 operações
- Ciclos de leituraListar ciclos de leitura · Criar um ciclo de leitura · Obter um ciclo de leitura · Actualizar um ciclo de leitura4 operações
- Roteiros de leituraPlanear um roteiro de leitura · Listar roteiros de leitura · Criar um roteiro de leitura · Obter um roteiro de leitura · Activar ou desactivar um roteiro …7 operações
- Leituras estimadasRegistar uma leitura estimada1 operação
- Importação de leiturasImportar leituras1 operação
- Rondas de leituraListar rondas de leitura · Agendar uma ronda de leitura · Obter uma ronda de leitura · Alterar o estado de uma ronda4 operações
- Atribuições de leituraListar atribuições de leitura · Atribuir leituras a um leitor · Obter uma atribuição de leitura · Alterar o estado de uma atribuição4 operações
- ConsumosListar consumos aceites · Registar um consumo aceite2 operações
- Pedidos de leituraListar pedidos de leitura · Criar um pedido de leitura2 operações
- Agendamentos de leituraListar agendamentos de leitura · Agendar leituras remotas · Pausar ou retomar um agendamento · Gerar os pedidos de leitura devidos4 operações
- Contestações de leiturasListar contestações de leituras · Analisar uma contestação de leitura2 operações
- Pedidos de vistoriaListar pedidos de vistoria · Actualizar um pedido de vistoria2 operações
- Qualidade da águaListar limites de qualidade · Definir um limite de qualidade · Listar amostras · Registar uma amostra · Obter uma amostra …7 operações
- SensoresListar sensores · Registar um sensor · Obter um sensor3 operações
- Regras de alarmeListar regras de alarme · Criar uma regra de alarme · Obter uma regra de alarme · Activar uma regra de alarme · Desactivar uma regra de alarme5 operações
- AlarmesListar alarmes · Obter um alarme · Reconhecer um alarme · Fechar um alarme4 operações
- Balanço hídricoObter o balanço hídrico do sistema1 operação
- Tarifas de reconciliaçãoListar tarifas de reconciliação · Criar uma tarifa de reconciliação2 operações
- Contratos de comissãoListar contratos de comissão · Criar um contrato de comissão · Obter um contrato de comissão · Alterar o estado de um contrato de comissão4 operações
- Reconciliações volumétricasListar reconciliações volumétricas · Criar uma reconciliação volumétrica · Obter uma reconciliação volumétrica · Confirmar uma reconciliação volumétrica · Liquidar uma reconciliação volumétrica5 operações
- LiquidaçõesListar liquidações · Obter uma liquidação · Descarregar uma liquidação em PDF3 operações
- Política de abatimento por fugaObter a política de abatimento por fuga · Guardar a política de abatimento por fuga2 operações
- Abatimentos por fugaAvaliar um abatimento por fuga · Listar abatimentos por fuga · Pedir um abatimento por fuga · Obter um abatimento por fuga · Descarregar o comprovativo de reparação …9 operações
- ColectoresListar colectores · Obter um colector · Obter o estado de um colector3 operações
Rede e trabalho no terreno
- ImóveisListar imóveis · Registar um imóvel · Obter os metadados de um imóvel · Actualizar os metadados de um imóvel · Obter um imóvel …7 operações
- Áreas de serviçoListar áreas de serviço · Criar uma área de serviço2 operações
- LigaçõesCortar uma ligação por falta de pagamento · Listar ligações · Criar uma ligação · Obter uma ligação · Actualizar uma ligação …13 operações
- Visitas de campoListar visitas de campo · Registar uma visita de campo · Obter uma visita de campo3 operações
- Fotografias de provaCarregar uma fotografia de prova · Obter uma fotografia de prova2 operações
- Pedidos de serviçoListar pedidos de serviço · Obter um pedido de serviço · Aceitar um pedido de serviço · Recusar um pedido de serviço · Listar preços para o orçamento …9 operações
- Motivos de recusaObter os motivos de recusa · Substituir os motivos de recusa2 operações
- Visitas ao localRegistar o resultado de uma visita ao local · Cancelar uma visita ao local2 operações
- Activos da redeListar activos da rede · Registar um activo da rede · Obter um activo da rede · Actualizar um activo da rede4 operações
- Zonas de mediçãoListar zonas de medição · Registar uma zona de medição · Obter uma zona de medição · Actualizar uma zona de medição · Obter o balanço hídrico de uma zona …6 operações
- TopologiaListar nós da rede · Criar um nó da rede · Obter um nó da rede · Actualizar um nó da rede · Eliminar um nó da rede …16 operações
- Ordens de serviçoListar ordens de serviço · Criar uma ordem de serviço · Obter uma ordem de serviço · Atribuir uma ordem de serviço · Concluir uma ordem de serviço …20 operações
- OcorrênciasListar ocorrências · Comunicar uma ocorrência · Obter uma ocorrência · Resolver uma ocorrência · Obter os metadados de uma ocorrência …6 operações
- InterrupçõesListar interrupções · Agendar uma interrupção · Obter uma interrupção · Concluir uma interrupção4 operações
- BrigadasListar brigadas · Registar uma brigada · Obter uma brigada3 operações
- CalendárioObter o calendário · Actualizar o calendário · Listar dias do calendário · Adicionar um dia ao calendário · Remover um dia do calendário …19 operações
- Indicadores de serviçoObter os indicadores de serviço1 operação
- ArmazémListar artigos · Criar um artigo · Obter um artigo · Actualizar um artigo · Listar localizações …39 operações
Mensagens aos clientes
- Preferências de notificaçãoListar preferências de notificação · Actualizar uma preferência de notificação2 operações
- NotificaçõesListar notificações · Enviar uma notificação · Obter uma notificação3 operações
- Caixa de entradaListar a caixa de entrada · Marcar uma mensagem como lida · Arquivar uma mensagem3 operações
- Casos de cobrançaListar casos de cobrança · Abrir um caso de cobrança · Obter um caso de cobrança · Emitir um aviso de corte · Listar avisos de um caso de cobrança …8 operações
- Pedidos de apoioListar pedidos de apoio · Abrir um pedido de apoio · Obter um pedido de apoio · Atribuir um pedido de apoio · Resolver um pedido de apoio …10 operações
- Campanhas promocionaisListar campanhas promocionais · Criar uma campanha promocional · Obter uma campanha promocional · Activar uma campanha promocional · Pausar uma campanha promocional5 operações
Integrar
- IntegraçõesListar integrações · Registar uma integração · Obter uma integração · Alterar o estado de uma integração · Actualizar a configuração de uma integração5 operações
- Eventos de auditoriaListar eventos de auditoria · Verificar a integridade da auditoria2 operações
- Definições de relatórioListar definições de relatório · Criar uma definição de relatório · Obter uma definição de relatório3 operações
- Execuções de relatóriosListar execuções de relatórios · Executar um relatório · Obter uma execução de relatório3 operações
- Exportação de conformidadePedir uma exportação de conformidade · Obter o estado de uma exportação · Descarregar uma exportação de conformidade3 operações
- Exportações de relatóriosDescarregar um relatório em CSV · Descarregar um relatório em PDF2 operações
- AutomaçõesListar automações · Criar uma automação · Listar modelos de automação · Obter uma automação · Actualizar uma automação …15 operações
- Gatilhos de automaçãoListar gatilhos de automação1 operação
- Políticas de decisãoObter uma política de decisão · Configurar uma política de decisão · Simular uma política de decisão3 operações
- DecisõesListar decisões1 operação
- ProgramadoresObter o resumo para programadores · Listar âmbitos disponíveis para chaves · Listar tipos de evento · Listar chaves de API · Criar uma chave de API …29 operações
- Caixa de saídaListar eventos da caixa de saída · Listar mudanças de estado2 operações
- HistóricoObter o contador de uma ligação numa data · Listar o histórico de contadores de uma ligação · Corrigir o contador de uma ligação · Obter a tarifa em vigor numa data · Obter o proprietário de um imóvel numa data5 operações
- Trabalhos em segundo planoListar trabalhos em segundo plano · Obter o resumo dos trabalhos · Listar trabalhos falhados · Repetir um trabalho falhado · Obter um trabalho5 operações
Plataforma e conta
- Perfil da empresaObter o perfil da empresa1 operação
- OrganizaçõesListar contas de uma organização · Pedir para adicionar uma conta · Pedir para retirar uma conta · Obter a carteira de uma organização · Listar modelos de uma organização …20 operações
- EmpresaListar modelos de organização disponíveis · Listar modelos propostos a esta conta · Aceitar um modelo de organização · Desligar um modelo de organização · Listar associações a organizações por aprovar …6 operações
- Associações a organizaçõesAprovar a associação a uma organização · Rejeitar a associação a uma organização2 operações
- PesquisaPesquisar1 operação
- ClientesDescarregar o modelo de importação de clientes · Validar uma importação de clientes · Confirmar uma importação de clientes · Listar clientes · Registar um cliente …9 operações
- ContasListar contas · Abrir uma conta · Obter uma conta · Listar os acessos a uma conta · Dar acesso a uma conta …12 operações
- Modelos de tarifaListar modelos de tarifa · Criar uma tarifa a partir de um modelo2 operações
- SubscriçãoObter a subscrição · Cancelar a subscrição · Obter a utilização do plano · Obter os créditos da subscrição · Usar um código promocional …13 operações
- MétricasListar métricas1 operação
- AuditoriaExportar eventos de auditoria · Verificar uma exportação de auditoria2 operações
- EquipaListar sessões de um membro · Terminar as sessões de um membro · Listar convites da equipa · Convidar um membro para a equipa · Revogar um convite da equipa …9 operações
- Política de segurançaObter a política de segurança · Substituir a política de segurança2 operações
- ConformidadeObter os prazos de conservação · Actualizar os prazos de conservação2 operações
- Espaço de trabalhoObter os requisitos de verificação · Pedir o encerramento da conta · Anular o encerramento da conta3 operações
- AdesãoObter a adesão · Actualizar a adesão · Submeter a adesão para análise · Submeter um requisito de adesão · Listar documentos da adesão …11 operações
- Convites para contasCriar convites para várias contas1 operação
- Pedidos de associaçãoListar pedidos de associação · Aprovar um pedido de associação · Rejeitar um pedido de associação3 operações
- MetadadosProcurar registos por metadados1 operação
- ResumoObter o resumo1 operação
- MarcaObter a marca · Actualizar a marca · Carregar um ficheiro da marca · Remover um ficheiro da marca4 operações
- Ambiente de testesAvançar o ambiente de teste1 operação
- Primeiros passosVerificar a ligação de pagamentos · Obter o progresso de um percurso inicial · Saltar ou retomar um passo inicial · Registar a saída de um percurso inicial4 operações
- Próximos passosObter os próximos passos1 operação
- LDAPObter a ligação LDAP · Guardar a ligação LDAP · Remover a ligação LDAP · Sincronizar membros a partir do LDAP · Testar a ligação LDAP5 operações
- Início de sessão únicoObter a ligação de início de sessão único · Guardar a ligação de início de sessão único · Remover a ligação de início de sessão único · Ler os metadados SAML de um fornecedor de identidade · Testar a ligação de início de sessão único …6 operações
- SCIMListar tokens SCIM · Criar um token SCIM · Revogar um token SCIM3 operações
- SIEMListar destinos SIEM · Adicionar um destino SIEM · Obter um destino SIEM · Remover um destino SIEM · Testar um destino SIEM5 operações
- Resumo da carteiraObter o resumo da carteira1 operação
- Relações com a empresaListar relações com moradores1 operação