Atualizar uma comissão por código de integração

put

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

Atualiza uma comissão pelo seu codigo_comissao_integracao. Todos os campos são opcionais: envie apenas os que deseja alterar. Envie "excluido": true para excluir. Comissões excluídas não podem mais ser alteradas.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Código da comissão no sistema integrador (codigo_comissao_integracao).

Body Params

codigo_comissao_integracao

string | null

Código da comissão no sistema que está integrando ao Mercos (até 60 caracteres). Opcional. Quando informado, deve ser único por empresa.

status

integer

Status da comissão: 0=prevista, 1=confirmada, 2=paga, 3=cancelada. Obrigatório.

colaborador_id

integer

Identificador único do colaborador. Obrigatório.

pedido_id

integer | null

Identificador do pedido vinculado. Opcional.

representada_id

integer | null

Identificador da representada vinculada. Opcional. Utilize este campo se a sua conta não é uma indústria com divisões. Se for, utilize divisao_id no lugar dele.

divisao_id

integer | null

Identificador da divisão vinculada. Opcional. Utilize este campo se a sua conta é uma indústria com divisões. Nas demais contas, utilize representada_id.

cliente_id

integer | null

Identificador do cliente vinculado. Opcional.

data_competencia

string

Data/período ao qual a comissão se refere (formato YYYY-MM-DD). Obrigatório.

data_pagamento

string | null

Data em que a comissão foi ou será paga (formato YYYY-MM-DD). Opcional.

valor_bruto_pedido

number | null

Valor total do pedido sem os descontos. Aceita negativos e zero. Opcional.

valor_descontos

number | null

Impostos e outras despesas abatidos do valor base para cálculo. Aceita negativos e zero. Opcional.

valor_base

number | null

Valor base utilizado para o cálculo da comissão. Aceita negativos e zero. Opcional.

percentual_comissao

number | null

Percentual aplicado no cálculo da comissão. Aceita negativos e zero. Opcional.

valor_comissao

number

Valor final da comissão a ser paga. Aceita negativos e zero. Obrigatório.

observacao

string | null

Campo livre para informações adicionais sobre a comissão (até 1.000 caracteres). Opcional.

excluido

boolean

Envie true para excluir a comissão. Comissões excluídas não podem mais ser alteradas.

Headers

ApplicationToken

string

e.g. {{ApplicationToken}}

CompanyToken

string

e.g. {{CompanyToken}}

Response

Language

Loading…

Response

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

application/json

200OK