Alterar uma configuração de CBS por código de integração

put

https://sandbox.mercos.com/api/v1/configuracoes_cbs/integracao/{id}

Altera parcialmente a regra identificada pelo codigo_cbs_integracao. Apenas os campos enviados são alterados. Envie excluido = true para excluir a regra; uma regra excluída responde 404.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Código da regra de CBS no sistema integrador (codigo_cbs_integracao).

Body Params

codigo_cbs_integracao

string | null

Código da regra de CBS no seu sistema (até 60 caracteres). Quando informado, precisa ser único entre as regras não excluídas da conta.

ativa

boolean

Indica se a regra está ativa.

nome_regra

string | null

Nome que identifica a regra (até 100 caracteres). Precisa ser único entre as regras não excluídas da conta. Quando não informado (ou enviado vazio), o Mercos gera um nome no padrão Regra X, usando o menor número livre.

aliquota

double

Alíquota de CBS, em percentual, de 0 a 100, com até 4 casas decimais.

reducao_aliquota

double | null

Percentual de redução da alíquota, de 0 a 100, com até 4 casas decimais. Valor padrão: 0.

ncms

array of strings

Códigos NCM aos quais a regra se aplica (até 20 caracteres cada, até 300 por regra). O NCM não precisa estar vinculado a um produto cadastrado. Quando ncms e produtos não são informados, a regra vale para todos os NCMs e produtos. Quando enviado, substitui a lista atual de vínculos da regra; [] remove todos.

ncms

produtos

array of integers

IDs dos produtos do Mercos aos quais a regra se aplica (até 300 por regra). Os produtos precisam pertencer à divisão/representada da regra. Quando enviado, substitui a lista atual de vínculos da regra; [] remove todos.

produtos

excluido

boolean

Envie true para excluir a regra. Os demais campos são ignorados e a regra não pode mais ser alterada.

divisao_id

integer | null

Move a regra para a divisão informada. Disponível apenas nas contas de indústria com divisões. Uma regra com produtos vinculados só pode ser movida enviando produtos no mesmo PUT. Quando não informado, a regra permanece na divisão atual.

Headers

ApplicationToken

string

required

Identifica sua aplicação.

CompanyToken

string

required

Representa o cliente da sua aplicação.

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

401Unauthorized

404Not Found

422Unprocessable Entity

429Too Many Requests