List Invoices
curl --request GET \
--url https://api.zivio.net/api/v4/invoices \
--header 'Authorization: Bearer <token>' \
--header 'zivio-tenant-id: <api-key>'import requests
url = "https://api.zivio.net/api/v4/invoices"
headers = {
"Authorization": "Bearer <token>",
"zivio-tenant-id": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'zivio-tenant-id': '<api-key>'}
};
fetch('https://api.zivio.net/api/v4/invoices', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zivio.net/api/v4/invoices",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"zivio-tenant-id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.zivio.net/api/v4/invoices"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("zivio-tenant-id", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zivio.net/api/v4/invoices")
.header("Authorization", "Bearer <token>")
.header("zivio-tenant-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zivio.net/api/v4/invoices")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["zivio-tenant-id"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"invoices": [
{
"id": 101,
"external_id": "EXT-1001",
"external_provider": "Example external_provider",
"description": "Complete redesign of corporate website with modern UX",
"status": "unpaid",
"project_summary": "Website Redesign Project - Complete redesign of corporate website with modern UX",
"vatable": true,
"reference_number": "INV-20240001",
"self_bill": false,
"subtype": "standard",
"type": "credit_note",
"client": null,
"client_org": null,
"supplier": {
"id": 101,
"name": "Acme Corporation",
"email": "user1@example.com",
"vetting_status": "PASSED",
"tax_number": "Example tax_number",
"tax_registered": true
},
"milestone_id": 501,
"line_item_sheet_id": 501,
"sent_at": "2024-01-16T10:30:00+00:00",
"dated_on": "2024-01-16",
"due_on": "2024-01-16",
"client_due_on": "2024-01-16",
"payment_terms_in_days": 30,
"client_payment_terms_in_days": 30,
"paid_at": "2024-01-16T10:30:00+00:00",
"is_credit_note": false,
"credit_note_id": 501,
"credit_note_reason": null,
"manual_client_tax_type": {
"id": 101,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 101,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00"
},
"net_total": {
"cents": 150000,
"currency": "GBP"
},
"tax_total": {
"cents": 150000,
"currency": "GBP"
},
"total": {
"cents": 150000,
"currency": "GBP"
},
"cis_amount_due": {
"cents": 150000,
"currency": "GBP"
},
"cis_deductible": {
"cents": 150000,
"currency": "GBP"
},
"cis_deduction_total": {
"cents": 150000,
"currency": "GBP"
},
"cis_rate": {
"id": 101,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 101,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00"
},
"cis_contractor": null,
"cis_subcontractor": null,
"invoice_items": [
{
"id": 101,
"external_id": "EXT-1001",
"external_provider": "Example external_provider",
"invoice_id": 501,
"description": "Complete redesign of corporate website with modern UX",
"billing_start": "2024-01-16",
"billing_end": "2024-01-16",
"unit_type": "Example unit_type",
"milestone_id": 501,
"line_item_sheet_id": 501,
"unit_cost": {
"cents": 150000,
"currency": "GBP"
},
"quantity": "1500.00",
"discount": 1500,
"net_total_price": null,
"tax_total": {
"cents": 150000,
"currency": "GBP"
},
"tax_rate": "1500.00",
"total_price": null,
"cis_type": {
"id": 101,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 101,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00"
},
"tax_type": {
"id": 101,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 101,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00"
},
"manual_client_tax_type": null,
"invoice_item_taxes": [
{
"id": 101,
"invoice_item_id": 501,
"tax_type": null,
"tax_rate": "1500.00",
"tax_amount": {
"cents": 150000,
"currency": "GBP"
},
"sales_tax_amount": {
"cents": 150000,
"currency": "GBP"
},
"ccy": "GBP",
"position": 101,
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00"
},
{
"id": 102,
"invoice_item_id": 502,
"tax_type": null,
"tax_rate": "1500.00",
"tax_amount": {
"cents": 300000,
"currency": "GBP"
},
"sales_tax_amount": {
"cents": 300000,
"currency": "GBP"
},
"ccy": "GBP",
"position": 102,
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
}
],
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00",
"manual_tax_type": {
"id": 101,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 101,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00"
}
},
{
"id": 102,
"external_id": "EXT-1002",
"external_provider": "Example external_provider",
"invoice_id": 502,
"description": "Native iOS and Android application",
"billing_start": "2024-01-17",
"billing_end": "2024-01-17",
"unit_type": "Example unit_type",
"milestone_id": 502,
"line_item_sheet_id": 502,
"unit_cost": {
"cents": 300000,
"currency": "GBP"
},
"quantity": "1500.00",
"discount": 1500,
"net_total_price": null,
"tax_total": {
"cents": 300000,
"currency": "GBP"
},
"tax_rate": "1500.00",
"total_price": null,
"cis_type": {
"id": 102,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 102,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
},
"tax_type": {
"id": 102,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 102,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
},
"manual_client_tax_type": null,
"invoice_item_taxes": [
{
"id": 102,
"invoice_item_id": 502,
"tax_type": null,
"tax_rate": "1500.00",
"tax_amount": {
"cents": 300000,
"currency": "GBP"
},
"sales_tax_amount": {
"cents": 300000,
"currency": "GBP"
},
"ccy": "GBP",
"position": 102,
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
},
{
"id": 103,
"invoice_item_id": 503,
"tax_type": null,
"tax_rate": "1500.00",
"tax_amount": {
"cents": 450000,
"currency": "GBP"
},
"sales_tax_amount": {
"cents": 450000,
"currency": "GBP"
},
"ccy": "GBP",
"position": 103,
"created_at": "2024-01-18T10:30:00+00:00",
"updated_at": "2024-01-18T10:30:00+00:00"
}
],
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00",
"manual_tax_type": {
"id": 102,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 102,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
}
}
],
"approved_at": "2024-01-16T10:30:00+00:00",
"approved_by": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"level_1_approved_at": "2024-01-16T10:30:00+00:00",
"level_1_approved_by": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"rejected_at": "2024-01-16T10:30:00+00:00",
"rejected_by": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"rejected_reason": null,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00",
"project": {
"id": 101,
"title": "Website Redesign Project",
"description": "Complete redesign of corporate website with modern UX"
}
},
{
"id": 102,
"external_id": "EXT-1002",
"external_provider": "Example external_provider",
"description": "Native iOS and Android application",
"status": "paid",
"project_summary": "Website Redesign Project - Complete redesign of corporate website with modern UX",
"vatable": true,
"reference_number": "INV-20240002",
"self_bill": false,
"subtype": "standard",
"type": "all",
"client": null,
"client_org": null,
"supplier": {
"id": 102,
"name": "Global Services Ltd",
"email": "user2@example.com",
"vetting_status": "FAILED",
"tax_number": "Example tax_number",
"tax_registered": true
},
"milestone_id": 502,
"line_item_sheet_id": 502,
"sent_at": "2024-01-17T10:30:00+00:00",
"dated_on": "2024-01-17",
"due_on": "2024-01-17",
"client_due_on": "2024-01-17",
"payment_terms_in_days": 30,
"client_payment_terms_in_days": 30,
"paid_at": "2024-01-17T10:30:00+00:00",
"is_credit_note": false,
"credit_note_id": 502,
"credit_note_reason": null,
"manual_client_tax_type": {
"id": 102,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 102,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
},
"net_total": {
"cents": 300000,
"currency": "GBP"
},
"tax_total": {
"cents": 300000,
"currency": "GBP"
},
"total": {
"cents": 300000,
"currency": "GBP"
},
"cis_amount_due": {
"cents": 300000,
"currency": "GBP"
},
"cis_deductible": {
"cents": 300000,
"currency": "GBP"
},
"cis_deduction_total": {
"cents": 300000,
"currency": "GBP"
},
"cis_rate": {
"id": 102,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 102,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
},
"cis_contractor": null,
"cis_subcontractor": null,
"invoice_items": [
{
"id": 102,
"external_id": "EXT-1002",
"external_provider": "Example external_provider",
"invoice_id": 502,
"description": "Native iOS and Android application",
"billing_start": "2024-01-17",
"billing_end": "2024-01-17",
"unit_type": "Example unit_type",
"milestone_id": 502,
"line_item_sheet_id": 502,
"unit_cost": {
"cents": 300000,
"currency": "GBP"
},
"quantity": "1500.00",
"discount": 1500,
"net_total_price": null,
"tax_total": {
"cents": 300000,
"currency": "GBP"
},
"tax_rate": "1500.00",
"total_price": null,
"cis_type": {
"id": 102,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 102,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
},
"tax_type": {
"id": 102,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 102,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
},
"manual_client_tax_type": null,
"invoice_item_taxes": [
{
"id": 102,
"invoice_item_id": 502,
"tax_type": null,
"tax_rate": "1500.00",
"tax_amount": {
"cents": 300000,
"currency": "GBP"
},
"sales_tax_amount": {
"cents": 300000,
"currency": "GBP"
},
"ccy": "GBP",
"position": 102,
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
},
{
"id": 103,
"invoice_item_id": 503,
"tax_type": null,
"tax_rate": "1500.00",
"tax_amount": {
"cents": 450000,
"currency": "GBP"
},
"sales_tax_amount": {
"cents": 450000,
"currency": "GBP"
},
"ccy": "GBP",
"position": 103,
"created_at": "2024-01-18T10:30:00+00:00",
"updated_at": "2024-01-18T10:30:00+00:00"
}
],
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00",
"manual_tax_type": {
"id": 102,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 102,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
}
},
{
"id": 103,
"external_id": "EXT-1003",
"external_provider": "Example external_provider",
"invoice_id": 503,
"description": "Native iOS and Android application",
"billing_start": "2024-01-18",
"billing_end": "2024-01-18",
"unit_type": "Example unit_type",
"milestone_id": 503,
"line_item_sheet_id": 503,
"unit_cost": {
"cents": 450000,
"currency": "GBP"
},
"quantity": "1500.00",
"discount": 1500,
"net_total_price": null,
"tax_total": {
"cents": 450000,
"currency": "GBP"
},
"tax_rate": "1500.00",
"total_price": null,
"cis_type": {
"id": 103,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 103,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-18T10:30:00+00:00",
"updated_at": "2024-01-18T10:30:00+00:00"
},
"tax_type": {
"id": 103,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 103,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-18T10:30:00+00:00",
"updated_at": "2024-01-18T10:30:00+00:00"
},
"manual_client_tax_type": null,
"invoice_item_taxes": [
{
"id": 103,
"invoice_item_id": 503,
"tax_type": null,
"tax_rate": "1500.00",
"tax_amount": {
"cents": 450000,
"currency": "GBP"
},
"sales_tax_amount": {
"cents": 450000,
"currency": "GBP"
},
"ccy": "GBP",
"position": 103,
"created_at": "2024-01-18T10:30:00+00:00",
"updated_at": "2024-01-18T10:30:00+00:00"
},
{
"id": 104,
"invoice_item_id": 504,
"tax_type": null,
"tax_rate": "1500.00",
"tax_amount": {
"cents": 600000,
"currency": "GBP"
},
"sales_tax_amount": {
"cents": 600000,
"currency": "GBP"
},
"ccy": "GBP",
"position": 104,
"created_at": "2024-01-19T10:30:00+00:00",
"updated_at": "2024-01-19T10:30:00+00:00"
}
],
"created_at": "2024-01-18T10:30:00+00:00",
"updated_at": "2024-01-18T10:30:00+00:00",
"manual_tax_type": {
"id": 103,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 103,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-18T10:30:00+00:00",
"updated_at": "2024-01-18T10:30:00+00:00"
}
}
],
"approved_at": "2024-01-17T10:30:00+00:00",
"approved_by": {
"id": 102,
"first_name": "Jane",
"last_name": "Smith",
"email": "user2@example.com",
"org_id": 502,
"org_name": "Global Services Ltd"
},
"level_1_approved_at": "2024-01-17T10:30:00+00:00",
"level_1_approved_by": {
"id": 102,
"first_name": "Jane",
"last_name": "Smith",
"email": "user2@example.com",
"org_id": 502,
"org_name": "Global Services Ltd"
},
"rejected_at": "2024-01-17T10:30:00+00:00",
"rejected_by": {
"id": 102,
"first_name": "Jane",
"last_name": "Smith",
"email": "user2@example.com",
"org_id": 502,
"org_name": "Global Services Ltd"
},
"rejected_reason": null,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00",
"project": {
"id": 102,
"title": "Mobile App Development",
"description": "Native iOS and Android application"
}
}
]
}Invoices
List Invoices
Retrieve a paginated list of invoices. Use filters to narrow results.
Filtering
Use the filter[<attribute>] parameter to filter results. Multiple filters are combined with AND logic.
Basic Examples
# Equality (implicit)
GET /api/v4/invoices?filter[status]=draft
# Multiple values (implicit IN)
GET /api/v4/invoices?filter[status]=draft,paid
# With explicit operator
GET /api/v4/invoices?filter[created_at][gte]=2024-01-01
# Range query
GET /api/v4/invoices?filter[total][between]=1000000,5000000
# Multiple filters (AND)
GET /api/v4/invoices?filter[status]=draft&filter[total][gte]=1000000
Available Attributes
| Attribute | Type | Operators | Permitted Values |
|---|---|---|---|
| approved_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| approved_by_id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| cis_amount_due | money | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| cis_contractor | boolean | eq, not_eq | - |
| cis_deductible | money | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| cis_deduction_total | money | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| cis_rate_id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| cis_subcontractor | boolean | eq, not_eq | - |
| client_due_on | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| client_payment_terms_in_days | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| created_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| credit_note_id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| credit_note_reason | string | eq, not_eq, in, not_in, like, not_like | - |
| dated_on | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| description | string | eq, not_eq, in, not_in, like, not_like | - |
| due_on | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| external_id | string | eq, not_eq, in, not_in, like, not_like | - |
| external_provider | string | eq, not_eq, in, not_in, like, not_like | - |
| id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| is_credit_note | boolean | eq, not_eq | - |
| level_1_approved_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| level_1_approved_by_id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| line_item_sheet_id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| manual_client_tax_type_id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| milestone_id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| net_total | money | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| paid_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| payment_terms_in_days | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| project_id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| reference_number | string | eq, not_eq, in, not_in, like, not_like | - |
| rejected_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| rejected_by_id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| rejected_reason | string | eq, not_eq, in, not_in, like, not_like | - |
| self_bill | boolean | eq, not_eq | - |
| sent_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| status | string | eq, not_eq, in, not_in | draft, unpaid, paid, level_1_approved, approved, rejected |
| subtype | string | eq, not_eq, in, not_in, like, not_like | - |
| tax_total | money | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| total | money | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| type | string | eq | invoice, credit_note, all |
| updated_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| vatable | boolean | eq, not_eq | - |
Custom Fields
This resource supports custom field filtering using cf[key] syntax:
# Equality
GET /api/v4/invoices?cf[priority]=high
# With operator
GET /api/v4/invoices?cf[department][in]=engineering,design
# Check existence
GET /api/v4/invoices?cf[priority][exists]=
# Negation
GET /api/v4/invoices?cf[priority][not_eq]=low
OR Conditions
Use or[group] to combine filter groups with OR logic. Filters within a group are ANDed:
# Simple OR
GET /api/v4/invoices?or[1][status]=unpaid&or[2][status]=draft
# Complex OR (status=unpaid AND total>=1000000) OR (status=draft)
GET /api/v4/invoices?or[1][status]=unpaid&or[1][total][gte]=1000000&or[2][status]=draft
Sorting
Use sort[<attribute>] to order results. Default direction is ascending.
# Ascending (implicit)
GET /api/v4/invoices?sort[created_at]=
# Descending
GET /api/v4/invoices?sort[created_at]=desc
# Combined with filters
GET /api/v4/invoices?filter[status]=draft&sort[created_at]=desc
GET
/
invoices
List Invoices
curl --request GET \
--url https://api.zivio.net/api/v4/invoices \
--header 'Authorization: Bearer <token>' \
--header 'zivio-tenant-id: <api-key>'import requests
url = "https://api.zivio.net/api/v4/invoices"
headers = {
"Authorization": "Bearer <token>",
"zivio-tenant-id": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'zivio-tenant-id': '<api-key>'}
};
fetch('https://api.zivio.net/api/v4/invoices', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zivio.net/api/v4/invoices",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"zivio-tenant-id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.zivio.net/api/v4/invoices"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("zivio-tenant-id", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zivio.net/api/v4/invoices")
.header("Authorization", "Bearer <token>")
.header("zivio-tenant-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zivio.net/api/v4/invoices")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["zivio-tenant-id"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"invoices": [
{
"id": 101,
"external_id": "EXT-1001",
"external_provider": "Example external_provider",
"description": "Complete redesign of corporate website with modern UX",
"status": "unpaid",
"project_summary": "Website Redesign Project - Complete redesign of corporate website with modern UX",
"vatable": true,
"reference_number": "INV-20240001",
"self_bill": false,
"subtype": "standard",
"type": "credit_note",
"client": null,
"client_org": null,
"supplier": {
"id": 101,
"name": "Acme Corporation",
"email": "user1@example.com",
"vetting_status": "PASSED",
"tax_number": "Example tax_number",
"tax_registered": true
},
"milestone_id": 501,
"line_item_sheet_id": 501,
"sent_at": "2024-01-16T10:30:00+00:00",
"dated_on": "2024-01-16",
"due_on": "2024-01-16",
"client_due_on": "2024-01-16",
"payment_terms_in_days": 30,
"client_payment_terms_in_days": 30,
"paid_at": "2024-01-16T10:30:00+00:00",
"is_credit_note": false,
"credit_note_id": 501,
"credit_note_reason": null,
"manual_client_tax_type": {
"id": 101,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 101,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00"
},
"net_total": {
"cents": 150000,
"currency": "GBP"
},
"tax_total": {
"cents": 150000,
"currency": "GBP"
},
"total": {
"cents": 150000,
"currency": "GBP"
},
"cis_amount_due": {
"cents": 150000,
"currency": "GBP"
},
"cis_deductible": {
"cents": 150000,
"currency": "GBP"
},
"cis_deduction_total": {
"cents": 150000,
"currency": "GBP"
},
"cis_rate": {
"id": 101,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 101,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00"
},
"cis_contractor": null,
"cis_subcontractor": null,
"invoice_items": [
{
"id": 101,
"external_id": "EXT-1001",
"external_provider": "Example external_provider",
"invoice_id": 501,
"description": "Complete redesign of corporate website with modern UX",
"billing_start": "2024-01-16",
"billing_end": "2024-01-16",
"unit_type": "Example unit_type",
"milestone_id": 501,
"line_item_sheet_id": 501,
"unit_cost": {
"cents": 150000,
"currency": "GBP"
},
"quantity": "1500.00",
"discount": 1500,
"net_total_price": null,
"tax_total": {
"cents": 150000,
"currency": "GBP"
},
"tax_rate": "1500.00",
"total_price": null,
"cis_type": {
"id": 101,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 101,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00"
},
"tax_type": {
"id": 101,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 101,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00"
},
"manual_client_tax_type": null,
"invoice_item_taxes": [
{
"id": 101,
"invoice_item_id": 501,
"tax_type": null,
"tax_rate": "1500.00",
"tax_amount": {
"cents": 150000,
"currency": "GBP"
},
"sales_tax_amount": {
"cents": 150000,
"currency": "GBP"
},
"ccy": "GBP",
"position": 101,
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00"
},
{
"id": 102,
"invoice_item_id": 502,
"tax_type": null,
"tax_rate": "1500.00",
"tax_amount": {
"cents": 300000,
"currency": "GBP"
},
"sales_tax_amount": {
"cents": 300000,
"currency": "GBP"
},
"ccy": "GBP",
"position": 102,
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
}
],
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00",
"manual_tax_type": {
"id": 101,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 101,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00"
}
},
{
"id": 102,
"external_id": "EXT-1002",
"external_provider": "Example external_provider",
"invoice_id": 502,
"description": "Native iOS and Android application",
"billing_start": "2024-01-17",
"billing_end": "2024-01-17",
"unit_type": "Example unit_type",
"milestone_id": 502,
"line_item_sheet_id": 502,
"unit_cost": {
"cents": 300000,
"currency": "GBP"
},
"quantity": "1500.00",
"discount": 1500,
"net_total_price": null,
"tax_total": {
"cents": 300000,
"currency": "GBP"
},
"tax_rate": "1500.00",
"total_price": null,
"cis_type": {
"id": 102,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 102,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
},
"tax_type": {
"id": 102,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 102,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
},
"manual_client_tax_type": null,
"invoice_item_taxes": [
{
"id": 102,
"invoice_item_id": 502,
"tax_type": null,
"tax_rate": "1500.00",
"tax_amount": {
"cents": 300000,
"currency": "GBP"
},
"sales_tax_amount": {
"cents": 300000,
"currency": "GBP"
},
"ccy": "GBP",
"position": 102,
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
},
{
"id": 103,
"invoice_item_id": 503,
"tax_type": null,
"tax_rate": "1500.00",
"tax_amount": {
"cents": 450000,
"currency": "GBP"
},
"sales_tax_amount": {
"cents": 450000,
"currency": "GBP"
},
"ccy": "GBP",
"position": 103,
"created_at": "2024-01-18T10:30:00+00:00",
"updated_at": "2024-01-18T10:30:00+00:00"
}
],
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00",
"manual_tax_type": {
"id": 102,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 102,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
}
}
],
"approved_at": "2024-01-16T10:30:00+00:00",
"approved_by": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"level_1_approved_at": "2024-01-16T10:30:00+00:00",
"level_1_approved_by": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"rejected_at": "2024-01-16T10:30:00+00:00",
"rejected_by": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"rejected_reason": null,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00",
"project": {
"id": 101,
"title": "Website Redesign Project",
"description": "Complete redesign of corporate website with modern UX"
}
},
{
"id": 102,
"external_id": "EXT-1002",
"external_provider": "Example external_provider",
"description": "Native iOS and Android application",
"status": "paid",
"project_summary": "Website Redesign Project - Complete redesign of corporate website with modern UX",
"vatable": true,
"reference_number": "INV-20240002",
"self_bill": false,
"subtype": "standard",
"type": "all",
"client": null,
"client_org": null,
"supplier": {
"id": 102,
"name": "Global Services Ltd",
"email": "user2@example.com",
"vetting_status": "FAILED",
"tax_number": "Example tax_number",
"tax_registered": true
},
"milestone_id": 502,
"line_item_sheet_id": 502,
"sent_at": "2024-01-17T10:30:00+00:00",
"dated_on": "2024-01-17",
"due_on": "2024-01-17",
"client_due_on": "2024-01-17",
"payment_terms_in_days": 30,
"client_payment_terms_in_days": 30,
"paid_at": "2024-01-17T10:30:00+00:00",
"is_credit_note": false,
"credit_note_id": 502,
"credit_note_reason": null,
"manual_client_tax_type": {
"id": 102,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 102,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
},
"net_total": {
"cents": 300000,
"currency": "GBP"
},
"tax_total": {
"cents": 300000,
"currency": "GBP"
},
"total": {
"cents": 300000,
"currency": "GBP"
},
"cis_amount_due": {
"cents": 300000,
"currency": "GBP"
},
"cis_deductible": {
"cents": 300000,
"currency": "GBP"
},
"cis_deduction_total": {
"cents": 300000,
"currency": "GBP"
},
"cis_rate": {
"id": 102,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 102,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
},
"cis_contractor": null,
"cis_subcontractor": null,
"invoice_items": [
{
"id": 102,
"external_id": "EXT-1002",
"external_provider": "Example external_provider",
"invoice_id": 502,
"description": "Native iOS and Android application",
"billing_start": "2024-01-17",
"billing_end": "2024-01-17",
"unit_type": "Example unit_type",
"milestone_id": 502,
"line_item_sheet_id": 502,
"unit_cost": {
"cents": 300000,
"currency": "GBP"
},
"quantity": "1500.00",
"discount": 1500,
"net_total_price": null,
"tax_total": {
"cents": 300000,
"currency": "GBP"
},
"tax_rate": "1500.00",
"total_price": null,
"cis_type": {
"id": 102,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 102,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
},
"tax_type": {
"id": 102,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 102,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
},
"manual_client_tax_type": null,
"invoice_item_taxes": [
{
"id": 102,
"invoice_item_id": 502,
"tax_type": null,
"tax_rate": "1500.00",
"tax_amount": {
"cents": 300000,
"currency": "GBP"
},
"sales_tax_amount": {
"cents": 300000,
"currency": "GBP"
},
"ccy": "GBP",
"position": 102,
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
},
{
"id": 103,
"invoice_item_id": 503,
"tax_type": null,
"tax_rate": "1500.00",
"tax_amount": {
"cents": 450000,
"currency": "GBP"
},
"sales_tax_amount": {
"cents": 450000,
"currency": "GBP"
},
"ccy": "GBP",
"position": 103,
"created_at": "2024-01-18T10:30:00+00:00",
"updated_at": "2024-01-18T10:30:00+00:00"
}
],
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00",
"manual_tax_type": {
"id": 102,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 102,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
}
},
{
"id": 103,
"external_id": "EXT-1003",
"external_provider": "Example external_provider",
"invoice_id": 503,
"description": "Native iOS and Android application",
"billing_start": "2024-01-18",
"billing_end": "2024-01-18",
"unit_type": "Example unit_type",
"milestone_id": 503,
"line_item_sheet_id": 503,
"unit_cost": {
"cents": 450000,
"currency": "GBP"
},
"quantity": "1500.00",
"discount": 1500,
"net_total_price": null,
"tax_total": {
"cents": 450000,
"currency": "GBP"
},
"tax_rate": "1500.00",
"total_price": null,
"cis_type": {
"id": 103,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 103,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-18T10:30:00+00:00",
"updated_at": "2024-01-18T10:30:00+00:00"
},
"tax_type": {
"id": 103,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 103,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-18T10:30:00+00:00",
"updated_at": "2024-01-18T10:30:00+00:00"
},
"manual_client_tax_type": null,
"invoice_item_taxes": [
{
"id": 103,
"invoice_item_id": 503,
"tax_type": null,
"tax_rate": "1500.00",
"tax_amount": {
"cents": 450000,
"currency": "GBP"
},
"sales_tax_amount": {
"cents": 450000,
"currency": "GBP"
},
"ccy": "GBP",
"position": 103,
"created_at": "2024-01-18T10:30:00+00:00",
"updated_at": "2024-01-18T10:30:00+00:00"
},
{
"id": 104,
"invoice_item_id": 504,
"tax_type": null,
"tax_rate": "1500.00",
"tax_amount": {
"cents": 600000,
"currency": "GBP"
},
"sales_tax_amount": {
"cents": 600000,
"currency": "GBP"
},
"ccy": "GBP",
"position": 104,
"created_at": "2024-01-19T10:30:00+00:00",
"updated_at": "2024-01-19T10:30:00+00:00"
}
],
"created_at": "2024-01-18T10:30:00+00:00",
"updated_at": "2024-01-18T10:30:00+00:00",
"manual_tax_type": {
"id": 103,
"label": "Example label",
"country_code": "Example country_code",
"rate": "1500.00",
"domestic_recharge": true,
"tax_reference": 103,
"archived": true,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-18T10:30:00+00:00",
"updated_at": "2024-01-18T10:30:00+00:00"
}
}
],
"approved_at": "2024-01-17T10:30:00+00:00",
"approved_by": {
"id": 102,
"first_name": "Jane",
"last_name": "Smith",
"email": "user2@example.com",
"org_id": 502,
"org_name": "Global Services Ltd"
},
"level_1_approved_at": "2024-01-17T10:30:00+00:00",
"level_1_approved_by": {
"id": 102,
"first_name": "Jane",
"last_name": "Smith",
"email": "user2@example.com",
"org_id": 502,
"org_name": "Global Services Ltd"
},
"rejected_at": "2024-01-17T10:30:00+00:00",
"rejected_by": {
"id": 102,
"first_name": "Jane",
"last_name": "Smith",
"email": "user2@example.com",
"org_id": 502,
"org_name": "Global Services Ltd"
},
"rejected_reason": null,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
},
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00",
"project": {
"id": 102,
"title": "Mobile App Development",
"description": "Native iOS and Android application"
}
}
]
}Authorizations
OAuth 2.0 client credentials. The access token from POST /oauth/token is sent as a bearer token. Request only the scopes you need.
Your Zivio organisation identifier. The regional API endpoints serve every Zivio organisation, so each request must identify yours.
Query Parameters
Page number for pagination
Number of results per page (max 100)
Required range:
x <= 100Filterable attributes:
integer (operators: eq, not_eq, in, not_in, gt, gte, lt, lte, between): approved_by_id, cis_rate_id, client_payment_terms_in_days, credit_note_id, id, level_1_approved_by_id, line_item_sheet_id, manual_client_tax_type_id, milestone_id, payment_terms_in_days, project_id, rejected_by_id datetime (operators: eq, not_eq, gt, gte, lt, lte, between): approved_at, client_due_on, created_at, dated_on, due_on, level_1_approved_at, paid_at, rejected_at, sent_at, updated_at string (operators: eq, not_eq, in, not_in): credit_note_reason, description, external_id, external_provider, reference_number, rejected_reason, status (one of: draft = saved by supplier, not yet submitted to client; unpaid = submitted, awaiting initial approval; paid = paid by client; level_1_approved = passed first-level approval, awaiting final approval; approved = fully approved, awaiting payment; rejected = rejected by client), subtype, type (one of: invoice = all invoice types except credit notes; credit_note = credit notes only; all = every invoice type (default)) boolean (operators: eq, not_eq): cis_contractor, cis_subcontractor, is_credit_note, self_bill, vatable money (operators: eq, not_eq, in, not_in, gt, gte, lt, lte, between): cis_amount_due, cis_deductible, cis_deduction_total, net_total, tax_total, total
Note: money values are in minor currency units (e.g. pence for GBP). Use 1000000 for £10,000.00.
Note: like is a case-insensitive substring match — pass the bare term (filter[title][like]=redesign). Do not add % wildcards; they are not needed.
OR condition groups. Filters within a group are ANDed; groups are ORed.
Syntax: or[group_key][<attribute>]=value or or[group_key][<attribute>][operator]=value
Examples:
- Simple OR:
or[1][state]=draft&or[2][state]=pending - Complex:
or[1][state]=draft&or[1][budget][gte]=50000&or[2][state]=closed - With custom fields:
or[1][cf][priority]=high&or[2][state]=pending
Group keys can be any string (1, 2, a, b, etc.) - they just need to be unique.
Custom field filters using concise syntax.
Syntax:
- Equality:
cf[key]=value - With operator:
cf[key][operator]=value
Operators: eq (default), not_eq, in, not_in, contains, not_contains, exists, not_exists
Examples:
cf[priority]=high- exact matchcf[department][in]=eng,design- matches anycf[priority][not_eq]=low- not equalcf[notes][contains]=urgent- contains textcf[legacy_field][exists]=- field exists (value ignored)cf[deprecated][not_exists]=- field does not exist
Custom field filters within OR condition groups.
Syntax: or[group][cf][key]=value or or[group][cf][key][operator]=value
Example: or[1][cf][priority]=high&or[2][state]=pending
Sort results by attribute. Direction defaults to ascending.
Syntax: sort[<attribute>]= (ascending) or sort[<attribute>]=desc (descending)
Sortable attributes: approved_at, approved_by_id, cis_amount_due, cis_contractor, cis_deductible, cis_deduction_total, cis_rate_id, cis_subcontractor, client_due_on, client_payment_terms_in_days, created_at, credit_note_id, credit_note_reason, dated_on, description, due_on, external_id, external_provider, id, is_credit_note, level_1_approved_at, level_1_approved_by_id, line_item_sheet_id, manual_client_tax_type_id, milestone_id, net_total, paid_at, payment_terms_in_days, project_id, reference_number, rejected_at, rejected_by_id, rejected_reason, self_bill, sent_at, status, subtype, tax_total, total, type, updated_at, vatable
Examples:
- Ascending:
sort[created_at]=orsort[created_at]=asc - Descending:
sort[created_at]=desc
Response
List of invoices
Show child attributes
Show child attributes