List Variation Orders
curl --request GET \
--url https://api.zivio.net/api/v4/variation_orders \
--header 'Authorization: Bearer <token>' \
--header 'zivio-tenant-id: <api-key>'import requests
url = "https://api.zivio.net/api/v4/variation_orders"
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/variation_orders', 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/variation_orders",
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/variation_orders"
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/variation_orders")
.header("Authorization", "Bearer <token>")
.header("zivio-tenant-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zivio.net/api/v4/variation_orders")
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{
"variation_orders": [
{
"id": 101,
"version_number": 101,
"status": "pending",
"rate": {
"cents": 150000,
"currency": "GBP"
},
"original_rate": {
"cents": 150000,
"currency": "GBP"
},
"additional_terms": "Example additional_terms",
"created_by": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"supplier_contract_template": null,
"client_contract_template": null,
"skip_acceptance": true,
"submitted_at": "2024-01-16T10:30:00+00:00",
"sent_at": "2024-01-16T10:30:00+00:00",
"start_date": "2024-03-08",
"due_on": "2024-01-16",
"expires_at": "2024-01-16T10:30:00+00:00",
"accepted_at": "2024-01-16T10: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"
},
"approver_declined_reason": "Example approver_declined_reason",
"declined_at": "2024-01-16T10:30:00+00:00",
"declined_reason": "Example declined_reason",
"reject_reason": "Example reject_reason",
"milestone_variations": [
{
"id": 101,
"variation_order_id": 501,
"original_title": "Phase 1 Milestone",
"varied_title": "Phase 1 Milestone",
"original_details": "Milestone details and requirements",
"varied_details": "Milestone details and requirements",
"original_due_on": "2024-01-16",
"varied_due_on": "2024-01-16",
"original_rate": {
"cents": 150000,
"currency": "GBP"
},
"varied_rate": {
"cents": 150000,
"currency": "GBP"
},
"original_tiered_markup_fee": {
"cents": 150000,
"currency": "GBP"
},
"varied_tiered_markup_fee": {
"cents": 150000,
"currency": "GBP"
},
"client_suggested": false,
"milestone_id": 501,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
}
},
{
"id": 102,
"variation_order_id": 502,
"original_title": "Phase 2 Milestone",
"varied_title": "Phase 2 Milestone",
"original_details": "Milestone details and requirements",
"varied_details": "Milestone details and requirements",
"original_due_on": "2024-01-17",
"varied_due_on": "2024-01-17",
"original_rate": {
"cents": 300000,
"currency": "GBP"
},
"varied_rate": {
"cents": 300000,
"currency": "GBP"
},
"original_tiered_markup_fee": {
"cents": 300000,
"currency": "GBP"
},
"varied_tiered_markup_fee": {
"cents": 300000,
"currency": "GBP"
},
"client_suggested": false,
"milestone_id": 502,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
}
}
],
"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"
},
"project_line_item_variations": [
{
"id": 101,
"variation_order_id": 501,
"original_name": "Line Item Name",
"varied_name": "Line Item Name",
"original_manufacturer_name": "ACME Manufacturing",
"varied_manufacturer_name": "ACME Manufacturing",
"original_manufacturer_part_number": "PART-1001",
"varied_manufacturer_part_number": "PART-1001",
"original_quantity": "10.0",
"varied_quantity": "10.0",
"original_price": {
"cents": 150000,
"currency": "GBP"
},
"varied_price": {
"cents": 150000,
"currency": "GBP"
},
"original_uom": null,
"varied_uom": null,
"item_id": 501,
"project_line_item_id": 501
},
{
"id": 102,
"variation_order_id": 502,
"original_name": "Line Item Name",
"varied_name": "Line Item Name",
"original_manufacturer_name": "ACME Manufacturing",
"varied_manufacturer_name": "ACME Manufacturing",
"original_manufacturer_part_number": "PART-1002",
"varied_manufacturer_part_number": "PART-1002",
"original_quantity": "10.0",
"varied_quantity": "10.0",
"original_price": {
"cents": 300000,
"currency": "GBP"
},
"varied_price": {
"cents": 300000,
"currency": "GBP"
},
"original_uom": null,
"varied_uom": null,
"item_id": 502,
"project_line_item_id": 502
}
]
},
{
"id": 102,
"version_number": 102,
"status": "accepted",
"rate": {
"cents": 300000,
"currency": "GBP"
},
"original_rate": {
"cents": 300000,
"currency": "GBP"
},
"additional_terms": "Example additional_terms",
"created_by": {
"id": 102,
"first_name": "Jane",
"last_name": "Smith",
"email": "user2@example.com",
"org_id": 502,
"org_name": "Global Services Ltd"
},
"supplier_contract_template": null,
"client_contract_template": null,
"skip_acceptance": true,
"submitted_at": "2024-01-17T10:30:00+00:00",
"sent_at": "2024-01-17T10:30:00+00:00",
"start_date": "2024-03-15",
"due_on": "2024-01-17",
"expires_at": "2024-01-17T10:30:00+00:00",
"accepted_at": "2024-01-17T10: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"
},
"approver_declined_reason": "Example approver_declined_reason",
"declined_at": "2024-01-17T10:30:00+00:00",
"declined_reason": "Example declined_reason",
"reject_reason": "Example reject_reason",
"milestone_variations": [
{
"id": 102,
"variation_order_id": 502,
"original_title": "Phase 2 Milestone",
"varied_title": "Phase 2 Milestone",
"original_details": "Milestone details and requirements",
"varied_details": "Milestone details and requirements",
"original_due_on": "2024-01-17",
"varied_due_on": "2024-01-17",
"original_rate": {
"cents": 300000,
"currency": "GBP"
},
"varied_rate": {
"cents": 300000,
"currency": "GBP"
},
"original_tiered_markup_fee": {
"cents": 300000,
"currency": "GBP"
},
"varied_tiered_markup_fee": {
"cents": 300000,
"currency": "GBP"
},
"client_suggested": false,
"milestone_id": 502,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
}
},
{
"id": 103,
"variation_order_id": 503,
"original_title": "Phase 2 Milestone",
"varied_title": "Phase 2 Milestone",
"original_details": "Milestone details and requirements",
"varied_details": "Milestone details and requirements",
"original_due_on": "2024-01-18",
"varied_due_on": "2024-01-18",
"original_rate": {
"cents": 450000,
"currency": "GBP"
},
"varied_rate": {
"cents": 450000,
"currency": "GBP"
},
"original_tiered_markup_fee": {
"cents": 450000,
"currency": "GBP"
},
"varied_tiered_markup_fee": {
"cents": 450000,
"currency": "GBP"
},
"client_suggested": false,
"milestone_id": 503,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
}
}
],
"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"
},
"project_line_item_variations": [
{
"id": 102,
"variation_order_id": 502,
"original_name": "Line Item Name",
"varied_name": "Line Item Name",
"original_manufacturer_name": "ACME Manufacturing",
"varied_manufacturer_name": "ACME Manufacturing",
"original_manufacturer_part_number": "PART-1002",
"varied_manufacturer_part_number": "PART-1002",
"original_quantity": "10.0",
"varied_quantity": "10.0",
"original_price": {
"cents": 300000,
"currency": "GBP"
},
"varied_price": {
"cents": 300000,
"currency": "GBP"
},
"original_uom": null,
"varied_uom": null,
"item_id": 502,
"project_line_item_id": 502
},
{
"id": 103,
"variation_order_id": 503,
"original_name": "Line Item Name",
"varied_name": "Line Item Name",
"original_manufacturer_name": "ACME Manufacturing",
"varied_manufacturer_name": "ACME Manufacturing",
"original_manufacturer_part_number": "PART-1003",
"varied_manufacturer_part_number": "PART-1003",
"original_quantity": "10.0",
"varied_quantity": "10.0",
"original_price": {
"cents": 450000,
"currency": "GBP"
},
"varied_price": {
"cents": 450000,
"currency": "GBP"
},
"original_uom": null,
"varied_uom": null,
"item_id": 503,
"project_line_item_id": 503
}
]
}
]
}Variation Orders
List Variation Orders
Retrieve a paginated list of variation_orders. 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/variation_orders?filter[status]=draft
# Multiple values (implicit IN)
GET /api/v4/variation_orders?filter[status]=draft,accepted
# With explicit operator
GET /api/v4/variation_orders?filter[created_at][gte]=2024-01-01
# Range query
GET /api/v4/variation_orders?filter[original_rate][between]=1000000,5000000
# Multiple filters (AND)
GET /api/v4/variation_orders?filter[status]=draft&filter[original_rate][gte]=1000000
Available Attributes
| Attribute | Type | Operators | Permitted Values |
|---|---|---|---|
| accepted_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| additional_terms | string | eq, not_eq, in, not_in, like, not_like | - |
| 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 | - |
| approver_declined_reason | string | eq, not_eq, in, not_in, like, not_like | - |
| client_contract_template_id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| created_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| created_by_id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| current_approval_level | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| declined_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| declined_reason | string | eq, not_eq, in, not_in, like, not_like | - |
| due_on | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| expires_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| length_of_time | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| original_rate | money | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| original_rate_ccy | string | eq, not_eq, in, not_in, like, not_like | - |
| project_id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| rate | money | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| rate_ccy | string | eq, not_eq, in, not_in, like, not_like | - |
| reject_reason | string | eq, not_eq, in, not_in, like, not_like | - |
| sent_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| skip_acceptance | boolean | eq, not_eq | - |
| start_date | date | eq, not_eq, gt, gte, lt, lte, between | - |
| status | string | eq, not_eq, in, not_in | draft, pending, accepted, declined, withdrawn, expired, generating, signature_error, sending, rejected, cancelled, submitted, supplier_draft, supplier_proposed, supplier_rejected |
| submitted_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| supplier_contract_template_id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| update_budget | boolean | eq, not_eq | - |
| updated_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| version_number | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
Custom Fields
This resource supports custom field filtering using cf[key] syntax:
# Equality
GET /api/v4/variation_orders?cf[priority]=high
# With operator
GET /api/v4/variation_orders?cf[department][in]=engineering,design
# Check existence
GET /api/v4/variation_orders?cf[priority][exists]=
# Negation
GET /api/v4/variation_orders?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/variation_orders?or[1][status]=pending&or[2][status]=draft
# Complex OR (status=pending AND original_rate>=1000000) OR (status=draft)
GET /api/v4/variation_orders?or[1][status]=pending&or[1][original_rate][gte]=1000000&or[2][status]=draft
Sorting
Use sort[<attribute>] to order results. Default direction is ascending.
# Ascending (implicit)
GET /api/v4/variation_orders?sort[created_at]=
# Descending
GET /api/v4/variation_orders?sort[created_at]=desc
# Combined with filters
GET /api/v4/variation_orders?filter[status]=draft&sort[created_at]=desc
GET
/
variation_orders
List Variation Orders
curl --request GET \
--url https://api.zivio.net/api/v4/variation_orders \
--header 'Authorization: Bearer <token>' \
--header 'zivio-tenant-id: <api-key>'import requests
url = "https://api.zivio.net/api/v4/variation_orders"
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/variation_orders', 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/variation_orders",
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/variation_orders"
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/variation_orders")
.header("Authorization", "Bearer <token>")
.header("zivio-tenant-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zivio.net/api/v4/variation_orders")
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{
"variation_orders": [
{
"id": 101,
"version_number": 101,
"status": "pending",
"rate": {
"cents": 150000,
"currency": "GBP"
},
"original_rate": {
"cents": 150000,
"currency": "GBP"
},
"additional_terms": "Example additional_terms",
"created_by": {
"id": 101,
"first_name": "Demo",
"last_name": "User",
"email": "user1@example.com",
"org_id": 501,
"org_name": "Acme Corporation"
},
"supplier_contract_template": null,
"client_contract_template": null,
"skip_acceptance": true,
"submitted_at": "2024-01-16T10:30:00+00:00",
"sent_at": "2024-01-16T10:30:00+00:00",
"start_date": "2024-03-08",
"due_on": "2024-01-16",
"expires_at": "2024-01-16T10:30:00+00:00",
"accepted_at": "2024-01-16T10: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"
},
"approver_declined_reason": "Example approver_declined_reason",
"declined_at": "2024-01-16T10:30:00+00:00",
"declined_reason": "Example declined_reason",
"reject_reason": "Example reject_reason",
"milestone_variations": [
{
"id": 101,
"variation_order_id": 501,
"original_title": "Phase 1 Milestone",
"varied_title": "Phase 1 Milestone",
"original_details": "Milestone details and requirements",
"varied_details": "Milestone details and requirements",
"original_due_on": "2024-01-16",
"varied_due_on": "2024-01-16",
"original_rate": {
"cents": 150000,
"currency": "GBP"
},
"varied_rate": {
"cents": 150000,
"currency": "GBP"
},
"original_tiered_markup_fee": {
"cents": 150000,
"currency": "GBP"
},
"varied_tiered_markup_fee": {
"cents": 150000,
"currency": "GBP"
},
"client_suggested": false,
"milestone_id": 501,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
}
},
{
"id": 102,
"variation_order_id": 502,
"original_title": "Phase 2 Milestone",
"varied_title": "Phase 2 Milestone",
"original_details": "Milestone details and requirements",
"varied_details": "Milestone details and requirements",
"original_due_on": "2024-01-17",
"varied_due_on": "2024-01-17",
"original_rate": {
"cents": 300000,
"currency": "GBP"
},
"varied_rate": {
"cents": 300000,
"currency": "GBP"
},
"original_tiered_markup_fee": {
"cents": 300000,
"currency": "GBP"
},
"varied_tiered_markup_fee": {
"cents": 300000,
"currency": "GBP"
},
"client_suggested": false,
"milestone_id": 502,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
}
}
],
"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"
},
"project_line_item_variations": [
{
"id": 101,
"variation_order_id": 501,
"original_name": "Line Item Name",
"varied_name": "Line Item Name",
"original_manufacturer_name": "ACME Manufacturing",
"varied_manufacturer_name": "ACME Manufacturing",
"original_manufacturer_part_number": "PART-1001",
"varied_manufacturer_part_number": "PART-1001",
"original_quantity": "10.0",
"varied_quantity": "10.0",
"original_price": {
"cents": 150000,
"currency": "GBP"
},
"varied_price": {
"cents": 150000,
"currency": "GBP"
},
"original_uom": null,
"varied_uom": null,
"item_id": 501,
"project_line_item_id": 501
},
{
"id": 102,
"variation_order_id": 502,
"original_name": "Line Item Name",
"varied_name": "Line Item Name",
"original_manufacturer_name": "ACME Manufacturing",
"varied_manufacturer_name": "ACME Manufacturing",
"original_manufacturer_part_number": "PART-1002",
"varied_manufacturer_part_number": "PART-1002",
"original_quantity": "10.0",
"varied_quantity": "10.0",
"original_price": {
"cents": 300000,
"currency": "GBP"
},
"varied_price": {
"cents": 300000,
"currency": "GBP"
},
"original_uom": null,
"varied_uom": null,
"item_id": 502,
"project_line_item_id": 502
}
]
},
{
"id": 102,
"version_number": 102,
"status": "accepted",
"rate": {
"cents": 300000,
"currency": "GBP"
},
"original_rate": {
"cents": 300000,
"currency": "GBP"
},
"additional_terms": "Example additional_terms",
"created_by": {
"id": 102,
"first_name": "Jane",
"last_name": "Smith",
"email": "user2@example.com",
"org_id": 502,
"org_name": "Global Services Ltd"
},
"supplier_contract_template": null,
"client_contract_template": null,
"skip_acceptance": true,
"submitted_at": "2024-01-17T10:30:00+00:00",
"sent_at": "2024-01-17T10:30:00+00:00",
"start_date": "2024-03-15",
"due_on": "2024-01-17",
"expires_at": "2024-01-17T10:30:00+00:00",
"accepted_at": "2024-01-17T10: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"
},
"approver_declined_reason": "Example approver_declined_reason",
"declined_at": "2024-01-17T10:30:00+00:00",
"declined_reason": "Example declined_reason",
"reject_reason": "Example reject_reason",
"milestone_variations": [
{
"id": 102,
"variation_order_id": 502,
"original_title": "Phase 2 Milestone",
"varied_title": "Phase 2 Milestone",
"original_details": "Milestone details and requirements",
"varied_details": "Milestone details and requirements",
"original_due_on": "2024-01-17",
"varied_due_on": "2024-01-17",
"original_rate": {
"cents": 300000,
"currency": "GBP"
},
"varied_rate": {
"cents": 300000,
"currency": "GBP"
},
"original_tiered_markup_fee": {
"cents": 300000,
"currency": "GBP"
},
"varied_tiered_markup_fee": {
"cents": 300000,
"currency": "GBP"
},
"client_suggested": false,
"milestone_id": 502,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
}
},
{
"id": 103,
"variation_order_id": 503,
"original_title": "Phase 2 Milestone",
"varied_title": "Phase 2 Milestone",
"original_details": "Milestone details and requirements",
"varied_details": "Milestone details and requirements",
"original_due_on": "2024-01-18",
"varied_due_on": "2024-01-18",
"original_rate": {
"cents": 450000,
"currency": "GBP"
},
"varied_rate": {
"cents": 450000,
"currency": "GBP"
},
"original_tiered_markup_fee": {
"cents": 450000,
"currency": "GBP"
},
"varied_tiered_markup_fee": {
"cents": 450000,
"currency": "GBP"
},
"client_suggested": false,
"milestone_id": 503,
"custom_fields": {
"department": "Engineering",
"priority": "high",
"cost_code": "CC-001"
}
}
],
"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"
},
"project_line_item_variations": [
{
"id": 102,
"variation_order_id": 502,
"original_name": "Line Item Name",
"varied_name": "Line Item Name",
"original_manufacturer_name": "ACME Manufacturing",
"varied_manufacturer_name": "ACME Manufacturing",
"original_manufacturer_part_number": "PART-1002",
"varied_manufacturer_part_number": "PART-1002",
"original_quantity": "10.0",
"varied_quantity": "10.0",
"original_price": {
"cents": 300000,
"currency": "GBP"
},
"varied_price": {
"cents": 300000,
"currency": "GBP"
},
"original_uom": null,
"varied_uom": null,
"item_id": 502,
"project_line_item_id": 502
},
{
"id": 103,
"variation_order_id": 503,
"original_name": "Line Item Name",
"varied_name": "Line Item Name",
"original_manufacturer_name": "ACME Manufacturing",
"varied_manufacturer_name": "ACME Manufacturing",
"original_manufacturer_part_number": "PART-1003",
"varied_manufacturer_part_number": "PART-1003",
"original_quantity": "10.0",
"varied_quantity": "10.0",
"original_price": {
"cents": 450000,
"currency": "GBP"
},
"varied_price": {
"cents": 450000,
"currency": "GBP"
},
"original_uom": null,
"varied_uom": null,
"item_id": 503,
"project_line_item_id": 503
}
]
}
]
}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, client_contract_template_id, created_by_id, current_approval_level, id, length_of_time, project_id, supplier_contract_template_id, version_number datetime (operators: eq, not_eq, gt, gte, lt, lte, between): accepted_at, approved_at, created_at, declined_at, due_on, expires_at, sent_at, submitted_at, updated_at string (operators: eq, not_eq, in, not_in, like, not_like): additional_terms, approver_declined_reason, declined_reason, original_rate_ccy, rate_ccy, reject_reason, status (one of: draft, pending, accepted, declined, withdrawn, expired, generating, signature_error, sending, rejected, cancelled, submitted, supplier_draft, supplier_proposed, supplier_rejected) money (operators: eq, not_eq, in, not_in, gt, gte, lt, lte, between): original_rate, rate boolean (operators: eq, not_eq): skip_acceptance, update_budget date (operators: eq, not_eq, gt, gte, lt, lte, between): start_date
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: accepted_at, additional_terms, approved_at, approved_by_id, approver_declined_reason, client_contract_template_id, created_at, created_by_id, current_approval_level, declined_at, declined_reason, due_on, expires_at, id, length_of_time, original_rate, original_rate_ccy, project_id, rate, rate_ccy, reject_reason, sent_at, skip_acceptance, start_date, status, submitted_at, supplier_contract_template_id, update_budget, updated_at, version_number
Examples:
- Ascending:
sort[created_at]=orsort[created_at]=asc - Descending:
sort[created_at]=desc
Response
List of variation_orders
Show child attributes
Show child attributes