Clients

Create a client

post/clients

Request

  • Base URL: https://www.ruddr.io/api/workspace
  • URL: https://www.ruddr.io/api/workspace/clients
  • Auth: HTTP bearer

Request body

keystring

The URL-friendly slug for the client. Will be autogenerated from name if not provided. Max 255 characters.

namestring required

The name of the client. Max 255 characters.

codestring nullable

The client code. Max 255 characters.

currencystring

The 3-letter currency code associated with the client. Defaults to the workspace currency if not supplied.

notesstring nullable

Notes associated with the client. Max 5000 characters.

emailsstring[]

Email addresses used for invoicing the client.

streetAddressstring nullable

The street address of the client used for invoicing. Max 5000 characters.

invoiceDetailsSource'workspace' | 'custom' | 'business_unit'

The source of invoice details. Defaults to workspace. When workspace or business_unit, the invoicePaymentTermId, invoiceSubject, invoiceNotes, invoiceEmailSubject, and invoiceEmailBody values are inherited.

invoiceSubjectstring nullable

The subject line used on invoices for this client. Max 255 characters.

invoiceNotesstring nullable

Notes included on invoices for this client. Max 5000 characters.

invoiceEmailSubjectstring nullable

The email subject line used when sending invoices for this client. Max 255 characters.

invoiceEmailBodystring nullable

The email body used when sending invoices for this client. Max 5000 characters.

recordStatusId'active' | 'archived'

The record status of the client. Defaults to active.

ownerIdstring nullable

The member ID (uuid) of the owner of this client.

practiceIdstring nullable

The practice ID (uuid) of the practice associated with this client.

industryIdstring nullable

The industry ID (uuid) of the industry associated with this client.

locationIdstring nullable

The location ID (uuid) of the location associated with this client.

tagIdsstring[]

A list of client tag IDs (uuid) to associate with this client.

invoicePaymentTermIdstring

The payment term ID (uuid) used for invoicing the client.

salesRepresentativeIdstring nullable

The member ID (uuid) of the sales representative for this client.

businessUnitIdstring nullable

The business unit ID (uuid) of the business unit associated with this client.

Response

200

idstring

The unique identifier for the object.

keystring

The URL-friendly slug for the client.

namestring

The name of the client.

codestring nullable

The client code.

currencystring

The 3-letter currency code associated with the client.

notesstring nullable

Notes associated with the client.

emailsstring[]

Email addresses used for invoicing the client.

streetAddressstring nullable

The street address of the client used for invoicing.

invoiceDetailsSource'workspace' | 'custom' | 'business_unit'

The source of invoice details for this client. Determines whether invoice settings are inherited from the workspace, the assigned business unit, or configured at the client level.

invoiceSubjectstring nullable

The subject line used on invoices for this client.

invoiceNotesstring nullable

Notes included on invoices for this client.

invoiceEmailSubjectstring nullable

The email subject line used when sending invoices for this client.

invoiceEmailBodystring nullable

The email body used when sending invoices for this client.

isInternalboolean

Indicates whether this is the workspace's internal client. This client is auto-created during workspace setup.

recordStatusId'active' | 'archived'

The record status of the client.

createdAtstring date-time

The timestamp when the object was created.

modifiedAtstring date-time

The timestamp when the object was last modified.

useWorkspaceInvoiceDetailsboolean

A legacy read-only field indicating whether the client uses workspace-level invoice details. Use invoiceDetailsSource instead.

Changes

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