API Reference
Log In
API Reference

Atualiza um split

Atualiza dados de um split associado ao estabelecimento.

Resposta da requisição

VariávelTipoDescrição
idStringId gerado para identificar esta configuração de split.
ruleStringRegra da divisão de valores.
sellingEstablishmentIdLongId do estabelecimento realizador da venda.
statusStringStatus do split. Ex.: ativo (ACTIVE) ou inativo (INACTIVE).
splitsList.Lista de estabelecimentos envolvidos no split.

Splits

VariávelTipoDescrição
typeStringTipo de estabelecimento no split, se MAIN ou DEFAULT.
establishmentIdLongId do estabelecimento envolvido no split.
planStringIdentificação de plano usado na venda (ORIGIN) ou não (DESTINATION).
taxPayerStringDefine quem paga a taxa deste split. Se o estabelecimento principal (SELLING) ou o estabelecimento do split (PARTICIPANT).
descriptionStringDescrição deste split.
valueDoubleValor percentual do valor recebido no split.

🚧

Para utilizar este endpoint, é necessário seguir o modelo de autenticação descrito na seção Access Token V2 e que o usuário possua uma das seguintes funções:

  • INTEGRADOR_SPLIT_MANAGE

Detalhes do envio da requisição

Regras de valores (rule)

  • GROSS_VALUE: com o valor bruto, a porcentagem de lucro dos splits é captada do valor bruto da venda. Entende-se splits, especificamente aqui neste campo, como os estabelecimentos que não realizaram a venda e que apenas recebem lucro sobre a mesma. Após os splits serem pagos sobre o valor bruto, o estabelecimento realizador da venda recebe o percentual restante subtraído das taxas de venda.
  • LIQUID_VALUE: com o valor líquido, as taxas de venda são debitadas do valor total e então as porcentagens são repassadas para os demais estabelecimentos envolvidos, sejam splits ou estabelecimento realizador da venda.
Language
Click Try It! to start a request and see the response here!