ALTERDATA and SysAid 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.

Fires when a new service record is created in SysAid containing a raw JSON of data.

Fires when a new service record is created in SysAid containing a standard list of properties.

Fires when a service record is updated in SysAid containing a raw JSON of data.

Fires when a service record is updated in SysAid containing a standard list of properties.

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.

Custom action in SysAid (Custom)

Add a specific Agent to one or more existing user groups in your SysAid account.

Add a specific end user to one or more existing user groups in your SysAid account.

Add a time-tracked activity entry to an existing service record. Activities typically represent work performed, such as troubleshooting, communication, or on-site visits. To learn more about activities.

Add an internal or public note to an existing service record.

Convert an existing Agent into an End user. This action removes the Agent's elevated permissions and system roles, effectively transitioning them to a standard user profile. Admin group memberships, roles, and access rights associated with the Agent role will be removed as part of this conversion.

Convert an existing end user into an Agent. This action grants the user agent-level permissions and enables them to be assigned to service records, join support groups, and access agent-only functionality. Group memberships, roles, and access rights associated with the agent role will be removed as part of this conversion.

Create a new IT Agent user in your SysAid account. This person will be able to access and manage service records.

Create a new asset in your SysAid account

Finalize new attachment creation after the initial call to generate_presigned_url. The is the 3rd call made by the client in the creation flow (1st is generating a presigned URL, 2nd - uploading the object to storage using the presigned URL).

Creates a new Configuration Item (CI)

Create a new CI relation type

Create a new company in your SysAid account.

Creates a new end user in your SysAid account.

Creates a new user group in your SysAid account.

Creates a CI relation for a given CI ID

Create a new service record (ticket) in your SysAid account.

Permanently delete an Agent from your SysAid account using their unique ID. This action is irreversible. Once deleted, the Agent's data cannot be recovered. Use this endpoint with caution to remove agents who no longer require access to the system.

Delete an asset from your SysAid account, this action is irreversible

Delete a CI using it's ID. All links that use this CI will be removed. Once deleted, the data cannot be recovered

Delete the CI relation type. All CI links that use this relation type will be removed. Once deleted, the data cannot be recovered

Delete a company by its ID.

Permanently delete an end user from your SysAid account using their unique ID. This action is irreversible. Once deleted, the end users' data cannot be recovered. Use this endpoint with caution to remove users who no longer require access to the system.

Permanently deletes a CI relation for a given CI using its unique ID

Permanently deletes a service record using its unique ID. This action is irreversible and will remove the record and all associated data from your SysAid account. Deleting a service record may affect reporting, audit trails, or related workflows.

The 1st step in the new attachment creation flow - a request to generate a presigned URL. that the client can use to upload an attachment.

Retrieve detailed information about a specific Agent using their unique SysAid ID.

Retrieve a paginated list of agents in your account. Each agent record includes personal details, contact information, role-specific attributes, group membership, and company association.

Retrieve an Asset by ID

Retrieve a paginated list of assets in your SysAid account.

Returns a hierarchical list of categories.

Retrieve a Configuration Item (CI) by ID.

Retrieve a list of CI relation types configured in SysAid

Retrieve all CI relations for a specific CI by its ID

Retrieve a list of all available Configuration Item (CI) subtypes for the specific CI type.

Retrieve a list of Configuration Item (CI) types.

Retrieves a list of Configuration Items (CIs) from your SysAid CMDB.

Retrieve a list of all companies configured in your SysAid account.

Retrieve a company by its ID.

Retrieve detailed information about a specific end user using their unique SysAid ID.

Retrieve a paginated list of end users in your SysAid account.

Retrieve detailed information about a specific group using its unique ID.

Retrieve a list of all users assigned to a specific group by its unique ID.

Retrieve a list of all user groups in your SysAid account.

Retrieve a list of available field indexes used across SysAid entities (such as service records, users, assets, etc.). Use this endpoint to dynamically discover which fields can be used for building advanced queries or filters in your integration.

Retrieve the full details of a specific service record using its unique SysAid ID.

Allows to retrieve service record's action items.

Get a service record template by ID.

Get a template by the service record ID.

Remove a specific Agent from one or more user groups. Removing an agent from all groups may affect their access permissions and assignment behavior.

Remove a specific End User from one or more user groups.

Mark a service record as resolved. Use this endpoint to update the status of an open ticket to indicate that the issue has been addressed.

Search for service records based on filters, fields or customized query parameters. You can filter records using fields such as status, category, priority, assigned group or agent, creation date, and more.

Send an email notification directly from a specific service record to an end user or agent.

Update the details of an existing Agent identified by their SysAid ID. The new values provided will overwrite existing values.

Update the details of an existing asset. Existing fields will be overwritten with newly provided information

Update the Configuration Item (CI) by ID

Updates the CI relation type. Note: Only custom CI relation types can be updated. Standard CI relation types can't be updated

Update the details of an existing company in your SysAid account.

Update the details of an existing end user identified by their SysAid ID. The new values provided will overwrite existing values.

Update the details of an existing service record using its unique SysAid ID.

Allows to update the service record's action item status.