- drafts
- test 23
- Welcome
- Getting Started
- Authorization
- OverView
- Sample APIs
- Client
- Product
- Category
- Invoices
- Clients
- Products
- Suppliers
- Taxes
- General Listing
- Site Info
- Staff
- Authentication
- Api V2
- Last
- Full Version
- Invoices
- Estimates
- Credit Notes
- Refund Receipts
- Purchase Orders
- Purchase Refunds
- Clients
- Suppliers
- Staff
- Client Attendance
- Client Appointments
- Invoice Appointments
- Estimate Appointments
- Work Order Appointments
- Notes
- Products
- Time Tracking
- Work Orders
- Product Categories
- Taxes
- Invoice Payments
- Client Payments
- Expenses
- Incomes
- Stores
- Treasuries
- Stock Transactions
- Journals
- Journal Accounts
- Journal Categories
- Follow Up Statuses
- Follow Up Actions
- General Listing
- Site Info
- Authentication
- Documentation
- tests
- Authentication
- Site Information
- Invoices
- Estimates
- Credit Notes
- Purchase Orders
- Purchase Refunds
- Clients
- Suppliers
- Products
- General Listings
- Edit Estimate
- Delete Estimate
- Edit Credit Note
- Delete Credit Note
- Edit Refund Receipt
- Delete Refund Receipt
- Edit Purchase Order
- Delete Purchase Order
- Edit Purchase Refund
- Delete Purchase Refund
- Edit Client
- Delete Client
- Edit Supplier
- Delete Supplier
- Edit Product
- Delete Product
- Docs
- Untitled Doc
- Invoices
- Estimates
- Credit Notes
- Refund Receipts
- Purchase Orders
- Purchase Refunds
- Clients
- Suppliers
- Staff
- Client Attendance
- Client Appointments
- Invoice Appointments
- Estimate Appointments
- Work Order Appointments
- Notes
- Products
- Time Tracking
- Work Orders
- Product Categories
- Taxes
- Invoice Payments
- Client Payments
- Expenses
- Incomes
- Stores
- Treasuries
- Stock Transactions
- Journals
- Journal Accounts
- Journal Categories
- Follow Up Statuses
- Follow Up Actions
- General Listing
- Site Info
- Authentication
- Documentation
- ttt
- Authentication
- Site Information
- Invoices
- Estimates
- Credit Notes
- Purchase Orders
- Purchase Refunds
- Clients
- Suppliers
- Products
- General Listings
- Edit Estimate
- Delete Estimate
- Edit Credit Note
- Delete Credit Note
- Edit Refund Receipt
- Delete Refund Receipt
- Edit Purchase Order
- Delete Purchase Order
- Edit Purchase Refund
- Delete Purchase Refund
- Edit Client
- Delete Client
- Edit Supplier
- Delete Supplier
- Edit Product
- Delete Product
Create
Prod Env
{{subdomain}}/api2
Prod Env
{{subdomain}}/api2
POST
{{subdomain}}/api2
Last modified:2025-03-18 00:15:04
Maintainer:Not configured
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST '{{subdomain}}/api2/api2/clients.json' \
--header 'APIKEY: {{APIKEY}}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
"Client": {
"is_offline": true,
"staff_id": 1,
"business_name": "Mock Business",
"first_name": "John",
"last_name": "Doe",
"email": "mock@example.com",
"password": "password123",
"address1": "123 Mock Street",
"address2": "Apt 456",
"city": "Mock City",
"state": "Mock State",
"postal_code": "12345",
"phone1": "123-456-7890",
"phone2": "098-765-4321",
"country_code": "US",
"notes": "These are mock notes.",
"active_secondary_address": true,
"secondary_name": "Jane Doe",
"secondary_address1": "456 Secondary St",
"secondary_address2": "Suite 789",
"secondary_city": "Secondary City",
"secondary_state": "Secondary State",
"secondary_postal_code": "67890",
"secondary_country_code": "US",
"default_currency_code": "USD",
"follow_up_status": null,
"category": "Mock Category",
"group_price_id": 2,
"timezone": -5,
"bn1": "Business Note 1",
"bn1_label": "Label 1",
"bn2_label": "Label 2",
"bn2": "Business Note 2",
"starting_balance": 1000.00,
"type": 2,
"birth_date": "1990-01-01",
"gender": 1,
"map_location": "40.712776,-74.005974,5",
"credit_limit": 5000.00,
"credit_period": 30
}
}'
Response Response Example
{
"result": "successful",
"code": 202,
"id": "107",
"client_number": "104"
}
Request
Header Params
APIKEY
stringÂ
required
Example:
{{APIKEY}}
Content-Type
stringÂ
required
Example:
application/json
Accept
stringÂ
required
Example:
application/json
Body Params application/json
Client
objectÂ
required
is_offline
booleanÂ
required
staff_id
integerÂ
required
business_name
stringÂ
required
first_name
stringÂ
required
last_name
stringÂ
required
email
stringÂ
required
password
stringÂ
required
address1
stringÂ
required
address2
stringÂ
required
city
stringÂ
required
state
stringÂ
required
postal_code
stringÂ
required
phone1
stringÂ
required
phone2
stringÂ
required
country_code
stringÂ
required
notes
stringÂ
required
active_secondary_address
booleanÂ
required
secondary_name
stringÂ
required
secondary_address1
stringÂ
required
secondary_address2
stringÂ
required
secondary_city
stringÂ
required
secondary_state
stringÂ
required
secondary_postal_code
stringÂ
required
secondary_country_code
stringÂ
required
default_currency_code
stringÂ
required
follow_up_status
nullÂ
required
category
stringÂ
required
group_price_id
integerÂ
required
timezone
integerÂ
required
bn1
stringÂ
required
bn1_label
stringÂ
required
bn2_label
stringÂ
required
bn2
stringÂ
required
starting_balance
integerÂ
required
type
integerÂ
required
birth_date
stringÂ
required
gender
integerÂ
required
map_location
stringÂ
required
credit_limit
integerÂ
required
credit_period
integerÂ
required
Examples
Responses
🟢202Success
application/json
Body
result
stringÂ
required
code
integerÂ
required
id
stringÂ
required
client_number
stringÂ
required