Skip to navigation

Editar item da oportunidade

Edita uma linha de item da oportunidade.

Autenticação: Bearer Token da API WBudget. O acesso aos dados respeita as permissões do usuário.

Esta operação substitui os dados da linha: envie todos os valores que deseja manter, obtidos na listagem de itens. itemId identifica a linha da oportunidade; item identifica o produto ou serviço. 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
itemintegerNãoID do produto ou serviço vinculado à linha.
qtynumberNãoQuantidade; padrão 1.
valuenumberNãoPreço unitário; padrão 0.
descriptionstringNãoDescrição; padrão vazio.
orderintegerNãoOrdem da linha; padrão 0.
discountnumberNãoDesconto monetário da linha, não percentual. Ex.: qty=2, value=100 e discount=10 resultam em 190 antes de outros ajustes comerciais.
groupstringNãoGrupo da linha.
titlestringNãoTítulo da linha.
costnumberNãoCusto, conforme permissões.
taxnumberNãoTributo conforme a configuração comercial.
metadataobjectNãoCampos personalizados da linha.
changed_colsstringNãoCampos alterados, separados por vírgula; padrão value,qty,discount.

Exemplo de JSON enviado

{
"item": 501,
"qty": 2,
"value": 100,
"description": "Serviço de implantação",
"order": 1,
"discount": 10,
"group": "Serviços",
"title": "Implantação",
"cost": 0,
"tax": 0,
"metadata": {},
"changed_cols": "value,qty,discount"
}

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": 1,
"item_type": "service",
"item_unit": "un",
"description": null,
"metadata": []
}
],
"items_active_value": 190,
"items_total_time": 0
}
}

Erros específicos

HTTPCódigoSituação
400BUDGET_ITEM_SET_FAILEDNão foi possível atualizar o 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.
changed_colsstringOptional
costdoubleOptional
descriptionstringOptional
discountdoubleOptional
groupstringOptional
itemdoubleOptional
metadataobjectOptional
orderdoubleOptional
qtydoubleOptional
taxdoubleOptional
titlestringOptional
valuedoubleOptional

Response

200 — Sucesso — exemplo ilustrativo

dataobjectOptional

Errors

400
Bad Request Error