Skip to main content
POST
/
business-units
Create a business unit
curl --request POST \
  --url https://www.ruddr.io/api/workspace/business-units \
  --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": "e8b4d2a9-5c31-4f87-90d6-f3a7c6e02b48",
  "name": "East Region",
  "isActive": true,
  "companyName": "Acme Corp - East",
  "streetAddress": "123 Broadway\nNew York, NY 10001",
  "invoiceSubject": "Invoice for services rendered - East Region",
  "invoiceNotes": "Payment due within terms specified.",
  "invoiceEmailSubject": "Your invoice from Acme Corp - East",
  "invoiceEmailBody": "Please find your invoice attached. Thank you for your business.",
  "invoiceEmailFromName": "Acme East Billing",
  "invoiceEmailReplyTo": "billing-east@acmecorp.com",
  "invoiceTaxableItems": [
    "services"
  ],
  "createdAt": "2026-02-20T09:35:18.442Z",
  "invoicePaymentTerm": {
    "id": "a1d8c4e7-3b29-4f86-91d5-e0b7c6f03a19",
    "name": "Net 15",
    "type": "net",
    "days": 15
  },
  "invoiceTaxRate": null
}
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.

Body

application/json
​
name
string
required

The name of the business unit. Max 255 characters.

​
isActive
boolean

Whether the business unit is active. Defaults to true if not provided.

​
companyName
string

The company name displayed on invoices for this business unit. Defaults to the workspace's company name if not provided. 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. Defaults to the workspace's payment term if not provided.

​
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.