Documentação

Importando tipos de contrato

Importação em massa ou atualização de tipos de contrato (conjuntos de regras de royalties) usando um modelo CSV, com suporte para regras escalonadas, condições e múltiplos tipos de alocação.

Os tipos de contrato definem as regras de royalties que determinam como a renda é alocada aos detentores de direitos. Você pode criar e atualizar tipos de contrato em massa usando o recurso de upload de CSV — ideal ao configurar múltiplos acordos de royalties de uma vez.

Os tipos de contrato são reutilizáveis — uma vez criados, um único tipo de contrato pode ser vinculado a múltiplos detentores de direitos e produtos via importações de uso de contrato, poupando você de inserir os mesmos termos de contrato várias vezes. Por esse motivo, tipos de contrato devem ser importados antes do uso de contrato.

Se você precisar criar apenas um ou dois tipos de contrato, pode preferir criá-los via interface do usuário.

Novo em contratos? Leia a visão geral de contratos primeiro para entender como contratos, regras e condições trabalham juntos.

Baixe o modelo de CSV

Um modelo de CSV está disponível para download na página de importação de tipos de contrato:

  1. Vá para o menu principal, canto superior esquerdo, e clique em Importar.
  2. Em ‘O que você está enviando?’, escolha ‘Tipos de Contrato’.
  3. Clique em ‘Baixar arquivo de modelo de tipos de contrato’.
  4. O arquivo de modelo CSV será baixado no seu dispositivo.

Você também pode exportar todos os tipos de contrato existentes da mesma página. Isto é útil se você quiser atualizar tipos de contrato em massa — exporte, altere os dados no seu software de planilha e depois reimporte.

Como funcionam as importações de tipos de contrato

Cada linha no CSV representa uma única regra dentro de um tipo de contrato. Múltiplas linhas com o mesmo nome ou código são agrupadas como regras sob um tipo de contrato.

  • As regras são avaliadas em ordem por prioridade — a primeira regra correspondente é usada para alocação
  • Uma regra sem condições atua como um padrão “catch-all”
  • Se um código de tipo de contrato já existe, suas regras serão substituídas pelas do arquivo

Para mais informações sobre como regras e condições funcionam durante execuções de royalties, veja visão geral de contratos.

Prepare seus dados de tipos de contrato

Abra o modelo de CSV (ou seu arquivo exportado) no seu software de planilha — recomendamos Google Sheets em vez de Excel.

Colunas de identidade

ColunaAliasesObrigatórioDescrição
namecontract-type, contract-name, contract-type-nameVer notaO nome de exibição do tipo de contrato
codecontract-code, contract-type-codeVer notaIdentificador único (auto-slugificado)
descriptionNãoDescrição em formato livre

Cada linha deve ter pelo menos uma de name ou code. Se apenas um code for fornecido (sem name), o tipo de contrato já deve existir no sistema. Se code for omitido, será gerado automaticamente a partir do name.

Configuração de regra

ColunaAliasesObrigatórioDescrição
rule-priorityorder, rule-order, rulepriorityNãoOrdem de avaliação (começando em 0). Auto-incrementado se omitido
allocation-typetype, allocationtype, allocationSimComo os royalties são calculados (veja abaixo)
allocation-percentagepercentage, percent, rate, royalty-rateCondicionalObrigatório para tipos baseados em porcentagem (0–100)
allocation-fixed-pricefixed-price, price-per-unit, fixedpriceCondicionalObrigatório para tipo fixed-price-per-unit — deve ser maior que 0

Tipos de alocação

TipoAliasesRequer
net-receiptsnet receipts, netPorcentagem (0–100)
list-pricelist price, list, rrpPorcentagem (0–100)
list-price-minus-discountlist price minus discountPorcentagem (0–100)
fixed-price-per-unitfixed price per unit, fixed price, fixedPreço fixo (maior que 0)
no-allocationno allocation, noneNada

Para detalhes sobre o que cada tipo de alocação significa, veja ações de regra em Criar e Gerenciar Contratos.

Colunas de condição (todas opcionais)

Cada condição tem um operador e um valor. Se um operador for fornecido, seu valor correspondente é obrigatório.

Coluna de operadorColuna de valorDescrição
discount-rate-operatordiscount-rate-valueFiltrar por taxa de desconto
sale-country-operatorsale-country-value (aliases: country, countries)Filtrar por país (códigos ISO)
units-sold-operatorunits-sold-valueFiltrar por unidades vendidas
total-net-receipts-operatortotal-net-receipts-valueFiltrar por total de receitas líquidas

Operadores numéricos (taxa de desconto, unidades vendidas, receitas líquidas)

OperadorSímboloAliases de palavras
Maior que>greater than, more than
Maior que ou igual>=at least
Menor que<less than
Menor que ou igual<=at most
Igual=is, equals, equal to
Não igual!=is not, not equal to
Entrebetween
Um dein, one of
Não um denot in, not one of

Dica: Para o operador between, use o formato min-max (ex: 10-50).

Operadores de país

Suporta: equals (=), is-not-equal (!=), is-one-of (in), is-not-one-of (not in)

Os valores de país devem ser códigos ISO de país (2–3 letras), separados por vírgulas. Eles são automaticamente convertidos em maiúsculas.

Cuidado com a auto-formatação de planilhas

Excel e outros softwares de planilha podem auto-formatar seus dados de formas que os corrompem. Problemas comuns incluem números longos convertidos para notação científica e datas sendo reformatadas.

Dica: Formate todas as células como texto antes de inserir ou colar dados. Para instruções detalhadas, veja Introdução à importação.

Exemplos

Contrato de porcentagem simples

nameallocation-typeallocation-percentage
Standard Authornet-receipts25

Contrato com regras em camadas

namerule-priorityallocation-typeallocation-percentageunits-sold-operatorunits-sold-value
Tiered Royalty1net-receipts30>=1000
Tiered Royalty2net-receipts25>=500
Tiered Royalty3net-receipts20

A prioridade de regra 3 não tem condições, então atua como o padrão catch-all para vendas abaixo de 500 unidades. Para mais sobre royalties em camadas, veja royalties em camadas.

Contrato baseado em país

namerule-priorityallocation-typeallocation-percentagesale-country-operatorsale-country-value
Regional Rates1net-receipts30inGB,US,CA
Regional Rates2net-receipts20

Contrato de preço fixo

nameallocation-typeallocation-fixed-price
Fixed Ratefixed-price-per-unit1.50

Envie seu CSV de tipos de contrato

Quando você verificou seus dados, salve o arquivo como CSV. No Google Sheets, isso é File > Download > CSV.

  1. Vá para o menu principal, canto superior esquerdo, e clique em Importar.
  2. Em ‘O que você está enviando?’, escolha ‘Tipos de Contrato’.
  3. Em ‘Escolha seu arquivo’ clique em ‘Procurar’ e navegue até seu arquivo CSV.
  4. Clique em ‘Próximo’.
  5. O arquivo será enviado e validado (verificado quanto a problemas). Você verá os resultados em uma página de visualização.
  6. Se os resultados parecerem bons, clique em ‘Continuar’ e os tipos de contrato serão importados (ou, se a etapa de visualização destacar problemas, você precisará corrigir os dados — leia a mensagem de erro e verifique os requisitos acima).

Visualização de execução seca

Antes da importação ser aplicada, você verá um resumo mostrando:

  • Novos tipos de contrato a serem criados (com contagens de regras)
  • Tipos de contrato existentes a serem atualizados (mostrando contagens de regras antigas vs novas)
  • Qualquer erro de validação que precisa ser corrigido

Você deve confirmar a importação antes de qualquer alteração ser salva.

Validação

A importação executa validação antes de qualquer alteração ser feita:

  • Name ou code — pelo menos um deve ser fornecido por linha
  • Allocation type — deve ser um tipo reconhecido
  • Porcentagem — obrigatório para tipos baseados em porcentagem, deve ser 0–100
  • Preço fixo — obrigatório para fixed-price-per-unit, deve ser maior que 0
  • Operadores — devem ser válidos se fornecidos
  • Valores — obrigatórios quando um operador é especificado
  • Códigos de país — devem ser códigos ISO de 2–3 letras
  • Prioridades de regra — devem ser únicas dentro de cada tipo de contrato
  • Valores entre — devem usar formato min-max com dois números

Atualizar tipos de contrato em massa

Você também pode usar o processo acima para atualizar tipos de contrato existentes em massa.

Quando um código de tipo de contrato no CSV corresponde a um registro existente:

  • O nome e descrição são atualizados (se fornecidos)
  • Todas as regras existentes são substituídas pelas regras do CSV — esta é uma substituição completa, então qualquer regra não no CSV será removida

Dicas

  • Use o download de modelo CSV para obter os cabeçalhos de coluna corretos
  • Use o recurso de exportação para baixar seus tipos de contrato atuais como ponto de partida para edições
  • Nomes de coluna são flexíveis — muitos aliases são aceitos (veja as tabelas acima)
  • Operadores podem ser escritos como símbolos (>, >=) ou palavras (greater than, at least)
  • Colunas de condição vazias são ignoradas — apenas adicione condições que você precisa
  • Prioridade de regra é opcional — as regras são auto-numeradas se omitidas

Qual é o próximo passo?

Depois que seus tipos de contrato estão configurados, você pode vinculá-los a detentores de direitos e produtos ao importar uso de contrato.