Skip to navigation

Listar itens da oportunidade

Lista as linhas de itens de uma oportunidade.

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

data contém o objeto de itens da proposta; data.items contém suas linhas. Use o ID da linha retornada em itemId nas operações de edição e remoção.

Parâmetros de caminho

CampoTipoObrigatórioDescrição
idintegerSimID da oportunidade.

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
404BUDGET_NOT_FOUNDBudget not found.

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.

Response

200 — Sucesso — exemplo ilustrativo

dataobjectOptional

Errors

404
Not Found Error