Incluir ou excluir item do total

View as Markdown
Define se uma linha participa do total da oportunidade. **Autenticação:** Bearer Token da API WBudget. O acesso aos dados respeita as permissões do usuário. A linha permanece na proposta. Retorna o objeto de itens atualizado. ### Parâmetros de caminho | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `id` | integer | Sim | ID da oportunidade. | | `itemId` | integer | Sim | ID da linha da oportunidade. | ### Corpo da requisição | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `status` | integer | Não | 1 inclui no total (padrão); 0 exclui do total. | ### Exemplo de JSON enviado ```json { "status": 0 } ``` ### Resposta HTTP **200**. Os exemplos usam dados fictícios e mostram os campos principais; outros campos podem acompanhar a resposta. Campos sem valor podem ser nulos. Campos principais de `data`: | Campo | Tipo | Descrição | |---|---|---| | `items` | array<object> | Linhas da proposta. | | `items[].id` | integer | ID da linha usado em itemId. | | `items[].item` | integer | ID do produto ou serviço. | | `items[].name` | string | Nome do produto ou serviço. | | `items[].qty` | number | Quantidade. | | `items[].value` | number | Preço unitário. | | `items[].discount` | number | Desconto monetário da linha. | | `items[].total_value` | number | Valor total da linha. | | `items[].include` | integer | 1 inclui a linha no total. | | `items[].active` | integer | 1 indica linha ativa. | | `items[].item_type` | string | Tipo, como product ou service. | | `items[].item_unit` | string | Unidade do item. | | `items[].description` | string | Descrição; pode conter texto formatado serializado em JSON. | | `items[].metadata` | object ou array | Campos personalizados. | | `items_active_value` | number | Soma dos valores das linhas ativas incluídas no total. | | `items_total_time` | number | Soma de horas dos serviços com unidade hour. | ```json { "data": { "items": [ { "id": 5001, "item": 501, "name": "Implantação", "qty": 2, "value": 100, "discount": 10, "total_value": 190, "active": 1, "include": 0, "item_type": "service", "item_unit": "un", "description": null, "metadata": [] } ], "items_active_value": 0, "items_total_time": 0 } } ``` ### Erros específicos | HTTP | Código | Situação | |---|---|---| | 400 | `BUDGET_ITEM_INCLUDE_FAILED` | Não foi possível alterar a inclusão do item. | Consulte a introdução da collection para o formato de erros e a configuração das variáveis.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired
ID da oportunidade.
itemIdstringRequired
ID da linha da oportunidade.

Request

This endpoint expects an object.
statusintegerRequired

Response

OK
dataobject

Errors

400
Bad Request Error