curl --request POST \
--url https://staging-api.tyms.io/v1/adam/create/quote \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"date": "2026-04-01",
"expiry_date": "2026-04-30",
"currency": "NGN",
"document_number": "QUO-0021",
"narration": "Website redesign proposal",
"customer": "a1b2c3d4e5f6478990a1b2c3d4e5f678",
"items": [
{
"item_name": "UI/UX Design",
"quantity": 1,
"selling_price": 200000,
"category": "Design Income"
}
]
}
'import requests
url = "https://staging-api.tyms.io/v1/adam/create/quote"
payload = {
"date": "2026-04-01",
"expiry_date": "2026-04-30",
"currency": "NGN",
"document_number": "QUO-0021",
"narration": "Website redesign proposal",
"customer": "a1b2c3d4e5f6478990a1b2c3d4e5f678",
"items": [
{
"item_name": "UI/UX Design",
"quantity": 1,
"selling_price": 200000,
"category": "Design Income"
}
]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
date: '2026-04-01',
expiry_date: '2026-04-30',
currency: 'NGN',
document_number: 'QUO-0021',
narration: 'Website redesign proposal',
customer: 'a1b2c3d4e5f6478990a1b2c3d4e5f678',
items: [
{
item_name: 'UI/UX Design',
quantity: 1,
selling_price: 200000,
category: 'Design Income'
}
]
})
};
fetch('https://staging-api.tyms.io/v1/adam/create/quote', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "success",
"message": "Quote created successfully",
"data": {
"uuid": "quote-uuid-1",
"transaction_type": "quote",
"status": "draft",
"document_number": "QUO-0021",
"narration": "Website redesign proposal",
"amount": 200000,
"currency": "NGN"
}
}{
"status": "failed",
"message": "<string>"
}Create quote (alias)
Alias for POST /quotes. Prefer /quotes for new integrations.
curl --request POST \
--url https://staging-api.tyms.io/v1/adam/create/quote \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"date": "2026-04-01",
"expiry_date": "2026-04-30",
"currency": "NGN",
"document_number": "QUO-0021",
"narration": "Website redesign proposal",
"customer": "a1b2c3d4e5f6478990a1b2c3d4e5f678",
"items": [
{
"item_name": "UI/UX Design",
"quantity": 1,
"selling_price": 200000,
"category": "Design Income"
}
]
}
'import requests
url = "https://staging-api.tyms.io/v1/adam/create/quote"
payload = {
"date": "2026-04-01",
"expiry_date": "2026-04-30",
"currency": "NGN",
"document_number": "QUO-0021",
"narration": "Website redesign proposal",
"customer": "a1b2c3d4e5f6478990a1b2c3d4e5f678",
"items": [
{
"item_name": "UI/UX Design",
"quantity": 1,
"selling_price": 200000,
"category": "Design Income"
}
]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
date: '2026-04-01',
expiry_date: '2026-04-30',
currency: 'NGN',
document_number: 'QUO-0021',
narration: 'Website redesign proposal',
customer: 'a1b2c3d4e5f6478990a1b2c3d4e5f678',
items: [
{
item_name: 'UI/UX Design',
quantity: 1,
selling_price: 200000,
category: 'Design Income'
}
]
})
};
fetch('https://staging-api.tyms.io/v1/adam/create/quote', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "success",
"message": "Quote created successfully",
"data": {
"uuid": "quote-uuid-1",
"transaction_type": "quote",
"status": "draft",
"document_number": "QUO-0021",
"narration": "Website redesign proposal",
"amount": 200000,
"currency": "NGN"
}
}{
"status": "failed",
"message": "<string>"
}Authorizations
Business secret tyms_sk_... for business-scoped routes. Partner secret for register-business and referred-business distributor routes.
Body
Quote date.
Line items. Total is computed from lines.
1Hide child attributes
Hide child attributes
Line label. Alias: name.
Quantity sold or purchased.
Unit price. On bills this is unit cost. Alias: price.
Required. Revenue, expense, or inventory account — name, uuid, or account code.
Optional line description.
Tax rate as a percentage (e.g. 7.5 = 7.5%). Preferred over tax_uuid.
Optional tax record uuid instead of tax percentage.
Withholding tax (WHT) rate as a percentage.
Optional WHT uuid instead of withholding_tax percentage.
Line discount value.
percent or amount / fixed.
percent, amount, fixed true if the line affects stock.
Existing inventory item uuid when linking stock.
Optional expiry date for the quote.
Currency code.
Quote number; auto-assigned if omitted.
Quote title / description.
Internal note.
Note shown on the printed quote.
Contact uuid, name, or email.
Default 1.
Shipping amount.
Default draft.
Branch id from GET /branches. Alias: branch.
Department id from GET /departments. Alias: department.
Project id from GET /projects. An unknown id is saved as sent and does not create a project. To add one from a name, send project_name and leave this off.
Branch id. Same as branch_uuid. Leave both off to use the business default branch. A name is not accepted, and a new branch is not created. An id that is not one of your branches is still saved, but it will not show under a location in reports. On an update, this name is ignored — send the id.
Department id. Same as department_uuid. An unknown id is saved as sent and does not create a department. To add one from a name, send department_name and leave this off.
Department name. Capitalization does not matter. If no department has that name, Tyms adds one and tags this document with it. Ignored when department or department_uuid is set. On an update, this name is ignored — send the id.
Project name, matched exactly, including capital letters. If no project has that name, Tyms adds an active project that starts today and ends in one month, then tags this document with it. Ignored when project_uuid is set. On an update, this name is ignored — send the id.
Team member id. Same as employee_uuid. An unknown id is saved as sent and does not add a person. To add one from a name, send employee_name and leave this off.
Team member id. Alias: employee.
Full name of the team member. If nobody matches, Tyms adds them. Ignored when employee or employee_uuid is set. On an update, this name is ignored — send the id.
Response
Quote created