ALTERDATA and Cloudshare integrations and automations

Dispara quando novos documentos de saída são emitidos. Poll sem resultados devolve zero eventos em vez de falhar.

Dispara quando um novo título a receber é cadastrado no Bimer. Poll sem resultados devolve zero eventos — o 400 "não existe na base de dados" do Bimer é tratado como janela vazia, não como erro, para não interromper o trigger.

Triggered when a class ends in Cloudshare

Triggered when an environment is archived in Cloudshare

Triggered when an environment is created in Cloudshare

Triggered when an environment is deleted in Cloudshare

Triggered when an environment is extended in Cloudshare

Triggered when an environment is resumed in Cloudshare

Triggered when an environment is suspended in Cloudshare

Triggered when a sales experience is created in Cloudshare

Triggered when a sales experience ends in Cloudshare

Triggered when a participant is enrolled in a sales experience in Cloudshare

Triggered when a participant is invited to a sales experience in Cloudshare

Triggered when a participant joins a sales experience in Cloudshare

Triggered when a sales participant requests assistance in Cloudshare

Triggered when a sales participant assistance request is resolved in Cloudshare

Triggered when a student joins in Cloudshare

Triggered when a student requests assistance in Cloudshare

Triggered when a student assistance request is resolved in Cloudshare

Triggered when a training experience is created in Cloudshare

Triggered when a training experience ends in Cloudshare

Triggered when a student is enrolled in a training experience in Cloudshare

Triggered when a student is invited to a training experience in Cloudshare

Triggered when a student joins a training experience in Cloudshare

Triggered when a training student requests assistance in Cloudshare

Triggered when a training student assistance request is resolved in Cloudshare

Triggered when a viewer customization is saved in Cloudshare

Cria um lote a pagar e efetua a baixa do título. Erro de negócio devolvido com HTTP 2xx falha o step.

Cria um lote a receber e efetua a baixa do título. Erro de negócio devolvido com HTTP 2xx falha o step — crítico aqui, já que uma baixa "verde" que não gravou nada desalinha o financeiro silenciosamente.

Consulta características vinculadas a uma pessoa (GET /api/pessoa/caracteristicas). Sem filtros, retorna todas as características. Informe identificadorPessoa para obter apenas as vinculadas a uma pessoa específica. Lista vazia quando não há vínculo — não falha o step.

Consulta o histórico de cotações de um indexador (GET /api/indexadores/{identificador}/cotacoes). Suporta filtro por intervalo (dataInicio/dataFim) e paginação (pagina/tamanho, padrão 1/20). Retorna array direto de CotacaoResponseDTO. Use para CONFIRMAR persistência após gravar uma cotação — HTTP 2xx na escrita não garante que a linha foi gravada. NÃO tolera 404: aqui ele é ambíguo entre "indexador inexistente" e "rota inexistente na versão instalada".

Buscar documento por chave de acesso NF-e in Alterdata bimer

Buscar documento por número e empresa in Alterdata bimer

Consulta um indexador específico (GET /api/indexadores/{identificador}), incluindo a última cotação disponível em ultimaCotacao. Útil para confirmar, após gravar, se a cotação do dia realmente persistiu — HTTP 2xx na escrita não garante persistência.

Consulta a pessoa pelo CPF/CNPJ (ou pelo código externo). ATENÇÃO: o Bimer devolve HTTP 400 (não 404) com "A pessoa informada não existe na base de dados" quando não encontra. Por padrão isso falha o step, preservando o comportamento histórico — desmarque "falharSeNaoEncontrar" para receber encontrado = false e seguir o fluxo de cadastro.

Busca pessoas pelo nome. Lista vazia quando não há resultado — o "não existe na base de dados" que o Bimer devolve como HTTP 400 é tratado aqui como ausência de registro, não como erro.

Consulta um produto pelo código principal. Retorna o produto completo, incluindo identificador interno, empresas, fornecedores, códigos e dados de embalagem. ATENÇÃO: o Bimer devolve HTTP 400 (não 404) quando o produto não existe. Por padrão isso falha o step — desmarque "falharSeNaoEncontrar" para receber encontrado = false em vez de erro. Erro de negócio em HTTP 2xx sempre falha o step.

Retorna a versão da BimerAPI (GET /api/versao) e a versão do banco Bimer (GET /api/versaobimer). Compare com 11.03.02.00: abaixo disso, os endpoints de Indexadores não existem e o campo identificadorIndexador do documento de entrada é descartado silenciosamente pelo model binding.

Cadastra uma nova pessoa como cliente no Bimer. Erro de negócio devolvido com HTTP 2xx falha o step.

Cadastra a cotação de um indexador para uma data (POST /api/indexadores/{identificador}/cotacoes). Campos obrigatórios: dataCotacao e valorCotacao. O Bimer não permite cotação duplicada na mesma data para o MESMO indexador (indexadores diferentes podem ter cotação na mesma data sem conflito). Erro HTTP falha o step no Workato (com o detalhe embutido na mensagem de erro) — sucesso aqui significa apenas HTTP 2xx, não garante persistência; releia a cotação se for crítico.

Cadastra documento fiscal de entrada (POST /api/documentos/entradas). Mapeamento completo do contrato Bimer: itens com lote/série/repasses, pagamentos detalhados (convênio, TAC, cartão, cheque), prazo estruturado, ISS Tomador e identificadorIndexador (moeda). Para documentos em dólar, o indexador vigente do dia deve vir de onde a cotação diária foi gravada (ver nota na action "Incluir cotação em um indexador") — não infira comparando cotações entre indexadores. Retorna identificadores do documento, lote de estoque, itens e pagamentos gerados pelo Bimer. IMPORTANTE: se o Bimer devolver erro de negócio no corpo — mesmo com HTTP 2xx, como acontece em falha de linked server no banco — o step FALHA no Workato, em vez de retornar identificadores vazios com job verde.

Cadastra documento fiscal de saída. Para alto volume, use a versão assíncrona. Erro de negócio devolvido com HTTP 2xx falha o step.

Versão assíncrona — retorna ID e processa em background. Use para emissão em lote sem travar recipe. ATENÇÃO: sucesso aqui significa apenas que o Bimer ACEITOU o documento para processamento. Erros de negócio ocorridos durante o processamento em background NÃO aparecem aqui — acompanhe pelo identificadorProcessamento.

Cadastra uma nova pessoa como fornecedor no Bimer. Erro de negócio devolvido com HTTP 2xx falha o step.

Cadastra um indexador SEM cotação (POST /api/indexadores). Único campo obrigatório: nome. tipoCorrecao padrão "Moeda". codigoChamada é gerado pelo Bimer quando não informado — e esse valor gerado NÃO é devolvido por chamada nenhuma. ATENÇÃO: a API documenta a resposta 201 como null, ou seja, a criação não devolve o identificador. Por isso a action confirma por busca (GET /api/indexadores) e o nome precisa ser ÚNICO — se a confirmação achar 0 ou mais de 1 resultado, a action falha alto em vez de adivinhar. Para criar já com a cotação do dia numa tacada só, use "Criar indexador com cotação inicial".

Cria um indexador novo (POST /api/indexadores) e, em seguida, grava a cotação nele (POST /api/indexadores/{id}/cotacoes) — tudo em uma execução. Use esta action no lugar de alternar/atualizar indexadores fixos: cada execução gera um indexador próprio, preservando histórico completo de cotação sem sobrescrever nada. IMPORTANTE: a criação não devolve o identificador (a API documenta resposta 201 como null) — a action confirma via busca por nome, que precisa ser ÚNICO a cada execução (embuta data/hora no nome). Se a busca de confirmação encontrar 0 ou mais de 1 resultado, a action falha alto em vez de adivinhar.

Erro de negócio devolvido com HTTP 2xx falha o step.

Adiciona um novo pedido de venda no Bimer (POST /api/venda/pedidos). Erros de validação (400) são devolvidos campo a campo — ex.: "Pagamentos[0].Aliquota: The field Aliquota must be between 1 and 100" indica alíquota ausente ou fora de 1..100. Erro de negócio devolvido com HTTP 2xx também falha o step.

Adiciona um novo produto ao sistema Bimer (POST /api/produtos). Sanitiza códigos duplicados antes do envio. Se o Bimer acusar código já existente, busca o produto pelo código e retorna o identificador com ja_existia = true. O retorno do cadastro contém apenas identificador e código — para o produto completo, use "Buscar produto por código". Erro de negócio devolvido com HTTP 2xx falha o step.

Cadastra um título a pagar. Erro de negócio devolvido com HTTP 2xx falha o step.

Cadastra um título a receber. Erro de negócio devolvido com HTTP 2xx falha o step.

Editar cliente in Alterdata bimer

Altera valorCotacao/descricaoCotacao de uma cotação JÁ EXISTENTE (PUT /api/indexadores/{identificador}/cotacoes/{dataCotacao}). A data identifica a cotação — não é possível mudar a data por esta action; para isso, exclua e recrie. ATENÇÃO: para criar cotação em data nova, use "Incluir cotação em um indexador" (POST) — já foi observado PUT em (indexador, data) inexistente retornando 2xx sem gravar nada, apesar da doc prometer 404 nesse caso. sucesso=true aqui NÃO garante persistência — releia a cotação depois se a operação for crítica.

Altera o cadastro de um indexador (PUT /api/indexadores/{identificador}). ATENÇÃO: alterar tipoCorrecao com cotações já cadastradas devolve 422. Por padrão a action LÊ o cadastro atual antes e mescla só os campos que você preencheu — sem isso, o contrato aceita todos os campos como nullable e um PUT parcial pode zerar sigla/codigoMoeda/codigoChamada. A resposta de sucesso é 204 sem corpo: sucesso = HTTP 2xx e NÃO garante persistência, por isso a action relê o indexador ao final e devolve o estado gravado. Para mudar o VALOR de uma cotação, esta não é a action — use "Alterar cotação de um indexador".

Edita uma pessoa ja cadastrada (PUT /api/pessoas/{identificadorPessoa}). Vale para qualquer pessoa, independente de ela ser cliente, fornecedor ou ambos — diferente de "Editar cliente", que usa /api/clientes e aceita o bloco `dados` com os padroes comerciais. O contrato deste endpoint NAO tem `dados`. cpfCnpj e nome sao obrigatorios pela API mesmo numa edicao parcial. Erro de negocio devolvido com HTTP 2xx falha o step.

Editar título a pagar in Alterdata bimer

Editar título a receber in Alterdata bimer

Exclui a cotação de um indexador numa data específica (DELETE /api/indexadores/{identificador}/cotacoes/{dataCotacao}). A própria API verifica se existem documentos usando esse indexador naquela data e pode recusar a exclusão (422) nesse caso — erro que falha o step.

Exclui um indexador (DELETE /api/indexadores/{identificador}). OPERAÇÃO DESTRUTIVA E EM CASCATA: a API remove junto TODAS as cotações do indexador. Antes disso ela verifica vínculo com PedidoDeVenda, LoteDoc e Documento — havendo qualquer um, recusa com 422 e o step falha (proteção da própria API, não desta action). Para apagar só uma data, use "Excluir cotação de um indexador".

Buscar boleto por título a receber in Alterdata bimer

Retorna o PDF do DANFE em base64.

Baixar XML da NF-e in Alterdata bimer

Buscar documento por identificador in Alterdata bimer

Buscar empresa por código in Alterdata bimer

Consulta um pedido de venda já cadastrado (GET /api/venda/pedidos/{identificadorPedidoDeVenda}). Retorna o cabeçalho completo, itens, pagamentos e prazo tal como o Bimer gravou — útil para conferir se um pedido criado por outro caminho (ex.: desktop) preencheu campos que a API rejeitou ao tentar criar via prazo ad-hoc.

Consulta a pessoa pelo identificador interno. ATENÇÃO: o Bimer devolve HTTP 400 (não 404) quando a pessoa não existe. Por padrão isso falha o step — desmarque "falharSeNaoEncontrar" para receber encontrado = false.

Saldos das contas bancárias de uma empresa in Alterdata bimer

Buscar título a pagar por identificador in Alterdata bimer

Buscar título a receber por identificador in Alterdata bimer

Escape hatch para chamar qualquer endpoint não coberto pelas actions nomeadas. Por padrão, também falha o step quando a resposta traz erro de negócio com HTTP 2xx — desmarque a opção se estiver investigando justamente esse tipo de resposta e precisar vê-la crua. Marque "tolerar registro ausente" para que 404 e 400 com "não existe na base de dados" devolvam lista vazia em vez de derrubar o step.

Listar contas bancárias in Alterdata bimer

Lista vazia quando não há documentos no período — não falha o step.

Lista vazia quando não há resultado — não falha o step.

Consulta os indexadores cadastrados (GET /api/indexadores). Suporta filtros por codigoChamada, nome e sigla. Retorna o cadastro — para a última cotação de um indexador, use "Buscar indexador por identificador"; para o histórico, use "Consultar cotações de um indexador". NÃO tolera 404 de propósito: 404 aqui normalmente significa BimerAPI anterior à 11.03.02.00 (rota inexistente), e engolir isso como "lista vazia" esconderia o problema de versão.

Retorna as moedas que podem ser associadas a um indexador (GET /api/indexadores/moedas). Array direto de MoedaResponseDTO.

Lista vazia quando não há resultado — não falha o step.

Consulta títulos a receber por empresa, pessoa, data de cadastro e vencimento. Lista vazia quando não há resultado — não falha o step.

Testa a disponibilidade da API Bimer.

Busca a pessoa pelo CPF/CNPJ. Nao encontrou, cadastra como cliente. Encontrou, atualiza. Resolve cidade, bairro e tipo de logradouro a partir dos nomes. Trata o 400 "nao existe na base de dados" do Bimer como ausencia de registro, nao como erro.

Mesma logica do "Upsert cliente", aplicada a produto: localiza, e entao POST se nao existir ou PUT se existir. Localiza pelo identificador informado ou consultando CADA codigo do payload. ATENCAO: o GET /api/produtos?codigo= so encontra CODIGO PRINCIPAL — produto que ja existe tendo o SKU como codigo secundario NAO e achado por ele; nesse caso passe o identificador vindo do SELECT em CodigoProduto. O Bimer limita Nome em 100 caracteres: a action corta e sinaliza em nomeTruncado.

Class analytics get guided journey aggregated progress in Cloudshare

Class analytics get guided journey student progress in Cloudshare

Class analytics get sales participation over time in Cloudshare

Class students delete in Cloudshare

Class students get in Cloudshare

Class students get all in Cloudshare

Class students post in Cloudshare

Class students put in Cloudshare

Class students resume environment for student in Cloudshare

Class countries in Cloudshare

Class create sponsored link in Cloudshare

Class custom fields in Cloudshare

Class delete in Cloudshare

Class delete all environments in Cloudshare

Class disable sponsored link in Cloudshare

Class get in Cloudshare

Class get all in Cloudshare

Class get detailed in Cloudshare

Class instructors in Cloudshare

Class post in Cloudshare

Class put in Cloudshare

Class send invitations in Cloudshare

Class suspend all environments in Cloudshare

Cloud folders get all in Cloudshare

Cloud folders mount in Cloudshare

Cloud folders regenerate cloudfolders password in Cloudshare

Cloud folders unmount in Cloudshare

Envs delete in Cloudshare

Envs extend in Cloudshare

Envs get in Cloudshare

Envs get all in Cloudshare

Envs get env resources in Cloudshare

Envs get extended in Cloudshare

Envs get extended by machine vanity in Cloudshare

Envs get extended by token in Cloudshare

Envs get multiple envs resources in Cloudshare

Envs patch in Cloudshare

Envs post in Cloudshare

Envs postpone inactivity in Cloudshare

Envs put in Cloudshare

Envs resume in Cloudshare

Envs revert in Cloudshare

Envs suspend in Cloudshare

External clouds vm get vms by environment ID in Cloudshare

External clouds get ervin ids by snapshot ID in Cloudshare

External clouds get ervins in Cloudshare

Guided journey experience get in Cloudshare

Guided journey participant get in Cloudshare

Instructors delete in Cloudshare

Instructors get class instructors in Cloudshare

Instructors patch in Cloudshare

Instructors post in Cloudshare

Invitations invite project member in Cloudshare

Invitations invite to POC in Cloudshare

Ping get in Cloudshare

Ping post in Cloudshare

Project blueprints get in Cloudshare

Project blueprints get by blueprint ID in Cloudshare

Project policies get all in Cloudshare

Projects delete in Cloudshare

Projects get in Cloudshare

Projects get all in Cloudshare

Projects patch in Cloudshare

Regions get in Cloudshare

Sales participants email template get in Cloudshare

Sales participants email template post in Cloudshare

Sales participants environment post in Cloudshare

Sales participants get list in Cloudshare

Sales participants invite in Cloudshare

Sales participants post in Cloudshare

Sales participants put in Cloudshare

Sales participants unassigned environment delete in Cloudshare

Sales participants unassigned environment get in Cloudshare

Sales participants unassigned environment post in Cloudshare

Sales pros email template get in Cloudshare

Sales pros email template post in Cloudshare

Sales pros get list in Cloudshare

Sales pros invite in Cloudshare

Sales pros post in Cloudshare

Sales pros put in Cloudshare

Sales sponsored link post in Cloudshare

Sales user properties delete in Cloudshare

Sales user properties get in Cloudshare

Sales user properties post in Cloudshare

Sales user property delete in Cloudshare

Sales user property put in Cloudshare

Sales assign shared env controlling user in Cloudshare

Sales delete in Cloudshare

Sales get in Cloudshare

Sales get list in Cloudshare

Sales post in Cloudshare

Sales put in Cloudshare

Snapshots get in Cloudshare

Snapshots get for env in Cloudshare

Snapshots mark default in Cloudshare

Snapshots take snapshot in Cloudshare

Templates get all in Cloudshare

Time zones get in Cloudshare

Training instructors email template get in Cloudshare

Training instructors email template post in Cloudshare

Training instructors get list in Cloudshare

Training instructors invite in Cloudshare

Training instructors post in Cloudshare

Training instructors put in Cloudshare

Training sponsored link post in Cloudshare

Training students email template get in Cloudshare

Training students email template post in Cloudshare

Training students environment post in Cloudshare

Training students get list in Cloudshare

Training students invite in Cloudshare

Training students post in Cloudshare

Training students put in Cloudshare

Training students unassigned environment delete in Cloudshare

Training students unassigned environment get in Cloudshare

Training students unassigned environment post in Cloudshare

Training user properties delete in Cloudshare

Training user properties get in Cloudshare

Training user properties post in Cloudshare

Training user property delete in Cloudshare

Training user property put in Cloudshare

Assign a participant as the shared environment controlling user

Trainings delete in Cloudshare

Trainings get in Cloudshare

Trainings get list in Cloudshare

Trainings post in Cloudshare

Trainings put in Cloudshare

Users get login URL in Cloudshare

Users get replacing users options in Cloudshare

Users remove user role in Cloudshare

Vms check execution status in Cloudshare

Vms delete in Cloudshare

Vms edit vm hardware in Cloudshare

Vms execute path in Cloudshare

Vms get remote access file in Cloudshare

Vms reboot in Cloudshare

Vms revert in Cloudshare

Webhooks delete in Cloudshare

Webhooks get in Cloudshare

Webhooks get 2 in Cloudshare

Webhooks patch in Cloudshare

Webhooks post in Cloudshare

Get Customization IDs by Project in Cloudshare

Get Full Viewer Customization in Cloudshare

Post Full Viewer Customization in Cloudshare