Links para o sistema Use esta página para montar o link de uma tela. Todos os endereços são a partir do endereço da conta , o mesmo em que o usuário entra na Ada.Neste artigo
Padrão dos endereços Telas Abas, etapas e ações Listas já filtradas Exemplos prontos Números das situações Campos disponíveis Lugares sem endereço próprio
Padrão dos endereços Padrão Exemplo Abre /{área}/contractA lista /{área}/new/contract/newO assistente de novo registro /{área}/{id}/contract/123A ficha do registro /{área}?page=2/invoice?page=2A segunda página da lista
Quando o usuário informa um número ("contrato 123", "lançamento 45"), use-o como {id}.
Telas Tela Lista Ficha Novo Home /Cadastros /client/client/{id}/client/newContratos /contract/contract/{id}/contract/newLançamentos /invoice/invoice/{id}/invoice/newAssinaturas /signature/signature/{id}/signature/newPendências /issuesPreview de faturamento /preview/billing/preview/billing/{id}Preview de pagamentos /preview/payment/preview/payment/{id}Preview de reajustes /preview/readjust/preview/readjust/{id}Preview de renovações /preview/renew/preview/renew/{id}Resultados /report/dreCriador de análises /report/creatorPlanos /plan/plan/plan/plan/{id}/plan/plan/newProdutos /plan/product/plan/product/{id}/plan/product/newItens do catálogo /plan/item/plan/item/{id}/plan/item/newVersões /plan/version/plan/version/{id}/plan/version/newVariantes /plan/variant/plan/variant/{id}/plan/variant/newTabelas de preços /plan/price/plan/price/{id}/plan/price/newOrganizações /config/organization/config/organization/{id}/config/organization/newIntegrações /config/integration/config/integration/{id}/config/integration/newUsuários /config/user/config/user/{id}Webhooks /config/webhook/config/webhook/{id}/config/webhook/newCategorias /config/categoriesContas /config/treasury_account/config/treasury_account/{id}/config/treasury_account/newExportar /exchange/downloadImportar /exchange/import/exchange/import/{id}/exchange/import/newMeu perfil /profile/info, /profile/email, /profile/emails, /profile/notifications, /profile/password, /profile/themePrimeiros passos /onboarding
Abas, etapas e ações Três parâmetros levam direto a um ponto de uma tela. O valor é um nome fixo, listado abaixo.
Parâmetro Abre Exemplo tabA ficha já na aba /contract/123?tab=processamentostepO assistente na etapa /contract/new?step=vencimentoactionA confirmação de uma ação, sem executá-la /invoice/123?action=baixa-manual
Valor desconhecido é ignorado: a tela abre normalmente. No assistente, se a etapa pedida ainda não estiver liberada, abre na primeira etapa incompleta. O link não dá acesso a nada. Se o usuário não tem permissão para a aba ou a ação, a tela abre normal. A ação sempre pede a confirmação do usuário. Tela Tipo Nomes /contract/newstepcobranca, configuracao, vencimento, regras, detalhes, itens, descontos, arquivos/client/newstepdados-fiscais/contract/{id}tabitens, aditivos, datas, detalhes, regras, uso, consumo, pedidos, suspensao, cobrar-depois, descontos, contatos, historico, alteracoes, processamento, assinaturas, arquivos, observacoes/contract/{id}actionativar, cancelar, habilitar, habilitar-processamento, reativar, suspender, suspender-processamento/config/organization/{id}tabprocessamento, pagamentos, integracoes/client/{id}tabalteracoes, cartoes, contatos, dados-fiscais, endereco, historico, observacoes, pagamentos, receitas/invoice/{id}tabboletos, competencia, comprovantes-notas, detalhes, retencoes, comentarios/invoice/{id}actionalterar-vencimento, agendar-pagamento, alterar-notificacao, baixa-manual, reverter-pagamento, cancelar, duplicar, emitir-nfe, enviar-nfe, cancelar-nfe, lancar-pedido, confirmar-valor, emitir-boleto, reenviar-boleto/signature/{id}tabsignatarios, historico, documentos
Listas já filtradas As listas aceitam o parâmetro filter com as condições em JSON, codificado na URL . A lista abre já filtrada.
{
"logical_operator": "AND",
"rules": [
{
"logical_operator": "AND",
"rules": [
{
"operator": "exact",
"field": "status_id",
"type": "constant",
"value": "2"
},
{
"operator": "exact",
"field": "billing_status_id",
"type": "constant",
"value": "0"
}
]
}
]
}
O JSON tem sempre a forma logical_operator mais rules, com um grupo dentro. Cada regra tem:
Chave O que é fieldO campo. Para um campo de outro cadastro, use dois sublinhados, como organization__nickname operatorexact (igual), exact_date (data igual), lte_age e gte_age (data relativa)typeconstant (situações e tipos, pelo número), boolean, abc (texto) ou datevalueO valor. Em datas relativas: {"value":"30","type":"days","time":"future"}, com time igual a past ou future
Exemplos prontos Lista Endereço Contratos ativos /contract?filter=%7B%22logical_operator%22%3A%22AND%22%2C%22rules%22%3A%5B%7B%22logical_operator%22%3A%22AND%22%2C%22rules%22%3A%5B%7B%22operator%22%3A%22exact%22%2C%22field%22%3A%22status_id%22%2C%22type%22%3A%22constant%22%2C%22value%22%3A%222%22%7D%5D%7D%5D%7DContratos com processamento desligado /contract?filter=%7B%22logical_operator%22%3A%22AND%22%2C%22rules%22%3A%5B%7B%22logical_operator%22%3A%22AND%22%2C%22rules%22%3A%5B%7B%22operator%22%3A%22exact%22%2C%22field%22%3A%22status_id%22%2C%22type%22%3A%22constant%22%2C%22value%22%3A%222%22%7D%2C%7B%22operator%22%3A%22exact%22%2C%22field%22%3A%22billing_status_id%22%2C%22type%22%3A%22constant%22%2C%22value%22%3A%220%22%7D%5D%7D%5D%7DContratos aguardando ativação /contract?filter=%7B%22logical_operator%22%3A%22AND%22%2C%22rules%22%3A%5B%7B%22logical_operator%22%3A%22AND%22%2C%22rules%22%3A%5B%7B%22operator%22%3A%22exact%22%2C%22field%22%3A%22status_id%22%2C%22type%22%3A%22constant%22%2C%22value%22%3A%221%22%7D%5D%7D%5D%7DContratos aguardando cancelamento /contract?filter=%7B%22logical_operator%22%3A%22AND%22%2C%22rules%22%3A%5B%7B%22logical_operator%22%3A%22AND%22%2C%22rules%22%3A%5B%7B%22operator%22%3A%22exact%22%2C%22field%22%3A%22status_id%22%2C%22type%22%3A%22constant%22%2C%22value%22%3A%224%22%7D%5D%7D%5D%7DContratos que terminam em 30 dias sem renovação /contract?filter=%7B%22logical_operator%22%3A%22AND%22%2C%22rules%22%3A%5B%7B%22logical_operator%22%3A%22AND%22%2C%22rules%22%3A%5B%7B%22operator%22%3A%22exact%22%2C%22field%22%3A%22status_id%22%2C%22type%22%3A%22constant%22%2C%22value%22%3A%222%22%7D%2C%7B%22operator%22%3A%22exact%22%2C%22field%22%3A%22auto_renew%22%2C%22type%22%3A%22boolean%22%2C%22value%22%3A%22false%22%7D%2C%7B%22operator%22%3A%22lte_age%22%2C%22field%22%3A%22end_date%22%2C%22type%22%3A%22date%22%2C%22value%22%3A%7B%22value%22%3A%2230%22%2C%22type%22%3A%22days%22%2C%22time%22%3A%22future%22%7D%7D%5D%7D%5D%7DContratos com reajuste em até 30 dias /contract?filter=%7B%22logical_operator%22%3A%22AND%22%2C%22rules%22%3A%5B%7B%22logical_operator%22%3A%22AND%22%2C%22rules%22%3A%5B%7B%22operator%22%3A%22exact%22%2C%22field%22%3A%22status_id%22%2C%22type%22%3A%22constant%22%2C%22value%22%3A%222%22%7D%2C%7B%22operator%22%3A%22lte_age%22%2C%22field%22%3A%22readjust_after%22%2C%22type%22%3A%22date%22%2C%22value%22%3A%7B%22value%22%3A%2230%22%2C%22type%22%3A%22days%22%2C%22time%22%3A%22future%22%7D%7D%5D%7D%5D%7DLançamentos a receber vencidos /invoice?filter=%7B%22logical_operator%22%3A%22AND%22%2C%22rules%22%3A%5B%7B%22logical_operator%22%3A%22AND%22%2C%22rules%22%3A%5B%7B%22operator%22%3A%22exact%22%2C%22field%22%3A%22type_id%22%2C%22type%22%3A%22constant%22%2C%22value%22%3A%221%22%7D%2C%7B%22operator%22%3A%22exact%22%2C%22field%22%3A%22status_id%22%2C%22type%22%3A%22constant%22%2C%22value%22%3A%221%22%7D%2C%7B%22operator%22%3A%22lte_age%22%2C%22field%22%3A%22due_date%22%2C%22type%22%3A%22date%22%2C%22value%22%3A%7B%22value%22%3A%221%22%2C%22type%22%3A%22days%22%2C%22time%22%3A%22past%22%7D%7D%5D%7D%5D%7DLançamentos a pagar vencidos /invoice?filter=%7B%22logical_operator%22%3A%22AND%22%2C%22rules%22%3A%5B%7B%22logical_operator%22%3A%22AND%22%2C%22rules%22%3A%5B%7B%22operator%22%3A%22exact%22%2C%22field%22%3A%22type_id%22%2C%22type%22%3A%22constant%22%2C%22value%22%3A%222%22%7D%2C%7B%22operator%22%3A%22exact%22%2C%22field%22%3A%22status_id%22%2C%22type%22%3A%22constant%22%2C%22value%22%3A%221%22%7D%2C%7B%22operator%22%3A%22lte_age%22%2C%22field%22%3A%22due_date%22%2C%22type%22%3A%22date%22%2C%22value%22%3A%7B%22value%22%3A%221%22%2C%22type%22%3A%22days%22%2C%22time%22%3A%22past%22%7D%7D%5D%7D%5D%7DLançamentos a receber que vencem nos próximos 7 dias /invoice?filter=%7B%22logical_operator%22%3A%22AND%22%2C%22rules%22%3A%5B%7B%22logical_operator%22%3A%22AND%22%2C%22rules%22%3A%5B%7B%22operator%22%3A%22exact%22%2C%22field%22%3A%22type_id%22%2C%22type%22%3A%22constant%22%2C%22value%22%3A%221%22%7D%2C%7B%22operator%22%3A%22exact%22%2C%22field%22%3A%22status_id%22%2C%22type%22%3A%22constant%22%2C%22value%22%3A%221%22%7D%2C%7B%22operator%22%3A%22gte_age%22%2C%22field%22%3A%22due_date%22%2C%22type%22%3A%22date%22%2C%22value%22%3A%7B%22value%22%3A%221%22%2C%22type%22%3A%22days%22%2C%22time%22%3A%22future%22%7D%7D%2C%7B%22operator%22%3A%22lte_age%22%2C%22field%22%3A%22due_date%22%2C%22type%22%3A%22date%22%2C%22value%22%3A%7B%22value%22%3A%227%22%2C%22type%22%3A%22days%22%2C%22time%22%3A%22future%22%7D%7D%5D%7D%5D%7D
Números das situações Lista Campo Valores Contratos status_id1 aguardando ativação, 2 ativo, 3 suspenso, 4 aguardando cancelamento, 5 cancelado Contratos billing_status_id0 não processar, 1 processar Lançamentos status_id1 pendente, 2 pago, 4 cancelado, 6 aguardando pedido, 7 cobrança externa Lançamentos type_id1 a receber, 2 a pagar, 3 previsão a receber, 4 previsão a pagar Cadastros type_id1 cliente, 2 fornecedor, 3 cliente e fornecedor Cadastros punctuality_id1 não analisado, 2 em avaliação, 3 costuma atrasar, 4 irregular, 5 paga em dia, 6 paga adiantado Cadastros score_id1 não calculado, 2 ruim, 3 baixo, 4 bom, 5 excelente
Campos disponíveis Lista Campos Cadastros nome, apelido, número fiscal, ativo, cidade, regime fiscal, tipo de documento, país, tipo, pontualidade, score, data de criação Contratos organização, cliente, plano, situação, título, vigência, moeda, descrição, reajuste, renovação, competência faturada, tipo, recorrência, produto, situação da cobrança, categoria Lançamentos organização, cliente, contrato, situação, competência, forma de pagamento, datas de vencimento, pagamento e conciliação, valores, moeda, descrição, tipo, categoria, nota
Lugares sem endereço próprio Abas, ações e etapas de assistente não têm endereço . Leve o usuário à tela e diga onde clicar. Por exemplo, "Processamento" de uma organização: /config/organization/{id}, aba Processamento . As tabelas Onde acessar de cada página trazem a instrução.