Skip to navigation

Incluir ou excluir item do total

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

CampoTipoObrigatórioDescrição
idintegerSimID da oportunidade.
itemIdintegerSimID da linha da oportunidade.

Corpo da requisição

CampoTipoObrigatórioDescrição
statusintegerNão1 inclui no total (padrão); 0 exclui do total.

Exemplo de JSON enviado

{
"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:

CampoTipoDescrição
itemsarray<object>Linhas da proposta.
items[].idintegerID da linha usado em itemId.
items[].itemintegerID do produto ou serviço.
items[].namestringNome do produto ou serviço.
items[].qtynumberQuantidade.
items[].valuenumberPreço unitário.
items[].discountnumberDesconto monetário da linha.
items[].total_valuenumberValor total da linha.
items[].includeinteger1 inclui a linha no total.
items[].activeinteger1 indica linha ativa.
items[].item_typestringTipo, como product ou service.
items[].item_unitstringUnidade do item.
items[].descriptionstringDescrição; pode conter texto formatado serializado em JSON.
items[].metadataobject ou arrayCampos personalizados.
items_active_valuenumberSoma dos valores das linhas ativas incluídas no total.
items_total_timenumberSoma de horas dos serviços com unidade hour.
{
"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

HTTPCódigoSituação
400BUDGET_ITEM_INCLUDE_FAILEDNã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.
statusdoubleOptional

Response

200 — Sucesso — exemplo ilustrativo

dataobjectOptional

Errors

400
Bad Request Error