Sign in

v1

latestOpenAPI 3.0.02026-07-24161168406.5 KB
Area
Area

Create a new area

Creates a new area in the company.

Business Rules:

  • name: Required. Maximum 300 characters.
  • externalCode: Required. Maximum 50 characters. Must be unique within the company.
  • similarity: Required. Must be a valid area similarity value.
  • description: Optional. Maximum 900 characters.
  • organizationUnit: Optional. If provided, identify the department by uuid and/or externalCode (at least one). If both are sent, uuid is used for lookup.
  • costCenter: Optional. If provided, identify the cost center by uuid and/or externalCode (at least one). If both are sent, uuid is used for lookup.

Validation:

  • All required fields must be provided and not empty.
  • The externalCode must not already exist for another area in the same company.
post/os/v1/areas

Request body

namestring required

area name

similarity'ADMINISTRATIVE' | 'FINANCIAL' | 'AGRONOMY' | 'ARCHITECTURE' | 'AUDITING' | 'QUALITY' | 'CUSTOMER_SERVICE' | 'COMMERCIAL' | 'PURCHASING' | 'COMMUNICATION' | 'DESIGN' | 'MARKETING' | 'ACCOUNTING' | 'CONTROLLING' | 'ENGINEERING' | 'MAINTENANCE' | 'TECHNICAL_SERVICES' | 'LEGAL' | 'INNOVATION' | 'PRODUCT' | 'LOGISTICS' | 'OPERATION' | 'PROJECTS' | 'PROCESSES' | 'HUMAN_RESOURCES' | 'SECURITY' | 'TECHNOLOGY' required

Area Similarity

externalCodestring required

Area external code

descriptionstring

Area description

Example request

{
  "name": "Produto Digital",
  "similarity": "ACCOUNTING",
  "externalCode": "A-F98",
  "description": "Area Description"
}

Response

The area has been successfully created.