Save company settings

PUT/api/unstable/configs/company

Updates the company configuration for the current workspace.

Request Body

application/json

shortName*string

Short company name.

Example"Recerc"

companyName*string

Legal or public company name.

Example"Recerc Inc."

companyDescription?string

Company description used in sales documents.

Example"Revenue operations software for product teams."

website?string

Primary company website URL.

Example"https://recerc.com"

phoneNumber?string

Primary company phone number.

Example"+56 2 2345 6789"

address?string

Company billing or mailing address.

Example"Nueva Tajamar 481, Las Condes"

contactEmail?string

Primary company contact email.

Example"hello@recerc.com"

contactFax?string

Fax number shown when configured.

Example"+56 2 2345 6790"

logoUrl?string

Absolute URL for the company logo.

Example"https://cdn.recerc.com/logo.png"

currencyCode*string

Default workspace currency code.

Example"CLP"

allowedCurrencies?array<>|

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

Example

[
  "CLP",
  "USD"
]

orderNumberPrefix*string

Prefix used for generated order numbers.

Example"SO-"

orderNumberBase*number

Starting sequence number for order generation.

Example1000

invoiceDefaultFooterText?string

Default invoice footer copy.

Example"Thank you for your business."

defaultPaymentTerms?string

Default payment terms label.

Example"Net 30"

defaultPriceListId?string

Default price list identifier.

Example"pl_123"

[key: string]?never

Response Body

`application/json`

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

{
  "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",
  "logoUrl": "https://cdn.recerc.com/logo.png",
  "currencyCode": "CLP",
  "allowedCurrencies": [
    "CLP",
    "USD"
  ],
  "orderNumberPrefix": "SO-",
  "orderNumberBase": 1000,
  "invoiceDefaultFooterText": "Thank you for your business.",
  "defaultPaymentTerms": "Net 30",
  "defaultPriceListId": "pl_123"
}

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

Empty

{
  "message": "string",
  "_tag": "ApiForbiddenError"
}

{
  "message": "string",
  "_tag": "ApiNotFoundError"
}

{
  "message": "string",
  "_tag": "ApiConflictError"
}

{
  "message": "string",
  "_tag": "ApiUnprocessableEntityError"
}

Empty

{
  "message": "string",
  "_tag": "ApiTimeoutError"
}

Save company settings

Request Body

Response Body

200application/json

400application/json

401

403application/json

404application/json

409application/json

422application/json

503

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`