A entidade Faturamento de Pedido permite registrar o faturamento de um pedido, o que também gera a comissão correspondente aos vendedores vinculados.
Observações:
- Para cancelar um faturamento, utilize o método
PUTe envie o campoexcluido = trueno corpo da requisição.
Parâmetros de Envio (POST / PUT)
| Campo | Tipo | Descrição |
|---|---|---|
| pedido_id (obrigatório) | Integer | ID do pedido faturado. Este deve ser o ID cadastrado no Mercos, e não o ID do seu sistema. |
| valor_faturado (obrigatório) | Decimal: 9 dígitos, 2 casas decimais | Valor faturado do pedido, com duas casas decimais. |
| data_faturamento (obrigatório) | String: "AAAA-MM-DD" | Data em que o faturamento foi realizado. |
| numero_nf | String: 500 | Número da nota fiscal referente ao faturamento. |
| informacoes_adicionais | String | Campo livre para observações ou informações complementares sobre o faturamento. |
| itens_faturados | List | Lista de produtos e quantidades faturadas neste faturamento, conforme estrutura definida na seção Itens faturados. Opcional: quando não informado, o faturamento é registrado apenas pelo valor. |
O campo
itens_faturadosestá disponível apenas para os planos Performance e Enterprise. Nas demais contas,
enviá-lo responde412e o faturamento não é registrado.
Itens faturados (campo itens_faturados)
itens_faturados)Cada objeto da lista informa quanto de um produto do pedido foi faturado neste faturamento. Quando um pedido possui
faturamentos com itens, o Mercos passa a acompanhar a quantidade faturada por produto e a calcular o
status_faturamento do pedido por quantidade, e não mais pelo valor.
| Campo | Tipo | Descrição |
|---|---|---|
| produto_id (obrigatório) | Integer | ID do produto no Mercos. O produto precisa pertencer ao pedido informado em pedido_id. |
| quantidade (obrigatório) | Decimal: 4 casas decimais | Quantidade do produto faturada neste faturamento. Deve ser maior que zero. |
Observações:
- Se o mesmo produto for adicionado duas vezes no mesmo pedido, a quantidade faturada é vinculada ao primeiro produto adicionado.
- Se o mesmo
produto_idfor enviado mais de uma vez na listaitens_faturados, as quantidades são somadas.- Quantidades de faturamentos diferentes do mesmo pedido são acumuladas por produto.
- Chaves além de
produto_idequantidadesão ignoradas.
Alteração dos itens (PUT)
No PUT, a lista itens_faturados é aplicada de forma incremental sobre os itens já registrados no faturamento:
- Produto já presente no faturamento: a quantidade é substituída pela enviada.
- Produto ainda não presente: o item é adicionado ao faturamento.
- Produtos não enviados na lista são mantidos como estão. Não informar
itens_faturadosmantém todos os itens.
Não é possível remover um único item pelo PUT. Para desfazer os itens, cancele o faturamento com excluido = true
e registre um novo faturamento: o cancelamento também exclui os itens e recalcula o status do pedido.
Status de faturamento do pedido
Quando o pedido possui ao menos um faturamento ativo com itens, o status_faturamento (consultado em
Pedidos) é calculado comparando a quantidade de cada produto do pedido com a quantidade
acumulada faturada. O valor_faturado deixa de influenciar o status.
| Situação dos produtos do pedido | status_faturamento |
|---|---|
| Nenhum produto com quantidade faturada | 0 = Não faturado |
| Ao menos um produto com quantidade faturada menor que a do pedido | 1 = Parcialmente faturado |
| Todos os produtos com quantidade faturada igual ou maior que a do pedido | 2 = Faturado |
Pedidos sem faturamentos com itens continuam com o cálculo por valor faturado.
Erros (412)
Erros relacionados aos itens são devolvidos com campo = "itens_faturados":
| Mensagem | Quando ocorre |
|---|---|
| O faturamento por item está disponível apenas para os planos Performance e Enterprise. | O plano da conta não contempla o recurso. |
| A lista de itens faturados é inválida. Cada item deve informar produto_id (inteiro) e quantidade (maior que zero). | Algum objeto da lista está sem produto_id, sem quantidade ou com quantidade zero/negativa. |
| Um ou mais produtos informados em itens_faturados não pertencem ao pedido. | Algum produto_id não está entre os itens ativos do pedido. |