Save company settings

PUT/api/configs/company

Updates the company configuration for the current workspace.

Request Body

application/json

Request payload for Save company settings.

shortName*string

Short company name.

Example"Recerc"

companyName*string

Legal or public company name.

Example"Recerc Inc."

companyDescription?|

Company description used in sales documents.

website?|

Primary company website URL.

phoneNumber?|

Primary company phone number.

address?|

Company billing or mailing address.

contactEmail?|

Primary company contact email.

contactFax?|

Fax number shown when configured.

logoFileId?|

Workspace file id for a company logo uploaded through the media bucket.

logoUrl?|

Legacy absolute URL for the company logo. Prefer logoFileId for new uploads.

currencyCode*string

Default workspace currency code.

Example"CLP"

allowedCurrencies?array<>||

Currency codes enabled for the company. Null means all supported currencies are allowed.

orderNumberPrefix*string

Prefix used for generated order numbers.

Example"SO-"

salesOrderNumberPrefix?|

Prefix used for generated sales order numbers.

orderNumberBase*||||

order number base.

invoiceDefaultFooterText?|

Default invoice footer copy.

defaultPaymentTerms?|

Default payment terms label.

defaultPriceListId?|

Default price list identifier.

salesOrdersEnabled?|

Whether sales orders are enabled for the workspace.

[key: string]?never

Response Body

`application/json`

curl -X PUT "https://loading/api/configs/company" \  -H "Content-Type: application/json" \  -d '{    "shortName": "Recerc",    "companyName": "Recerc Inc.",    "currencyCode": "CLP",    "orderNumberPrefix": "SO-",    "orderNumberBase": 0  }'

{
  "shortName": "Recerc",
  "companyName": "Recerc Inc.",
  "companyDescription": "Revenue operations software for product teams.",
  "website": "https://recerc.com",
  "phoneNumber": "+56 2 2345 6789",
  "address": "Nueva Tajamar 481, Las Condes",
  "contactEmail": "hello@recerc.com",
  "contactFax": "+56 2 2345 6790",
  "logoFileId": "workspace_123/company-logo/logo.png",
  "logoUrl": "https://cdn.recerc.com/logo.png",
  "currencyCode": "CLP",
  "allowedCurrencies": [
    "CLP",
    "USD"
  ],
  "orderNumberPrefix": "SO-",
  "salesOrderNumberPrefix": "VEN-",
  "orderNumberBase": 0,
  "invoiceDefaultFooterText": "Thank you for your business.",
  "defaultPaymentTerms": "Net 30",
  "defaultPriceListId": "pl_123",
  "salesOrdersEnabled": false
}

{
  "_tag": "ApiBadRequestError",
  "code": "PRICE_IMPORT_DUPLICATE_SKUS",
  "message": "The request payload is invalid.",
  "description": "Remove duplicate SKU rows before importing the file.",
  "details": {}
}

{
  "_tag": "Unauthorized"
}

{
  "_tag": "ApiForbiddenError",
  "message": "You do not have permission to perform this action."
}

{
  "_tag": "ApiNotFoundError",
  "message": "The requested resource was not found."
}

{
  "_tag": "ApiConflictError",
  "message": "A resource with this handle already exists."
}

{
  "_tag": "ApiUnprocessableEntityError",
  "message": "The order cannot be submitted without items."
}

{
  "_tag": "ServiceUnavailable"
}

{
  "_tag": "ApiTimeoutError",
  "message": "The upstream operation timed out."
}

Save company settings

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`