Skip to main content
PUT
Update a sale

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Tenant
number
required

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Path Parameters

id
integer
required

The sale identifier

Body

application/json
customer_id
integer

Filter by customer ID.

appointment_id
integer | null

The appointment ID.

currency_id
integer

Filter by currency ID.

exchange_rate
number

Currency exchange rate.

Required range: x >= 0
status
enum<string>

Filter by status.

Available options:
draft,
completed,
cancelled,
invoiced,
pending
user_id
integer | null

Filter by user ID.

notes
string | null

Internal notes.

Maximum string length: 65535
items
object[]

List of items.

Minimum array length: 1

Response

success
string
required
data
SaleResource · object
required