ALTERDATA and inRiver PIM 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.

Trigger when a new product is added in InRiver

Trigger when a product is updated in InRiver

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.

Add a Category. in Inriver PI m ( preview)

Add a CVL. in Inriver PI m ( preview)

Adds an EntityType. in Inriver PI m ( preview)

Add extension. in Inriver PI m ( preview)

Add external media url in Inriver PI m ( preview)

Add a FieldSet. in Inriver PI m ( preview)

Create a new field type in Inriver PI m ( preview)

Add a FieldType to a FieldSet. in Inriver PI m ( preview)

Add a Language. in Inriver PI m ( preview)

Add or update one extension setting. in Inriver PI m ( preview)

Add a RestrictedFieldPermission. in Inriver PI m ( preview)

Assign a role to a user and segment in Inriver PI m ( preview)

Apply default extension settings in Inriver PI m ( preview)

Channel path content in Inriver PI m ( preview)

Entity comments in Inriver PI m ( preview)

Returns a completeness details in Inriver PI m ( preview)

Post entity comment in Inriver PI m ( preview)

Create new CVL value in Inriver PI m ( preview)

Create a new entity in Inriver PI m ( preview)

Create a new link in Inriver PI m ( preview)

Create a new workarea in Inriver PI m ( preview)

Delete all queued connect messages. in Inriver PI m ( preview)

Delete a Category. in Inriver PI m ( preview)

Delete entity comment in Inriver PI m ( preview)

Delete queued connect messages with a specified extensionId in a set timeframe between a start date and an end date. in Inriver PI m ( preview)

Delete a CVL. in Inriver PI m ( preview)

Delete CVL value in Inriver PI m ( preview)

Delete an entity in Inriver PI m ( preview)

Deletes an EntityType. in Inriver PI m ( preview)

Delete an extension by its extension ID. in Inriver PI m ( preview)

Delete one extension setting by its key. in Inriver PI m ( preview)

Delete a FieldSet. in Inriver PI m ( preview)

Delete field type in Inriver PI m ( preview)

Remove a FieldType from a FieldSet. in Inriver PI m ( preview)

Remove a Language. in Inriver PI m ( preview)

Delete link in Inriver PI m ( preview)

Delete a package. in Inriver PI m ( preview)

Delete any Restriction related to a FieldType. in Inriver PI m ( preview)

Delete user in Inriver PI m ( preview)

Delete workarea folder in Inriver PI m ( preview)

Disable an enabled extension. in Inriver PI m ( preview)

Enable a disabled extension. in Inriver PI m ( preview)

Get entity types for channel in Inriver PI m ( preview)

Returns various types of entity data in Inriver PI m ( preview)

Field value revisions in Inriver PI m ( preview)

Get all Categories. in Inriver PI m ( preview)

Returns all values for a CVL in Inriver PI m ( preview)

Returns all CVL's in Inriver PI m ( preview)

Returns available entity types in Inriver PI m ( preview)

Return a list of all extensions that have been added to the environment. in Inriver PI m ( preview)

Returns available field sets. in Inriver PI m ( preview)

Get all FieldTypes for a particular EntityType. in Inriver PI m ( preview)

Get filter configurations. in Inriver PI m ( preview)

Get applicable filter types. in Inriver PI m ( preview)

Returns available image configurations in Inriver PI m ( preview)

Returns available languages. in Inriver PI m ( preview)

Returns a read only list of media resources linked to the entity in Inriver PI m ( preview)

Lists all packages that have been added. in Inriver PI m ( preview)

Get all RestrictedFieldPermissions. in Inriver PI m ( preview)

Get All Segments in Inriver PI m ( preview)

Returns all specification templates in Inriver PI m ( preview)

Get entity links in Inriver PI m ( preview)

Get a list of entities in a channel in Inriver PI m ( preview)

Get a Category. in Inriver PI m ( preview)

Get Channel queue messages for a customer environment. in Inriver PI m ( preview)

Channel structure list in Inriver PI m ( preview)

Get structure entities for entity in Inriver PI m ( preview)

Get channel id's for entity id in Inriver PI m ( preview)

Get Extensions queue messages for a customer environment. in Inriver PI m ( preview)

Get a CVL. in Inriver PI m ( preview)

Get CVL value in Inriver PI m ( preview)

Returns an entity creation model in Inriver PI m ( preview)

Returns a bundle of the entity and all linked entities in Inriver PI m ( preview)

Returns a read only entity summary in Inriver PI m ( preview)

Gets a single EntityType. in Inriver PI m ( preview)

Get information on a specific extension by its extension ID. in Inriver PI m ( preview)

Get extension statistics. in Inriver PI m ( preview)

Get extension setting in Inriver PI m ( preview)

Get all of the settings that have been added to an extension. in Inriver PI m ( preview)

Get the current status for if the extension is enabled/disabled. in Inriver PI m ( preview)

Get a single FieldType. in Inriver PI m ( preview)

Returns a list of field values in Inriver PI m ( preview)

Returns a read only list of field values in Inriver PI m ( preview)

Get a filter configuration. in Inriver PI m ( preview)

Return full details of available image configurations in Inriver PI m ( preview)

Returns a link in Inriver PI m ( preview)

Returns a list of links in Inriver PI m ( preview)

Returns a read only detailed list of media resources linked to the entity in Inriver PI m ( preview)

Get a package. in Inriver PI m ( preview)

Get package content. in Inriver PI m ( preview)

Get a RestrictedFieldPermission. in Inriver PI m ( preview)

Get list of server settings in Inriver PI m ( preview)

Returns a read only list of specification field values in Inriver PI m ( preview)

Returns field types for specification template in Inriver PI m ( preview)

Returns a list of specification field values in Inriver PI m ( preview)

Get user in Inriver PI m ( preview)

Get list of users in Inriver PI m ( preview)

Returns a dictionary of unique values and entity id's in Inriver PI m ( preview)

Pause an extension. in Inriver PI m ( preview)

Provision user in Inriver PI m ( preview)

Search for entity id's in Inriver PI m ( preview)

Triggers a reload of all settings to be accessible from Context.Settings in the extension. in Inriver PI m ( preview)

Remove a role from a user and segment in Inriver PI m ( preview)

Restart all extensions. in Inriver PI m ( preview)

Resume a paused extension. in Inriver PI m ( preview)

Get list of user roles and permissions in Inriver PI m ( preview)

Run an extension of type ScheduledExtension. in Inriver PI m ( preview)

Run Syndicate in Inriver PI m ( preview)

Get list of segments in Inriver PI m ( preview)

Set an apikey on an inbound extension of extensionType. in Inriver PI m ( preview)

Set field set in Inriver PI m ( preview)

Update field values in Inriver PI m ( preview)

Update field values v2 in Inriver PI m ( preview)

Set entity segment in Inriver PI m ( preview)

Set specification template in Inriver PI m ( preview)

Modify user access for segment in Inriver PI m ( preview)

Set entity id's in a static workarea in Inriver PI m ( preview)

Get list of starred entities in Inriver PI m ( preview)

Get All Syndications in Inriver PI m ( preview)

Test an extension. in Inriver PI m ( preview)

Update a Category. in Inriver PI m ( preview)

Update a CVL. in Inriver PI m ( preview)

Update CVL value in Inriver PI m ( preview)

Updates an EntityType. in Inriver PI m ( preview)

Update a FieldSet. in Inriver PI m ( preview)

Update an existing FieldType. in Inriver PI m ( preview)

Update a filter configuration. in Inriver PI m ( preview)

Update sort order of links in Inriver PI m ( preview)

Exchange base64 encoded file data of the package to a new version. in Inriver PI m ( preview)

Update specification field values in Inriver PI m ( preview)

Update list of starred entities in Inriver PI m ( preview)

Update user in Inriver PI m ( preview)

Update workarea folder in Inriver PI m ( preview)

Update workarea query in Inriver PI m ( preview)

Add Media in Inriver PI m ( preview)

Upload base64 encoded file data of the package. in Inriver PI m ( preview)

Insert or update entities and links in Inriver PI m ( preview)

Get entity id's in a static workarea in Inriver PI m ( preview)

Get workarea folder tree in Inriver PI m ( preview)

Get workarea folders in Inriver PI m ( preview)

Returns a list of entities in a workarea folder in Inriver PI m ( preview)