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étodo | Rota | O que faz |
|---|---|---|
GET | /external/v1/quotes | Lista com paginação |
GET | /external/v1/quotes/:id | Busca um registro pelo ID |
POST | /external/v1/quotes | Cria um registro |
PUT | /external/v1/quotes/:id | Atualiza 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.
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
dealId | string | Sim | ID de negócio. |
validUntil | string (data ISO 8601) | Não | Data de validade da proposta. |
notes | string | Não | Notas detalhadas sobre a proposta. |
totalAmount | number | Sim | Valor total da proposta. |
fileUrl | string | Não | Link 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étodo | Rota | O que faz |
|---|---|---|
GET | /external/v1/quote-items | Lista com paginação |
GET | /external/v1/quote-items/:id | Busca um registro pelo ID |
POST | /external/v1/quote-items | Cria um registro |
PUT | /external/v1/quote-items/:id | Atualiza 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.
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
quoteId | string | Sim | ID de proposta. |
title | string | Sim | Título do item da proposta. |
description | string | Não | Descrição detalhada do item. |
itemType | enum | Não | Tipo do item (Produto, Serviço, Mão de obra, Outros). Snapshot da proposta. Valores: LABOR, SERVICE, PARTS, OTHERS. |
billingMode | enum | Não | Modo de cobrança do item na proposta (ONE_SHOT, RECURRING, MEASURED). Valores: ONE_SHOT, RECURRING, MEASURED. |
valueType | enum | Não | Formato do preço (AMOUNT ou PERCENTAGE). Valores: PERCENTAGE, AMOUNT. |
quantityOfItem | number | Sim | Quantidade de itens. |
originalUnitPrice | number | Não | Preço unitário cheio/base (para exibir desconto ou base de percentual). |
unitPrice | number | Sim | Preço unitário do item. |
discountRate | number | Não | Taxa de desconto percentual aplicada. |
totalContractTimeInMonths | number | Não | Duração do contrato em meses (quando aplicável). |
monthlyInstallmentPrice | number | Não | Valor da parcela/mensalidade do item. |
installmentsCount | number | Não | Quantidade de parcelas (ONE_SHOT parcelado). |
totalPrice | number | Sim | Preço total do item. |
detailItem | object | Não | Objeto JSON livre. |
sortOrder | number | Não | Ordem de exibição do item na proposta. |
quoteGroupId | string | Não | ID 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.
A nossa equipe ajuda você a configurar e usar esse recurso.