ALTERDATA and CYPHER Learning for Business 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.

Achieved level in CYPHER Learning

Course archived in CYPHER Learning

Attendance record created in CYPHER Learning

Attendance record updated in CYPHER Learning

Awarded badge in course game in CYPHER Learning

Awarded certificate in course game in CYPHER Learning

Awarded points in CYPHER Learning

Commented on course news in CYPHER Learning

Learner completed in CYPHER Learning

Learner completed assessment in CYPHER Learning

Learner completed module in CYPHER Learning

Course created in CYPHER Learning

Created assessment in course in CYPHER Learning

Created module in course in CYPHER Learning

Created wiki page in CYPHER Learning

Course deleted in CYPHER Learning

Edited wiki page in CYPHER Learning

Learner enrolled in CYPHER Learning

Entered chat room in CYPHER Learning

Course finished in CYPHER Learning

Scored assessment in CYPHER Learning

Posted to course forum in CYPHER Learning

Posted to course news in CYPHER Learning

Course published in CYPHER Learning

Replied to course forum in CYPHER Learning

Attendance session created in CYPHER Learning

Attendance session updated in CYPHER Learning

Course started in CYPHER Learning

Submitted assessment in CYPHER Learning

Course unarchived in CYPHER Learning

Learner unenrolled in CYPHER Learning

Course unpublished in CYPHER Learning

Course updated in CYPHER Learning

Learner viewed assessment in CYPHER Learning

Learner viewed modules in CYPHER Learning

Learner viewed section in CYPHER Learning

Member added in CYPHER Learning

Commented on group news in CYPHER Learning

Group created in CYPHER Learning

Posted to group forum in CYPHER Learning

Posted to group news in CYPHER Learning

Member removed in CYPHER Learning

Replied to group forum in CYPHER Learning

User archived in CYPHER Learning

Awarded badge to user in CYPHER Learning

Awarded certificate to user in CYPHER Learning

User added in CYPHER Learning

User logged in in CYPHER Learning

Order payment in CYPHER Learning

User updated in CYPHER Learning

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.

Create assessment grade in Cypher learning

Create assessment grades in Cypher learning

Delete an assessment's grade in Cypher learning

Get an assessment's grade in Cypher learning

List an assessment's grades in Cypher learning

Update an assessment's grade in Cypher learning

Update assessment grades in Cypher learning

Get an assessment's result in Cypher learning

List an assessment's results in Cypher learning

Get a SCORM assessment's result in Cypher learning

List a SCORM assessment's results in Cypher learning

Create attendance record in Cypher learning

Create attendance records in Cypher learning

Delete attendance record in Cypher learning

Get attendance record in Cypher learning

List attendance records in Cypher learning

Update attendance record in Cypher learning

Update attendance records in Cypher learning

List badge awards in Cypher learning

Get badge in Cypher learning

List badges in Cypher learning

Get batch in Cypher learning

List batches in Cypher learning

List certificate awards in Cypher learning

Get certificate in Cypher learning

List certificates in Cypher learning

Update courses in Cypher learning

Get course assessment in Cypher learning

List course assessments in Cypher learning

Add course assistant in Cypher learning

Add course assistants in Cypher learning

Remove course assistant in Cypher learning

Get course assistant in Cypher learning

List course assistants in Cypher learning

Create attendance session in Cypher learning

Create attendance sessions in Cypher learning

Delete attendance session in Cypher learning

Get attendance session in Cypher learning

List attendance sessions in Cypher learning

Update attendance session in Cypher learning

Update attendance sessions in Cypher learning

Create course children in Cypher learning

List course children in Cypher learning

Copy course in Cypher learning

Create course in Cypher learning

Create courses in Cypher learning

Delete course in Cypher learning

Get course in Cypher learning

List courses in Cypher learning

Update course in Cypher learning

Get course group in Cypher learning

List course groups in Cypher learning

Add course instructor in Cypher learning

Add course instructors in Cypher learning

Remove course instructor in Cypher learning

Get course instructor in Cypher learning

List course instructors in Cypher learning

Add course learner in Cypher learning

Add course learners in Cypher learning

Remove course learner in Cypher learning

Get course learner in Cypher learning

List course learners in Cypher learning

Update course learner in Cypher learning

Update course learners in Cypher learning

Get module in Cypher learning

List modules in Cypher learning

Get course reference section in Cypher learning

List course reference sections in Cypher learning

Get course section in Cypher learning

List course sections in Cypher learning

Update course templates in Cypher learning

Get course template assessment in Cypher learning

List course template assessments in Cypher learning

Add course template children in Cypher learning

List course template children in Cypher learning

Copy course template in Cypher learning

Create course template in Cypher learning

Create course templates in Cypher learning

Delete course template in Cypher learning

Get course template in Cypher learning

List course templates in Cypher learning

Update course template in Cypher learning

Get course template's group in Cypher learning

List course template groups in Cypher learning

Add course template instructor in Cypher learning

Add course template instructors in Cypher learning

Remove course template instructor in Cypher learning

Get course template instructor in Cypher learning

List course template instructors in Cypher learning

Get course template's module in Cypher learning

List course template modules in Cypher learning

Get a course template's section in Cypher learning

List course template sections in Cypher learning

Get game in Cypher learning

List games in Cypher learning

Get level in Cypher learning

List levels in Cypher learning

Get player in Cypher learning

List players in Cypher learning

Update groups in Cypher learning

Add group admin in Cypher learning

Add group admins in Cypher learning

Remove group admin in Cypher learning

Get group admin in Cypher learning

List group admins in Cypher learning

Add group assistant in Cypher learning

Add group assistants in Cypher learning

Remove group assistant in Cypher learning

Get group assistant in Cypher learning

List group assistants in Cypher learning

Create group in Cypher learning

Create groups in Cypher learning

Delete group in Cypher learning

Get group in Cypher learning

List groups in Cypher learning

Update group in Cypher learning

Add group leader in Cypher learning

Add group leaders in Cypher learning

Remove group leader in Cypher learning

Get group leader in Cypher learning

List group leaders in Cypher learning

Add group member in Cypher learning

Add group members in Cypher learning

Remove group member in Cypher learning

Get group member in Cypher learning

List group members in Cypher learning

Update job titles in Cypher learning

Create job title in Cypher learning

Create job titles in Cypher learning

Delete job title in Cypher learning

Get job title in Cypher learning

List job titles in Cypher learning

Update job title in Cypher learning

List job title users in Cypher learning

Get a module's section in Cypher learning

List module sections in Cypher learning

Get order in Cypher learning

List orders in Cypher learning

Update organizations in Cypher learning

List organization courses in Cypher learning

List organization course templates in Cypher learning

Create organization in Cypher learning

Create organizations in Cypher learning

Delete organization in Cypher learning

Get organization in Cypher learning

List organizations in Cypher learning

Update organization in Cypher learning

List organization groups in Cypher learning

Add suborganization in Cypher learning

Add suborganizations in Cypher learning

Delete suborganization in Cypher learning

List suborganizations in Cypher learning

List organization users in Cypher learning

List player's badge history in Cypher learning

List player's level history in Cypher learning

List player's point history in Cypher learning

Update users in Cypher learning

Get a user's assessment grade in Cypher learning

List user assessment grades in Cypher learning

Add user child in Cypher learning

Add user children in Cypher learning

Remove user child in Cypher learning

List user children in Cypher learning

List user course assistants in Cypher learning

List user course instructors in Cypher learning

List user course learners in Cypher learning

Create user in Cypher learning

Create users in Cypher learning

Delete user in Cypher learning

Get user in Cypher learning

List users in Cypher learning

Update user in Cypher learning

List user direct reports in Cypher learning

Add user friend in Cypher learning

Add user friends in Cypher learning

Remove user friend in Cypher learning

List user friends in Cypher learning

List user group admins in Cypher learning

List user group assistants in Cypher learning

List user group leaders in Cypher learning

List user group members in Cypher learning

List user mentees in Cypher learning

List user mentors in Cypher learning

Add user parent in Cypher learning

Add user parents in Cypher learning

Remove user parent in Cypher learning

List user parents in Cypher learning

List user sessions in Cypher learning

List user visits in Cypher learning