A entidade comissões permite integrar ao Mercos os valores de comissão já calculados no sistema de gestão da sua empresa.
Ela é destinada às contas configuradas para receber as informações de comissão por meio da integração, em Minha Conta > Plano e Conta > Minha empresa. Nessas contas, o Mercos não calcula a comissão: os valores enviados por esta entidade são exibidos aos vendedores no relatório de Comissões, dentro do sistema.
Cada comissão pode ser identificada pelo seu id no Mercos ou pelo codigo_comissao_integracao, o código do registro no sistema que está integrando.
Filtros disponíveis
Você pode aplicar os seguintes filtros na consulta GET:
- colaborador_id: identificador do colaborador
- pedido_id: identificador do pedido
- alterado_apos: retorna apenas as comissões alteradas após a data e hora informadas
Exemplo: ?colaborador_id=10
Estrutura de Retorno (GET)
| Campo | Tipo | Descrição |
|---|---|---|
| comissao_id | Integer | Identificador único da comissão no Mercos. |
| codigo_comissao_integracao | String: 60 | Código da comissão no sistema que está integrando ao Mercos. Único por empresa. |
| status | Integer | 0 = prevista, 1 = confirmada, 2 = paga, 3 = cancelada. |
| colaborador_id | Integer | Identificador único do colaborador. |
| pedido_id | Integer | Identificador do pedido vinculado. |
| representada_id | Integer | Identificador da representada vinculada. |
| cliente_id | Integer | Identificador do cliente vinculado. |
| data_competencia | String: 10 | Data/período ao qual a comissão se refere. Formato "yyyy-mm-dd". |
| data_pagamento | String: 10 | Data em que a comissão foi ou será paga. Formato "yyyy-mm-dd". |
| valor_bruto_pedido | Decimal | Valor total do pedido sem os descontos. |
| valor_descontos | Decimal | Impostos e outras despesas abatidos do valor base para cálculo da comissão. |
| valor_base | Decimal | Valor base utilizado para o cálculo da comissão. |
| percentual_comissao | Decimal | Percentual aplicado no cálculo da comissão. |
| valor_comissao | Decimal | Valor final da comissão a ser paga. |
| observacao | String: 1000 | Campo livre para informações adicionais sobre a comissão. |
| excluido | Boolean | Indica se a comissão está excluída. |
| ultima_alteracao | DateTime | Data e hora da última modificação desta comissão no Mercos. |
Parâmetros do JSON de envio de Comissão (POST)
Os campos obrigatórios são: status, colaborador_id, data_competencia e valor_comissao.
| Campo | Tipo | Descrição |
|---|---|---|
| codigo_comissao_integracao | String: 60 | Código da comissão no sistema que está integrando ao Mercos. Quando informado, deve ser único por empresa. |
| status (obrigatório) | Integer | 0 = prevista, 1 = confirmada, 2 = paga, 3 = cancelada. |
| colaborador_id (obrigatório) | Integer | Identificador único do colaborador. |
| pedido_id | Integer | Identificador do pedido vinculado. |
| representada_id | Integer | Identificador da representada vinculada. |
| cliente_id | Integer | Identificador do cliente vinculado. |
| data_competencia (obrigatório) | String: 10 | Data/período ao qual a comissão se refere. Formato "yyyy-mm-dd". |
| data_pagamento | String: 10 | Data em que a comissão foi ou será paga. Formato "yyyy-mm-dd". |
| valor_bruto_pedido | Decimal | Valor total do pedido sem os descontos. |
| valor_descontos | Decimal | Impostos e outras despesas abatidos do valor base para cálculo da comissão. |
| valor_base | Decimal | Valor base utilizado para o cálculo da comissão. |
| percentual_comissao | Decimal | Percentual aplicado no cálculo da comissão. |
| valor_comissao (obrigatório) | Decimal | Valor final da comissão a ser paga. |
| observacao | String: 1000 | Campo livre para informações adicionais sobre a comissão. |
Todos os campos de valor aceitam valores negativos e zerados (0,00), permitindo o envio de estornos e ajustes.