Add Company
POST
/companies
Maintainer:Not configured
Request
Body Params multipart/form-data
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/companies' \
--header 'Authorization: <api-key>' \
--form 'name=""' \
--form 'city=""' \
--form 'state=""' \
--form 'country=""' \
--form 'address=""' \
--form 'addressLine2=""' \
--form 'logo=""' \
--form 'taxRegistrationCertificate=""' \
--form 'contactInfo=""' \
--form 'taxRegistrations=""'Response Response Example
{
"success": true,
"data": {
"id": "string",
"accountId": "string",
"name": "string",
"taxRegistrations": [
"string"
],
"invoices": [
{
"id": "string",
"companyId": "string",
"clientId": "string",
"number": 0,
"prefix": "string",
"financialYear": "string",
"date": "string",
"dueDate": "string",
"status": "string",
"currency": "string",
"createdAt": "string",
"lineItems": [
{
"id": "string",
"invoiceId": "string",
"itemId": "string",
"type": "GOODS",
"description": "string",
"price": 0,
"quantity": 0,
"unit": "string",
"sortOrder": 0,
"createdAt": "string",
"taxId": "string"
}
],
"client": {},
"company": {},
"discountType": "percentage",
"discountValue": 0,
"paymentStatus": "paid",
"payments": [
{
"id": "inv_pay_123",
"amount": 1000,
"currencyCode": "USD",
"paymentDate": "2024-03-15",
"notes": "Payment for March services",
"referenceNumber": "REF123",
"createdAt": "2024-03-15T10:30:00Z",
"invoice": {
"id": "inv_123",
"number": 1001,
"prefix": "INV",
"date": "2024-03-10"
}
}
]
}
],
"logoURL": "string",
"address": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"country": "string",
"industry": "string",
"defaultCurrencyCode": "string",
"contactInfo": [
{
"name": "string",
"email": "string",
"phone": "string"
}
],
"projects": [
{
"id": "string",
"clientId": "string",
"companyId": "string",
"name": "string",
"description": "string",
"client": {
"id": "string",
"companyId": "string",
"name": "string",
"isCompany": true,
"address": "string",
"contactInfo": [
{
"name": "string",
"phone": "string",
"email": "string"
}
],
"createdAt": "string",
"company": {}
},
"company": {},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"status": "pending",
"timesheets": [
"string"
],
"startDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"rate": 0,
"teamMembers": [
{
"id": "string",
"username": "string",
"firstName": "string",
"lastName": "string",
"title": "string",
"designation": "string"
}
],
"tags": [
{}
]
}
],
"invoiceSettings": {}
},
"errors": [
"string"
]
}Modified at 2025-05-14 11:50:50