Pular para o conteúdo principal

Propostas

Propostas ligadas a um negócio e os itens de cada proposta.

Propostas​

Recurso do plano: Propostas, Negócios ou Ordens de Serviço.

MétodoRotaO que faz
GET/external/v1/quotesLista com paginação
GET/external/v1/quotes/:idBusca um registro pelo ID
POST/external/v1/quotesCria um registro
PUT/external/v1/quotes/:idAtualiza um registro

Listar​

Aceita page, limit e relations, como descrito em Paginação e filtros.

Exemplo com filtro (o valor de relations vai codificado para URL; aqui ele aparece legível: {"where":{"dealId":"ID_DO_NEGOCIO"}}):

curl -G "https://erp-api.ideros.api.br/external/v1/quotes" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN" \
--data-urlencode "page=1" \
--data-urlencode "limit=25" \
--data-urlencode 'relations={"where":{"dealId":"ID_DO_NEGOCIO"}}'

Buscar por ID​

curl "https://erp-api.ideros.api.br/external/v1/quotes/ID_DO_REGISTRO" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN"

Devolve o registro. Se o ID não existir ou for de outra empresa, a resposta é 200 com corpo {} (objeto vazio).

Criar​

Responde 201 com o registro criado.

CampoTipoObrigatórioDescrição
dealIdstringSimID de negócio.
validUntilstring (data ISO 8601)NãoData de validade da proposta.
notesstringNãoNotas detalhadas sobre a proposta.
totalAmountnumberSimValor total da proposta.
fileUrlstringNãoLink para o PDF gerado da proposta.

Atualizar​

Envie no corpo só os campos que mudam, com os mesmos nomes da tabela de criação. Responde 200 com o registro atualizado. Registro de outra empresa responde 403; registro inexistente, 404.

Itens da proposta​

Recurso do plano: Propostas.

MétodoRotaO que faz
GET/external/v1/quote-itemsLista com paginação
GET/external/v1/quote-items/:idBusca um registro pelo ID
POST/external/v1/quote-itemsCria um registro
PUT/external/v1/quote-items/:idAtualiza um registro

Listar​

Aceita page, limit e relations, como descrito em Paginação e filtros.

Exemplo com filtro (o valor de relations vai codificado para URL; aqui ele aparece legível: {"where":{"quoteId":"ID_DA_PROPOSTA"}}):

curl -G "https://erp-api.ideros.api.br/external/v1/quote-items" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN" \
--data-urlencode "page=1" \
--data-urlencode "limit=25" \
--data-urlencode 'relations={"where":{"quoteId":"ID_DA_PROPOSTA"}}'

Buscar por ID​

curl "https://erp-api.ideros.api.br/external/v1/quote-items/ID_DO_REGISTRO" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN"

Devolve o registro. Se o ID não existir ou for de outra empresa, a resposta é 200 com corpo {} (objeto vazio).

Criar​

Responde 201 com o registro criado.

CampoTipoObrigatórioDescrição
quoteIdstringSimID de proposta.
titlestringSimTítulo do item da proposta.
descriptionstringNãoDescrição detalhada do item.
itemTypeenumNãoTipo do item (Produto, Serviço, Mão de obra, Outros). Snapshot da proposta. Valores: LABOR, SERVICE, PARTS, OTHERS.
billingModeenumNãoModo de cobrança do item na proposta (ONE_SHOT, RECURRING, MEASURED). Valores: ONE_SHOT, RECURRING, MEASURED.
valueTypeenumNãoFormato do preço (AMOUNT ou PERCENTAGE). Valores: PERCENTAGE, AMOUNT.
quantityOfItemnumberSimQuantidade de itens.
originalUnitPricenumberNãoPreço unitário cheio/base (para exibir desconto ou base de percentual).
unitPricenumberSimPreço unitário do item.
discountRatenumberNãoTaxa de desconto percentual aplicada.
totalContractTimeInMonthsnumberNãoDuração do contrato em meses (quando aplicável).
monthlyInstallmentPricenumberNãoValor da parcela/mensalidade do item.
installmentsCountnumberNãoQuantidade de parcelas (ONE_SHOT parcelado).
totalPricenumberSimPreço total do item.
detailItemobjectNãoObjeto JSON livre.
sortOrdernumberNãoOrdem de exibição do item na proposta.
quoteGroupIdstringNãoID do grupo (QuoteGroup) ao qual o item pertence. Nulo = item solto.

Atualizar​

Envie no corpo só os campos que mudam, com os mesmos nomes da tabela de criação. Responde 200 com o registro atualizado. Registro de outra empresa responde 403; registro inexistente, 404.

Ainda com dúvida?

A nossa equipe ajuda você a configurar e usar esse recurso.