Billing

Save a billing profile

View as Markdown

PUThttps://paysuitett.com/api/v1/billing-profiles/{customerId}

Upserts a customer's profile. Customer and project IDs must belong to this business. Unknown body fields are rejected.

Access. Master key, or a personal key held by an owner/admin or accountant. The business must have the invoices service. Runs as the holder under their row-level security.

Path parameters

customerIdstring · uuid
Customer ID.

Body

A JSON object. Fields marked required must be sent.

hourlyRatenumberrequired
Nonnegative hourly rate in the profile's currency, or null for project rates.
clientNamesarrayrequired
Time client names.
projectIdsarrayrequired
Project UUIDs in this business.
groupBystringrequired
How to group invoice lines.Allowed:projectproject_tasksingle
cadenceDaysintegerrequired
Days per period, 7–31.
currencystring
Currency this customer is billed in; kept when omitted, TTD for a new profile.
exchangeRatenumber
Default TTD for one unit of the currency, used for drafts from time; null clears it. Required for a foreign currency when drafting.
conversionFeePercentnumber
Default conversion fee percentage for this customer's foreign-currency drafts; null for none.
conversionFeeTtdnumber
Default fixed conversion fee in TTD for this customer's foreign-currency drafts; null for none.
invoiceNumberPrefixstring
Up to 5 letters or digits. Posted invoices with a service period are numbered PREFIX-YYYYMMDD-MMDD (a letter is added for a second invoice for the same period); null returns to INV- numbers.

Response

200 with a JSON body, as in the example.