Announcement
Esta página também está disponível em English, Deutsch, Español, Français, Italiano e 日本語.
Novidade em Contract Templates: aplique um template a vários clientes via API
Crie contratos em rascunho para até 100 clientes em uma única chamada de API.
By Sam Clark
·Shipped by
No Console, aplicar um template de contrato aos seus clientes é uma ação só: escolha o template, escolha os clientes e receba um contrato em rascunho para cada um. Pela API, isso era um loop: era preciso ler o template, copiar suas regras de faturamento, price books e itens de linha personalizados para o corpo da chamada de criação de contrato — e repetir para cada cliente.
A API de Contract Templates agora faz o mesmo que o Console. Um único POST /billing/v1/contract-templates/{templateID}/contracts cria um contrato em rascunho para cada cliente do lote. As regras de faturamento, os price books e os itens de linha personalizados do template já vêm configurados.
- Aplicação em lote: envie até 100 clientes por requisição. Cada cliente recebe seu próprio resultado, então um cliente inelegível não bloqueia os demais.
- Dry run: adicione
dryRun=truepara validar o lote inteiro sem criar nada. Use essa opção primeiro. Toda chamada real cria novos rascunhos, inclusive para clientes que já têm um rascunho criado a partir do mesmo template. - Criação para um único cliente: informe um
templateIdao criar um contrato pela API de Contracts para aplicar um template em uma única chamada. Os componentes do template são tudo ou nada: uma requisição que também traga suas próprias regras de faturamento, price books ou itens de linha personalizados será rejeitada.
Todos os contratos são criados como rascunho. Você revisa e ativa cada um da mesma forma que faz hoje.
Para começar, consulte a referência da API, com o endpoint e exemplos de requisição, e o guia de templates de contrato para entender como os templates funcionam. Para chamar a API, é necessário ter acesso à External API e a permissão Contract Templates Admin.
Disponível para distribuidores e revendedores que usam o PartnerOps Revenue Management.
Related documentation
