Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
A valid request URL is required to generate request examples{
"id": 2,
"label": "SAMPLEP-2",
"status": "draft",
"created_at": "2026-08-07T11:11:05.884-04:00",
"updated_at": "2026-08-07T11:11:05.884-04:00",
"subtotal": 0,
"total": 0,
"taxes": 0,
"taxable_amount": 0,
"client": {
"id": 1,
"name": "Fohlio 1",
"data": {
"notes": {
"value": {
"value": "just note"
}
},
"account": {
"value": {
"vat": "vat",
"terms": "term",
"currency": "CNY",
"lead_time": "lead_time",
"credit_limit": "credit_limit",
"account_number": "account_number",
"registration_number": "registration_number"
}
},
"address": {
"value": [
{
"id": 1,
"city": "city",
"name": "name",
"phone": "phone",
"state": "state",
"country": "country",
"contacts": {
"value": [
{
"id": 1,
"name": "Contact 1",
"note": "Note 1",
"email": "email1@example.com",
"phone": "Phone 1",
"position": "Title 1",
"priority": "standard"
}
]
},
"priority": "standard",
"post_code": "post_code",
"address_line_1": "address_line_1",
"address_line_2": "address_line_2",
"team_region_id": null
}
]
},
"category": {
"value": [
{
"id": 1,
"name": "Concrete"
}
]
},
"document": {
"value": {
"note": "note",
"files": []
}
},
"company_details": {
"value": {
"email": "fohlio1@example.com",
"status": "Approved",
"website": "www",
"language": "en",
"password": "secret",
"user_name": "Tester",
"company_name": "Fohlio 1"
}
}
},
"addresses": [
{
"id": 1,
"name": "name",
"phone": "phone",
"postcode": "post_code",
"address_line_1": "address_line_1",
"address_line_2": "address_line_2",
"city": "city",
"state": "state",
"country": "country"
}
],
"people": [
{
"id": 1,
"name": "Contact 1",
"email": "email1@example.com",
"phone": "Phone 1",
"position": "Title 1",
"note": "Note 1"
}
],
"categories": [
{
"id": 1,
"type": "client"
}
]
},
"items": [
{
"id": 36,
"name": "PM 13",
"description": "Project Model 13",
"unit_type": null,
"quantity": 2,
"price": 33.33,
"taxable": true,
"second_taxable": false,
"project_item_id": 13
},
{
"id": 37,
"name": "PM 27",
"description": "Project Model 27",
"unit_type": null,
"quantity": 2,
"price": 33.33,
"taxable": true,
"second_taxable": false,
"project_item_id": 27
},
{
"id": 38,
"name": "PM 7",
"description": "Project Model 7",
"unit_type": null,
"quantity": 2,
"price": 33.33,
"taxable": true,
"second_taxable": false,
"project_item_id": 7
}
],
"client_invoice_ids": [],
"payment_terms": [
{
"id": "c868d171-21dc-426c-ac1e-3919d3a34030",
"amount": "50%",
"due_date": null,
"payment_terms": "Deposit"
},
{
"id": "edc5bbea-f9ea-4468-b6c1-33a8c0b8c588",
"amount": "50%",
"due_date": null,
"payment_terms": "Deposit"
}
]
}{
"error": "Unauthorized"
}{
"error": "Forbidden"
}{
"error": "Not Found"
}A valid request URL is required to generate request examples{
"id": 2,
"label": "SAMPLEP-2",
"status": "draft",
"created_at": "2026-08-07T11:11:05.884-04:00",
"updated_at": "2026-08-07T11:11:05.884-04:00",
"subtotal": 0,
"total": 0,
"taxes": 0,
"taxable_amount": 0,
"client": {
"id": 1,
"name": "Fohlio 1",
"data": {
"notes": {
"value": {
"value": "just note"
}
},
"account": {
"value": {
"vat": "vat",
"terms": "term",
"currency": "CNY",
"lead_time": "lead_time",
"credit_limit": "credit_limit",
"account_number": "account_number",
"registration_number": "registration_number"
}
},
"address": {
"value": [
{
"id": 1,
"city": "city",
"name": "name",
"phone": "phone",
"state": "state",
"country": "country",
"contacts": {
"value": [
{
"id": 1,
"name": "Contact 1",
"note": "Note 1",
"email": "email1@example.com",
"phone": "Phone 1",
"position": "Title 1",
"priority": "standard"
}
]
},
"priority": "standard",
"post_code": "post_code",
"address_line_1": "address_line_1",
"address_line_2": "address_line_2",
"team_region_id": null
}
]
},
"category": {
"value": [
{
"id": 1,
"name": "Concrete"
}
]
},
"document": {
"value": {
"note": "note",
"files": []
}
},
"company_details": {
"value": {
"email": "fohlio1@example.com",
"status": "Approved",
"website": "www",
"language": "en",
"password": "secret",
"user_name": "Tester",
"company_name": "Fohlio 1"
}
}
},
"addresses": [
{
"id": 1,
"name": "name",
"phone": "phone",
"postcode": "post_code",
"address_line_1": "address_line_1",
"address_line_2": "address_line_2",
"city": "city",
"state": "state",
"country": "country"
}
],
"people": [
{
"id": 1,
"name": "Contact 1",
"email": "email1@example.com",
"phone": "Phone 1",
"position": "Title 1",
"note": "Note 1"
}
],
"categories": [
{
"id": 1,
"type": "client"
}
]
},
"items": [
{
"id": 36,
"name": "PM 13",
"description": "Project Model 13",
"unit_type": null,
"quantity": 2,
"price": 33.33,
"taxable": true,
"second_taxable": false,
"project_item_id": 13
},
{
"id": 37,
"name": "PM 27",
"description": "Project Model 27",
"unit_type": null,
"quantity": 2,
"price": 33.33,
"taxable": true,
"second_taxable": false,
"project_item_id": 27
},
{
"id": 38,
"name": "PM 7",
"description": "Project Model 7",
"unit_type": null,
"quantity": 2,
"price": 33.33,
"taxable": true,
"second_taxable": false,
"project_item_id": 7
}
],
"client_invoice_ids": [],
"payment_terms": [
{
"id": "c868d171-21dc-426c-ac1e-3919d3a34030",
"amount": "50%",
"due_date": null,
"payment_terms": "Deposit"
},
{
"id": "edc5bbea-f9ea-4468-b6c1-33a8c0b8c588",
"amount": "50%",
"due_date": null,
"payment_terms": "Deposit"
}
]
}{
"error": "Unauthorized"
}{
"error": "Forbidden"
}{
"error": "Not Found"
}OK
draft, review, approved, rejected, invoiced_partially, invoiced_fully Show child attributes
Show child attributes
Show child attributes