POST
Create Company
Creates a new Company.
Important
Calls to this method must include the cookie .LawPanel.AuthCookie in order to identify you at user level. For more details about authentication please check this link. To obtain the cookie you can use the method Login.
Request URL
Request headers
string
Subscription key which provides access to this API.
Request body
Payload must contain information about the Company to be created.
Most of the properties are self-explanatory, but these:
- string Optional client_type_id: The ID for the type of Company.To get details of different types available please check this link. If you don't include this value the default type will be "Client".
- string Optional country_id: The ID for the address country. To get details of different countries available please check this link.
Loading...
{
"type": "object",
"properties": {
"client": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"company_registration_number": {
"type": "string"
},
"contact_name": {
"type": "string"
},
"contact_email": {
"type": "string"
},
"contact_number": {
"type": "string"
},
"contact_address": {
"type": "object",
"properties": {
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"line3": {
"type": "string"
},
"building": {
"type": "string"
},
"floor_level": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"city": {
"type": "string"
},
"state_province": {
"type": "string"
},
"region": {
"type": "string"
},
"country_id": {
"type": "string"
}
}
},
"billing_address": {
"type": "object",
"properties": {
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"line3": {
"type": "string"
},
"building": {
"type": "string"
},
"floor_level": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"city": {
"type": "string"
},
"state_province": {
"type": "string"
},
"region": {
"type": "string"
},
"country_id": {
"type": "string"
}
}
}
}
},
"client_type_id": {
"type": "string"
}
},
"example": {
"client": {
"name": "Name of the Company",
"company_registration_number": "Registration Number",
"contact_name": "Contact name",
"contact_email": "contact@email.com",
"contact_number": "+5493875333953",
"contact_address": {
"line1": "Dr. Adolfo Alsina 151",
"line2": "-",
"line3": "-",
"building": "Torres de Alsina",
"floor_level": "2nd",
"postal_code": "4400",
"city": "Salta Capital",
"state_province": "Salta",
"region": "Noroeste Argentino",
"country_id": "4576b6bc-936c-4879-a03c-a68900ad3722"
},
"billing_address": {
"line1": "Dr. Adolfo Alsina 151",
"line2": "-",
"line3": "-",
"building": "Torres de Alsina",
"floor_level": "2nd",
"postal_code": "4400",
"city": "Salta Capital",
"state_province": "Salta",
"region": "Noroeste Argentino",
"country_id": "4576b6bc-936c-4879-a03c-a68900ad3722"
}
},
"client_type_id": "0a246949-d71d-49ae-a17b-a975001bdf45"
}
}
Response 201
If everything happened succesfully returns the model with new Company created.
Loading...
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"company_registration_number": {
"type": "string"
},
"contact_name": {
"type": "string"
},
"contact_email": {
"type": "string"
},
"contact_number": {
"type": "string"
},
"contact_address": {
"type": "object",
"properties": {
"enable": {
"type": "boolean"
},
"id": {
"type": "string"
},
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"line3": {
"type": "string"
},
"building": {
"type": "string"
},
"floor_level": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"city": {
"type": "string"
},
"state_province": {
"type": "string"
},
"region": {
"type": "string"
},
"country_id": {
"type": "string"
},
"country_name": {
"type": "string"
}
}
},
"billing_address": {
"type": "object",
"properties": {
"enable": {
"type": "boolean"
},
"id": {
"type": "string"
},
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"line3": {
"type": "string"
},
"building": {
"type": "string"
},
"floor_level": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"city": {
"type": "string"
},
"state_province": {
"type": "string"
},
"region": {
"type": "string"
},
"country_id": {
"type": "string"
},
"country_name": {
"type": "string"
}
}
},
"client_type": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"code": {
"type": "integer"
},
"name": {
"type": "string"
}
}
}
}
}