Pular para o conteúdo principal

Criar um orçamento

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

Cria um orçamento com os itens.

Requer os headers X-Api-Key, User-Agent e Content-Type: application/json. Limite: 1 requisição por segundo (saiba mais).

Requisição​

Headers

User-Agentstringobrigatório

Identificação da sua aplicação.

Exemplo: MinhaIntegracao/1.0.

Corpo da requisição

JSON, enviado com o header Content-Type: application/json.

identifierstringobrigatório

Número do orçamento. Deve ser único na conta.

namestringobrigatório

Nome do orçamento.

Até 150 caracteres.

descriptionstring

Até 2000 caracteres.

additionalInformationstring

Informações adicionais exibidas ao cliente.

Até 2000 caracteres.Aceita: null.

statusstringobrigatório

Situação do orçamento.

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

archivedbooleanobrigatório
currencySymbolstring

Símbolo da moeda: $, US$, USD$, R$, €, £, CLP$, Q, MX$, L, B/., Bs, Gs, S/, RD$, COP$, C$, Kz, AR$ ou UY$.

Até 10 caracteres.Aceita: null.

subtotalnumberobrigatório
totalnumberobrigatório
discountobject
Campos de discount
typenumber ou stringobrigatório

percentage (ou 0) ou value (ou 1).

valuenumberobrigatório
totalnumberobrigatório
customerobjectobrigatório
Campos de customer
idstringobrigatório

Identificador do cliente.

locationobject

Localização do cliente, que precisa ser dele e não estar arquivada.

Campos de location
idstringobrigatório
orderobject

Ordem de serviço vinculada.

Campos de order
idstringobrigatório
expiredAtstringobrigatório

Data de validade.

refusedAtstring

Data de recusa (ISO 8601), que não pode ser futura.

Aceita: null.

approvedAtstring

Aceita: null.

approvedBystring

Aceita: null.

createdBystring

Aceita: null.

approvedSignaturestring

Aceita: null.

itemslista de objetosobrigatório

Itens do orçamento. Na atualização, a lista enviada substitui a atual.

Campos de items
idstring

Identificador do item, para atualizá-lo.

Aceita: null.

quantitynumberobrigatório
totalnumberobrigatório
descriptionstring

Aceita: null.

positionnumberobrigatório
productServiceobjectobrigatório
Campos de productService
idstringobrigatório

Identificador do produto ou serviço.

valuenumberobrigatório

Valor unitário.

typestring

Aceita: null.

Respostas

  • 201

    Orçamento criado.

  • 401

    Chave de API ausente (Missing API Key) ou inválida (Invalid API Key). Ver Autenticação.

  • 403

    Conta bloqueada (Account blocked), expirada (Account expired) ou com plano que não permite integração (Account plan not allowed). Ver Autenticação.

  • 422

    Corpo inválido (resourceValidationErr): campo obrigatório ausente, número já usado (reason: already exists), cliente, ordem, localização ou produto/serviço não encontrados, ou localização arquivada ou de outro cliente.

  • 429

    Limite de 1 requisição por segundo excedido. Ver Limite de requisições.

  • 500

    Erro inesperado no servidor.