Saltar al contenido principal

Crear un presupuesto

POSThttps://carchost.fieldcontrol.com.br/quotations

Crea un presupuesto con los ítems.

Requiere los headers X-Api-Key, User-Agent y Content-Type: application/json. Límite: 1 solicitud por segundo (más información).

Solicitud​

Headers

User-Agentstringobligatorio

Identificación de su aplicación.

Ejemplo: MinhaIntegracao/1.0.

Cuerpo de la solicitud

JSON, enviado con el header Content-Type: application/json.

identifierstringobligatorio

Número del presupuesto. Debe ser único en la cuenta.

namestringobligatorio

Nombre del presupuesto.

Hasta 150 caracteres.

descriptionstring

Hasta 2000 caracteres.

additionalInformationstring

Información adicional que se muestra al cliente.

Hasta 2000 caracteres.Acepta: null.

statusstringobligatorio

Situación del presupuesto.

Valores aceptados: pending, approved, refused, expired, canceled.

archivedbooleanobligatorio
currencySymbolstring

Símbolo de la moneda: $, US$, USD$, R$, €, £, CLP$, Q, MX$, L, B/., Bs, Gs, S/, RD$, COP$, C$, Kz, AR$ o UY$.

Hasta 10 caracteres.Acepta: null.

subtotalnumberobligatorio
totalnumberobligatorio
discountobject
Campos de discount
typenumber o stringobligatorio

percentage (o 0) o value (o 1).

valuenumberobligatorio
totalnumberobligatorio
customerobjectobligatorio
Campos de customer
idstringobligatorio

Identificador del cliente.

locationobject

Ubicación del cliente, que debe ser suya y no estar archivada.

Campos de location
idstringobligatorio
orderobject

Orden de servicio vinculada.

Campos de order
idstringobligatorio
expiredAtstringobligatorio

Fecha de validez.

refusedAtstring

Fecha de rechazo (ISO 8601), que no puede ser futura.

Acepta: null.

approvedAtstring

Acepta: null.

approvedBystring

Acepta: null.

createdBystring

Acepta: null.

approvedSignaturestring

Acepta: null.

itemslista de objetosobligatorio

Ítems del presupuesto. En la actualización, la lista enviada reemplaza la actual.

Campos de items
idstring

Identificador del ítem, para actualizarlo.

Acepta: null.

quantitynumberobligatorio
totalnumberobligatorio
descriptionstring

Acepta: null.

positionnumberobligatorio
productServiceobjectobligatorio
Campos de productService
idstringobligatorio

Identificador del producto o servicio.

valuenumberobligatorio

Valor unitario.

typestring

Acepta: null.

Respuestas

  • 201

    Presupuesto creado.

  • 401

    Clave de API ausente (Missing API Key) o inválida (Invalid API Key). Consulte Autenticación.

  • 403

    Cuenta bloqueada (Account blocked), vencida (Account expired) o con un plan que no permite integración (Account plan not allowed). Consulte Autenticación.

  • 422

    Cuerpo inválido (resourceValidationErr): campo obligatorio ausente, número ya usado (reason: already exists), cliente, orden, ubicación o producto/servicio no encontrados, o ubicación archivada o de otro cliente.

  • 429

    Se superó el límite de 1 solicitud por segundo. Consulte Límite de solicitudes.

  • 500

    Error inesperado en el servidor.