Get account settings

200Account details.

• dataobjectrequired

  Fields(49)

  • lock_versioninteger

    At least 0.

  • created_atstring (date-time)required

  • updated_atstring (date-time)required

  • idstring (uuid)required

  • namestringrequired

  • slugstringrequired

  • default_currencystringrequired

  • time_zonestringrequired

  • country_codestringrequired

  • business_emailstring (email) or null

  • business_phonestring or null

  • business_addressstring or null

  • latitudenumber (double) or null

    Where a day's route sets out from, to the middle of the postcode in `business_address`. Null until it has been looked up, and when the address holds no postcode with a position.

    At least -90. At most 90. Read only.

  • longitudenumber (double) or null

    At least -180. At most 180. Read only.

  • tax_numberstring or null

  • legal_namestring or null

    Registered company name, or the owner's name for a sole trader. Printed in the document footer.

    Up to 255 characters.

  • company_numberstring or null

    Companies House number. Spaces are removed and letters upper-cased.

    Matches ^[A-Z0-9]{8}$.

  • websitestring or null

    Up to 255 characters.

  • bank_account_namestring or null

    Up to 255 characters.

  • bank_sort_codestring or null

    Dashes and spaces are removed.

    Matches ^[0-9]{6}$.

  • bank_account_numberstring or null

    Spaces are removed.

    Matches ^[0-9]{8}$.

  • invoice_email_templatestring or null

    The note the document is emailed with. Null means TradeSender's default. Placeholders in square brackets are filled in: [First name], [Customer], [Number], [Title], [Amount], [Due date], [Valid until], [Link], [Business] and [Your name].

    Up to 2000 characters.

  • quote_email_templatestring or null

    The note the document is emailed with. Null means TradeSender's default. Placeholders in square brackets are filled in: [First name], [Customer], [Number], [Title], [Amount], [Due date], [Valid until], [Link], [Business] and [Your name].

    Up to 2000 characters.

  • invoice_reminder_email_templatestring or null

    The note an overdue invoice's reminder goes with. Null means TradeSender's default. It takes the placeholders of the invoice note; [Amount] is what is still owed, and [Your name] is the business, since nobody sends it.

    Up to 2000 characters.

  • quote_follow_up_email_templatestring or null

    The note a quote's follow-up goes with. Null means TradeSender's default. It takes the placeholders of the quote note; [Your name] is the business, since nobody sends it.

    Up to 2000 characters.

  • visit_reminder_email_templatestring or null

    The note a customer is reminded of tomorrow's visits with. Null means TradeSender's default. Placeholders: [First name], [Customer], [Business], [Visit date] and [Visits], which becomes one line for each visit with its times, what it is for and where. A note without [Visits] gets the list at the end.

    Up to 2000 characters.

  • on_my_way_email_templatestring or null

    The note a customer is told somebody is on the way with. Null means TradeSender's default. Placeholders: [First name], [Customer], [Business], [Your name], [Property] and [Arrival].

    Up to 2000 characters.

  • invoice_reminders_enabledboolean

    Remind customers by email about overdue invoices: `invoice_reminder_first_days` after the due date, then every `invoice_reminder_gap_days`, `invoice_reminder_limit` times at most, between 9 am and 5 pm in the workspace's time zone. Turning this on, or changing one of those three, starts the count again: nothing goes that day, an invoice not yet reminded waits `invoice_reminder_first_days` from then, and one already reminded waits `invoice_reminder_gap_days`. Nothing is sent for an invoice that is paid, void, archived or being collected, to a customer with no email address, or while `plan_limits.automation` is 0. A customer's `invoice_reminders`, and an invoice's own, decide for them whatever this says.

  • quote_follow_ups_enabledboolean

    Follow up by email a quote still awaiting an answer, 3 and 10 days after it was first emailed to the customer, between 9 am and 5 pm in the workspace's time zone. Only quotes emailed after this is turned on are followed up, and never one that was only marked as sent, has expired, or was emailed again in the last 3 days. Nothing is sent to a customer with no email address, or while `plan_limits.automation` is 0. A customer's `quote_follow_ups` decides for them whatever this says.

  • visit_reminders_enabledboolean

    Remind customers by email of tomorrow's visits: one email for all of a customer's visits that day, sent between 5 pm and 9 pm in the workspace's time zone the day before. A visit gets one reminder (`reminder_sent_at`); one that moveCalendarDay moves to another day is due its reminder again. Nothing is sent to a customer with no email address, or while `plan_limits.automation` is 0. A customer's `visit_reminders` decides for them whatever this says.

  • invoice_reminder_first_daysinteger

    How many days after its due date an overdue invoice is first reminded.

    Default: 3. At least 1. At most 60.

  • invoice_reminder_gap_daysinteger

    How many days after one reminder about an invoice the next is sent.

    Default: 14. At least 1. At most 90.

  • invoice_reminder_limitinteger

    The most reminders sent about one invoice by themselves. A reminder sent with sendInvoiceReminder counts towards it.

    Default: 3. At least 1. At most 10.

  • automatic_email_summaries_enabledboolean

    Email the workspace's owners, on a day when the workspace sent any of its automatic emails, a list of what went to whom. It is sent after 9 pm in the workspace's time zone, and not on a day when none went.

    Default: true.

  • quote_introstring or null

    A short line shown above the work on the customer's quote page and PDF. Null shows nothing.

    Up to 255 characters.

  • quote_termsstring or null

    Terms shown on the customer's quote page and PDF when the quote has no terms of its own.

    Up to 2000 characters.

  • logo_urlstring (uri) or null

    A signed link to the logo printed on documents. It expires after 24 hours.

  • planstring

    One of: free, pro, business.

  • plan_limitsobject

    What a plan allows; on an account, the plan in use, so a screen can say so before a save is refused. `null` means unlimited.

    Fields(4)

    • membersinteger or null

    • visits_per_monthinteger or null

    • visit_seriesinteger or null

    • automationinteger or null

      Automatic emails and Direct Debit collection: `0` when the plan does not include them, `null` when it does.

  • complete_jobs_automaticallyboolean

    Deprecated: always true and ignored on write. The last visit of a one-off job completes it unless the finish says the crew is coming back.

    Deprecated.

  • mail_providerstring or null

    `smtp`, `google` or `microsoft`: the mailbox quotes and invoices are sent from. Null when TradeSender sends them.

  • mail_from_addressstring (email) or null

  • tradesarray of string

    What the business does, from the set-up questions.

  • team_sizestring or null

    Just me, 2 to 5 people, or 6 or more.

    One of: solo, small, larger.

  • onboarded_atstring (date-time) or null

    When the owner answered or skipped the set-up questions. Null until then.

  • setup_dismissed_atstring (date-time) or null

    When the Get set up list on Today was hidden.

  • enquiry_formobject

    The workspace's website enquiry form. The key sits in other people's web pages and only lets them send an enquiry. An owner replaces it in the app.

    Fields(4)

    • keystringrequired

    • page_urlstring (uri)required

      The hosted form, to share as a link.

    • post_urlstring (uri)required

      Where forms post (submitEnquiry).

    • script_urlstring (uri)required

      The script that draws the form on the business's own website.

  • portal_urlstring (uri)

    Where the business's customers sign in to their customer portal. Not a secret: it can go on the business's website.

    Read only.

  • stripe_connectobject or null

    The business's own Stripe account, through which its customers pay invoices online. Null until an owner starts connecting one. The money, Stripe's fees and any disputes are between the business and Stripe.

    Read only.

    Fields(2)

    • statusstringrequired

      `onboarding` while the account is being set up; `active` once it can take card payments and Stripe wants nothing more; `restricted` when Stripe is waiting for more information from the business. Invoices can be paid online whenever `capabilities` has `card_payments`, whatever the status.

      One of: onboarding, active, restricted.

    • capabilitiesarray of stringrequired

      The ways of paying that are switched on and working, in Stripe's names: `card_payments`, `pay_by_bank_payments`, `bacs_debit_payments` and others.