Retrieve open invoices

GET https://api.zenoti.com/{base_url}/v1/centers/{center_id}/invoices

This API searches invoices by invoice number or guest user ID, or retrieves all open invoices for a given date.

Before you begin

Permission: Manage API Keys (on the Administrator security object) — Required to access Zenoti APIs.

Endpoint

GET /{base_url}/v1/centers/{center_id}/invoices

Base URL: https://api.zenoti.com

Request

Headers

Header Required Description
Authorization Yes bearer {{access_token}}

Path parameters

Parameter Type Required Description
center-id string Yes Unique identifier of the center.

Query parameters

Parameter Type Required Default Description
date string No — The date to scope the request to. Format: YYYY-MM-DD.
search_type integer (int32) No — Search mode. 0 = Invoice Number, 1 = User ID. If omitted or null, returns all open invoices for the given date.
search_value string No — The value to search for. Required when search_type is set. Must be a valid GUID when search_type=1.

Response

Success (200 OK)

{
  "todays_invoices": {},
  "invoices": [
    {
      "...": "..."
    }
  ]
}

Response fields

Field Type Description
todays_invoices object
invoices object[]
invoices[].name string
invoices[].items string
invoices[].sale_date string
invoices[].appointment_date string
invoices[].start_time string
invoices[].price integer
invoices[].discount integer
invoices[].redemptions integer
invoices[].final_price integer
invoices[].final_price_tax integer
invoices[].taxes integer
invoices[].rounding_adjustment integer
invoices[].mobile_phone string
invoices[].email object
invoices[].invoice_id string
invoices[].receive_email boolean
invoices[].SSG_amount integer
invoices[].unassigned_tip integer
invoices[].app_group_id string
invoices[].user_id string
invoices[].therapist_name object
invoices[].end_time object
invoices[].preferred_pronoun object
invoices[].invoice_no string

Example

curl --request GET \
  --url 'https://api.zenoti.com/{base_url}/v1/centers/{center_id}/invoices' \
  --header 'Authorization: bearer {{access_token}}'
const response = await fetch('https://api.zenoti.com/{base_url}/v1/centers/{center_id}/invoices', {
  method: 'GET',
  headers: {
    'Authorization': 'bearer {{access_token}}'
  },
});
const data = await response.json();
import requests

response = requests.get(
    'https://api.zenoti.com/{base_url}/v1/centers/{center_id}/invoices',
    headers={
        'Authorization': 'bearer {{access_token}}',
    },
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var response = await client.GetAsync(
    "https://api.zenoti.com/{base_url}/v1/centers/{center_id}/invoices");
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'

uri = URI('https://api.zenoti.com/{base_url}/v1/centers/{center_id}/invoices')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.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