Skip to main content

Create Company

Creates a new company record in the system.

Authentication

This endpoint requires authentication. See Authentication for details.

Parameters

ParameterTypeRequiredDescription
namestringYesName of the company
companyCodestringYesUnique company code
countryCodestringYesTwo-letter ISO country code
legalNumberstringYesGovernment-issued registration number
contactEmailstringYesPrimary contact email address
phonestringYesPhone number including country code
abmCodestringNoABM 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

PropertyTypeDescription
statusCodenumberHTTP status code of the response
messagestringDescription of the response status
envelopobjectObject containing the created company data

Company Properties

PropertyTypeDescription
idstringUnique identifier of the company
createdAtstringDate/time when the company was created (ISO 8601)
namestringName of the company
legalNumberstringLegal registration number (e.g., tax ID)
countryCodestringCountry code in ISO 3166-1 alpha-2 format
companyCodestringCustom code for identifying the company
contactEmailstringContact email address
phonestringPhone number including country code
webhookUrlstringURL for receiving company event webhooks (nullable)
abmCodestringInternal 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.