Lock Invoice
This API locks an invoice to prevent any further edits or modifications after the invoice receipt has been printed or emailed. Once an invoice is locked, invoice items or details cannot be modified.
Before you begin
- You need a valid API key or access token. See Set up API authentication.
Permission: Manage API Keys (on the Administrator security object) — Required to access Zenoti APIs.
Endpoint
PUT /{base_url}/v1/invoices/{invoice_id}/lock
Base URL: https://api.zenoti.com
Request
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | bearer {{access_token}} |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | Yes | Unique identifier of the invoice to be locked. |
Response
Success (200 OK)
{
"error": {}
}
Response fields
| Field | Type | Description |
|---|---|---|
| error | object |
Example
curl --request PUT \
--url 'https://api.zenoti.com/{base_url}/v1/invoices/{invoice_id}/lock' \
--header 'Authorization: bearer {{access_token}}'
const response = await fetch('https://api.zenoti.com/{base_url}/v1/invoices/{invoice_id}/lock', {
method: 'PUT',
headers: {
'Authorization': 'bearer {{access_token}}'
},
});
const data = await response.json();
import requests
response = requests.put(
'https://api.zenoti.com/{base_url}/v1/invoices/{invoice_id}/lock',
headers={
'Authorization': 'bearer {{access_token}}',
},
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var response = await client.PutAsync(
"https://api.zenoti.com/{base_url}/v1/invoices/{invoice_id}/lock");
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'
uri = URI('https://api.zenoti.com/{base_url}/v1/invoices/{invoice_id}/lock')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Put.new(uri)
request['Authorization'] = 'bearer {{access_token}}'
response = http.request(request)
data = JSON.parse(response.body)
Error codes
| Status | Description |
|---|---|
| 400 | 400 |
| 401 | Unauthorized -- invalid or expired access token |
| 429 | Too many requests -- rate limit exceeded |