Business Units

Get a business unit

get/business-units/{id}

Request

  • Base URL: https://www.ruddr.io/api/workspace
  • URL: https://www.ruddr.io/api/workspace/business-units/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The business unit uuid.

Response

200

idstring

The unique identifier for the object.

namestring

The name of the business unit.

isActiveboolean

Whether the business unit is active.

companyNamestring nullable

The company name displayed on invoices for this business unit.

streetAddressstring nullable

The street address displayed on invoices for this business unit.

invoiceSubjectstring nullable

The default subject line for invoices.

invoiceNotesstring nullable

The default notes for invoices.

invoiceEmailSubjectstring nullable

The default email subject when sending invoices.

invoiceEmailBodystring nullable

The default email body when sending invoices.

invoiceEmailFromNamestring nullable

The sender name used when emailing invoices.

invoiceEmailReplyTostring nullable

The reply-to email address used when emailing invoices.

invoiceTaxableItemsstring[]

The types of invoice line items that are taxable.

createdAtstring date-time

The timestamp when the object was created.

Example response

{
  "id": "d7a3f1e8-4c29-4b85-91d0-e6b7c2f03a18",
  "name": "West Region",
  "isActive": true,
  "companyName": "Acme Corp - West",
  "streetAddress": "456 Market St\nSan Francisco, CA 94105",
  "invoiceSubject": "Invoice for services rendered - West Region",
  "invoiceNotes": "Payment due within terms specified.",
  "invoiceEmailSubject": "Your invoice from Acme Corp - West",
  "invoiceEmailBody": "Please find your invoice attached. Thank you for your business.",
  "invoiceEmailFromName": "Acme West Billing",
  "invoiceEmailReplyTo": "billing-west@acmecorp.com",
  "invoiceTaxableItems": [
    "services",
    "expenses"
  ],
  "createdAt": "2025-08-12T14:23:41.882Z",
  "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
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.