PUT
/
api
/
sale-estimates
/
{id}

Headers

​
Authorization
string
required

Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Path Parameters

​
id
number
required

The sale estimate id

Body

application/json
​
customerId
number
required

The id of the customer

Example:

1

​
estimateDate
string<date-time>
required

The date of the estimate

Example:

"2021-01-01"

​
expirationDate
string<date-time>
required

The expiration date of the estimate

Example:

"2021-01-01"

​
reference
string
required

The reference of the estimate

Example:

"123456"

​
exchangeRate
number
required

The exchange rate of the estimate

Example:

1

​
warehouseId
number
required

The id of the warehouse

Example:

1

​
branchId
number
required

The id of the branch

Example:

1

​
entries
string[]
required

The entries of the estimate

Example:
[
  {
    "index": 1,
    "itemId": 1,
    "description": "This is a description",
    "quantity": 100,
    "cost": 100
  }
]
​
note
string
required

The note of the estimate

Example:

"This is a note"

​
termsConditions
string
required

The terms and conditions of the estimate

Example:

"This is a terms and conditions"

​
sendToEmail
string
required

The email to send the estimate to

Example:

"[email protected]"

​
pdfTemplateId
number
required

The attachments of the estimate

Example:
[{ "key": "123456" }]
​
discount
number
required

The discount of the estimate

Example:

1

​
discountType
string
required

The type of the discount

Example:

"amount"

​
adjustment
number
required

The adjustment of the estimate

Example:

1

Response

Sale estimate edited successfully