setup_trade
Set up or update the business quoting profile
Create a business, or update its saved settings (call with trade_key to update). Saves the rates and rules every quote uses: day and hour rates, labourer rate, materials markup, VAT registration and number, CIS, deposit rule, validity, payment terms, standard exclusions, brand colour, logo (https link or base64; PNG or JPEG for the PDF), quote number prefix, price book. On first call returns trade_key ONCE: store it securely, every other tool needs it. Also returns nero_trade_ref, the same identity the Nero Work exchange and Spark Pack use. Money in pounds.
输入参数emailphonetradesaddressdepositwebsiteday_ratelogo_urlpostcodehour_ratetrade_keyvat_number另有 20 个
get_trade
Show the business profile, price book, stats and free allowance
The trade's saved settings, price book (most used first), quote stats (win rate, value won in the last 12 months) and, for a business that is not VAT registered, a warning when accepted work is nearing the £90,000 VAT registration threshold.
输入参数trade_key必填
save_price_items
Save materials to the price book
Add or update materials in the trade's price book, so later quotes can use { code, qty } and the cost, unit and markup fill in. Materials used in quotes are also remembered automatically.
输入参数trade_key必填price_items必填
draft_quote
Draft a priced, VAT-correct quote
Price a job after a site visit. Give the job, customer, labour (time, priced from the saved rate), materials (trade cost, marked up), other costs and optional extras; the server applies VAT correctly (registered or not, 20/5/0%, the construction domestic reverse charge for contractor customers), the deposit rule, validity, exclusions and a running quote number. Returns the totals, the trade-only margin view, warnings, a check_before_sending list of commonly forgotten items for that trade, and the links to the PDF and the customer's phone page (a DRAFT until finalise_quote). from_quote copies a past quote's lines for a new customer. save false returns the numbers without saving.
输入参数savenotesotherstarttitle必填tradelabourdepositsummarycustomer必填discountduration另有 10 个
revise_quote
Change or withdraw a quote
Change a quote. Send only the fields that change (a list you send, such as materials, replaces that whole list). A draft stays a draft. A quote the customer already has becomes the next revision on the same link, with fresh dates, and any earlier answer is cleared. Accepted quotes cannot change. status "withdrawn" pulls a quote. use_current_settings true re-prices with the trade's latest rates.
输入参数notesotherquote必填starttitletradelabourreasonstatusdepositsummarycustomer另有 12 个
finalise_quote
Finalise a quote and get the customer link
Lock a draft so the customer can answer it. Sets today's date and the valid-until date, and returns the customer link, the PDF link and a short ready-to-send message. Nothing is sent by this server: the trade sends the link by their own text, WhatsApp or email. Free allowance: 5 finalised quotes per calendar month (UK time) per trade, shown as free_allowance in the answer and in get_trade; past it the quote stays a saved draft and can be finalised from the 1st of next month. Drafts, revisions of quotes already sent, replies and exports never count.
输入参数quote必填trade_key必填
quote_activity
See what customers did with quotes
What customers have done since the trade last checked: quotes opened, accepted (with the name they signed, extras ticked and final total), questions asked, declined. Marks them as seen unless mark_seen is false. Call this when the trade asks "any news on my quotes?".
输入参数mark_seentrade_key必填
get_quote
Show one quote in full
One quote in full: lines, totals, VAT working with HMRC sources, margins (trade only), the customer's answer, history (drafted, sent, opened, accepted) and links.
输入参数quote必填trade_key必填
Recent quotes, newest first, with status (draft, sent, viewed, queried, accepted, declined, expired, withdrawn), total and whether there is news. Filter by status or search customer name, job title or number.
输入参数limitsearchstatustrade_key必填
reply_to_customer
Answer a customer question on the quote page
Answer a customer's question. The answer shows on their quote page under their question. Use revise_quote instead if the price or scope changes.
输入参数quote必填message必填trade_key必填
export_to_nero_work
Export a quote in Nero Work format
The quote in the exact argument shape of the Nero Work exchange's submit_quote tool (labour_minor, materials_minor, vat_minor in pence, validity_hours, exclusions, notes), checked with Nero Work's own rules. If the customer accepted with extras, they are included.
输入参数quote必填trade_key必填