Create Company
Creates a new company record in the system.
Authentication
This endpoint requires authentication. See Authentication for details.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Name of the company |
| companyCode | string | Yes | Unique company code |
| countryCode | string | Yes | Two-letter ISO country code |
| legalNumber | string | Yes | Government-issued registration number |
| contactEmail | string | Yes | Primary contact email address |
| phone | string | Yes | Phone number including country code |
| abmCode | string | No | ABM integration code (optional) |
Request
Production URL: https://orchestrator.tecspal.com/
Sandbox URL: https://tecspal-orchestrator.sandbox.lexartlabs.uy/
Endpoint: POST /companies
Example Request
{
"request": "companies",
"vendor": "tecspal",
"verb": "POST",
"data": {
"name": "New Company",
"companyCode": "NCY",
"countryCode": "UY",
"legalNumber": "DC12312321",
"contactEmail": "newcompany@email.com",
"phone": "+598 99999999",
"abmCode": "abmcode123"
}
}
Response Schema
| Property | Type | Description |
|---|---|---|
| statusCode | number | HTTP status code of the response |
| message | string | Description of the response status |
| envelop | object | Object containing the created company data |
Company Properties
| Property | Type | Description |
|---|---|---|
| id | string | Unique identifier of the company |
| createdAt | string | Date/time when the company was created (ISO 8601) |
| name | string | Name of the company |
| legalNumber | string | Legal registration number (e.g., tax ID) |
| countryCode | string | Country code in ISO 3166-1 alpha-2 format |
| companyCode | string | Custom code for identifying the company |
| contactEmail | string | Contact email address |
| phone | string | Phone number including country code |
| webhookUrl | string | URL for receiving company event webhooks (nullable) |
| abmCode | string | Internal ABM system code for the company |
{
"statusCode": 201,
"message": "Request successful",
"envelop": [
{
"id": "fd677355-91ed-49a6-b7f6-ae076798f45c",
"createdAt": "2025-04-14T21:35:04.626Z",
"name": "New Company",
"legalNumber": "DC12312321",
"countryCode": "UY",
"companyCode": "NCY",
"contactEmail": "newcompany@email.com",
"phone": "+598 99999999",
"webhookUrl": null,
"abmCode": "abmcode123"
}
]
}
Error Responses
Bad Request (400)
{
"statusCode": 400,
"message": "name should not be empty",
"envelop": []
}
Unauthorized (401)
{
"statusCode": 401,
"message": "Unauthorized access",
"envelop": []
}
Conflict (409)
{
"message": "companyCode already exists",
"statusCode": 409,
"envelop": []
}
Notes
- companyCode should be unique.
- Phone numbers should include the country code and + symbol.