Create a quotation

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

Creates a quotation with its items.

Requires the X-Api-Key, User-Agent and Content-Type: application/json headers. Limit: 1 request per second (learn more).

Request

Headers

User-Agentstringrequired

Identification of your application.

Example: MinhaIntegracao/1.0.

Request body

JSON, sent with the Content-Type: application/json header.

identifierstringrequired

Quotation number. Must be unique in the account.

namestringrequired

Quotation name.

Up to 150 characters.

descriptionstring

Up to 2000 characters.

additionalInformationstring

Additional information shown to the customer.

Up to 2000 characters.Accepts: null.

statusstringrequired

Quotation status.

Accepted values: pending, approved, refused, expired, canceled.

archivedbooleanrequired

currencySymbolstring

Currency symbol: $, US$, USD$, R$, €, £, CLP$, Q, MX$, L, B/., Bs, Gs, S/, RD$, COP$, C$, Kz, AR$ or UY$.

Up to 10 characters.Accepts: null.

subtotalnumberrequired

totalnumberrequired

discountobject

Fields of discount

typenumber or stringrequired

percentage (or 0) or value (or 1).

valuenumberrequired

totalnumberrequired

customerobjectrequired

Fields of customer

idstringrequired

Customer identifier.

locationobject

Customer location, which must belong to the customer and not be archived.

Fields of location

idstringrequired

orderobject

Linked work order.

Fields of order

idstringrequired

expiredAtstringrequired

Expiration date.

refusedAtstring

Decline date (ISO 8601), which cannot be in the future.

Accepts: null.

approvedAtstring

Accepts: null.

approvedBystring

Accepts: null.

createdBystring

Accepts: null.

approvedSignaturestring

Accepts: null.

itemslist of objectsrequired

Quotation items. On update, the list sent replaces the current one.

Fields of items

idstring

Item identifier, to update it.

Accepts: null.

quantitynumberrequired

totalnumberrequired

descriptionstring

Accepts: null.

positionnumberrequired

productServiceobjectrequired

Fields of productService

idstringrequired

Product or service identifier.

valuenumberrequired

Unit price.

typestring

Accepts: null.

Responses

• 201

  Quotation created.

• 401

  API key missing (Missing API Key) or invalid (Invalid API Key). See Authentication.

• 403

  Account blocked (Account blocked), expired (Account expired) or on a plan that does not allow integration (Account plan not allowed). See Authentication.

• 422

  Invalid body (resourceValidationErr): required field missing, number already used (reason: already exists), customer, order, location or product/service not found, or location archived or from another customer.

• 429

  Limit of 1 request per second exceeded. See Rate limit.

• 500

  Unexpected server error.