Skip to main content
PATCH
/
business-units
/
{id}
Update a business unit
curl --request PATCH \
  --url https://www.ruddr.io/api/workspace/business-units/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "isActive": true,
  "companyName": "<string>",
  "streetAddress": "<string>",
  "invoiceSubject": "<string>",
  "invoiceNotes": "<string>",
  "invoiceEmailSubject": "<string>",
  "invoiceEmailBody": "<string>",
  "invoiceEmailFromName": "<string>",
  "invoiceEmailReplyTo": "<string>",
  "invoicePaymentTermId": "<string>",
  "invoiceTaxRateId": "<string>",
  "invoiceTaxableItems": [
    "services"
  ]
}
'
{
  "id": "d2f9a5e3-7c41-4b86-80d0-e3b7c6f02a19",
  "name": "West Region (Updated)",
  "isActive": true,
  "companyName": "Acme West LLC",
  "streetAddress": "456 Market St\nSuite 200\nSan Francisco, CA 94105",
  "invoiceSubject": "Invoice - West Region",
  "invoiceNotes": "Net terms apply. Late fees may be assessed.",
  "invoiceEmailSubject": "Invoice from Acme West LLC",
  "invoiceEmailBody": "Please review the attached invoice at your earliest convenience.",
  "invoiceEmailFromName": "Acme West Finance",
  "invoiceEmailReplyTo": "finance-west@acmecorp.com",
  "invoiceTaxableItems": [
    "services",
    "expenses"
  ],
  "createdAt": "2025-11-18T11:25:42.891Z",
  "invoicePaymentTerm": {
    "id": "b4e1c7a9-2d38-4f96-80d5-f3a7e6c02b19",
    "name": "Net 30",
    "type": "net",
    "days": 30
  },
  "invoiceTaxRate": {
    "id": "c9d2e5b8-3f47-4a81-92d6-e1b7c4f03a28",
    "name": "Standard Tax",
    "rate": 8.5
  }
}
A named organizational unit used to configure invoice settings and group clients and projects.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The business unit uuid.

Body

application/json
​
name
string

The name of the business unit. Max 255 characters.

​
isActive
boolean

Whether the business unit is active.

​
companyName
string

The company name displayed on invoices for this business unit. Max 255 characters.

​
streetAddress
string | null

The street address displayed on invoices for this business unit. Max 5000 characters.

​
invoiceSubject
string | null

The default subject line for invoices. Max 255 characters.

​
invoiceNotes
string | null

The default notes for invoices. Max 5000 characters.

​
invoiceEmailSubject
string | null

The default email subject when sending invoices. Max 255 characters.

​
invoiceEmailBody
string | null

The default email body when sending invoices. Max 5000 characters.

​
invoiceEmailFromName
string | null

The sender name used when emailing invoices. Max 255 characters.

​
invoiceEmailReplyTo
string | null

The reply-to email address used when emailing invoices. Max 255 characters.

​
invoicePaymentTermId
string

The unique identifier of the default payment term for invoices.

​
invoiceTaxRateId
string | null

The unique identifier of the default tax rate for invoices.

​
invoiceTaxableItems
enum<string>[]

The types of invoice line items that are taxable.

Available options:
services,
expenses,
other_items

Response

200

​
id
string

The unique identifier for the object.

​
name
string

The name of the business unit.

​
isActive
boolean

Whether the business unit is active.

​
companyName
string | null

The company name displayed on invoices for this business unit.

​
streetAddress
string | null

The street address displayed on invoices for this business unit.

​
invoiceSubject
string | null

The default subject line for invoices.

​
invoiceNotes
string | null

The default notes for invoices.

​
invoiceEmailSubject
string | null

The default email subject when sending invoices.

​
invoiceEmailBody
string | null

The default email body when sending invoices.

​
invoiceEmailFromName
string | null

The sender name used when emailing invoices.

​
invoiceEmailReplyTo
string | null

The reply-to email address used when emailing invoices.

​
invoiceTaxableItems
enum<string>[]

The types of invoice line items that are taxable.

Available options:
services,
expenses,
other_items
​
createdAt
string<date-time>

The timestamp when the object was created.

​
invoicePaymentTerm
object

The default payment term for invoices.

​
invoiceTaxRate
object

The default tax rate for invoices.