Take upfront payments on a booking form and raise the Simpro invoice
Payments takes a card payment when the customer books, then raises an invoice and a customer payment on the new Simpro job. Everything on the page is per form, so two forms on the same account can charge differently.
Before you start
- A Simpro booking form subscription. Without one the page shows "Want to allow payments on your form?" and a link to the subscriptions page.
- A Job form. Payments and Pricing are left out of the form's settings menu for a quote form. If you open the page by its address anyway it says "Payments not available for Quote Forms!".
- A Stripe credential linked under Stripe. Without one the page shows "Stripe integration required!" and no settings, even when Square is linked.
- Customer Email has to be an available, mandatory field on Customer Fields. The page warns "Customer email settings need to be updated!" when it is not.
- Pre-builds or service fees on each service's service template in Simpro. The page's own warning says all services requiring pre-payments must have them, and that their total must be equal to or greater than the amount charged.
Step by step
- Open your form from Forms, then Payments under Form display in Settings.
- Turn on Allow payments.
- Turn on Show payment processor logo if you want the Stripe or Square logo under the payment fields.
- Under Simpro settings, choose the Simpro Payment Method, type the Simpro Deposit Account and, if Simpro needs one, choose the Simpro Accounting Category. The invoice Comment and Footnote are optional.
- Under Form settings, choose the Payment currency, check Currency Display and write the Pricing notes.
- In Service Pricing, tick Allow or Required for each service and fill in Payment amount and Service fee.
- Fill in Optional Services Pricing, Region based add-on pricing and Time based add-on pricing if the form has any of those.
- Click Save. The page shows "Payment details updated."
The Simpro settings and the pricing tables only show once at least one gateway is linked.
The settings
| Setting | What it does |
|---|---|
| Allow payments | Shows the payment step on the form. With it off the pricing stays saved and the page says "Payment form will not appear until Allow payments is turned on." |
| Show payment processor logo | Shows the logo only on services that allow payments, when the amount is more than zero and the gateway checks out. |
| Payment processor | Appears when both Stripe and Square are linked. Only one is used per form. |
| Square location | Appears when Square is the processor. Required to save with Allow payments on. See Square. |
| Simpro Payment Method | Required. Lists the payment methods of the form's Simpro company. |
| Simpro Deposit Account | Required text. Its placeholder is "Stripe". |
| Simpro Accounting Category | Optional. Needed when category tracking is on in Simpro. Lists the company's categories. |
| Simpro Invoice Comment | The invoice description. Starts as "Upfront payment from formpiece.com". |
| Simpro Invoice Footnote | The invoice notes. Left out of the invoice when blank. |
| Payment currency | The currency the gateway charges in. Defaults to AUD. The list is AUD, GBP, CAD, NZD, USD and ZAR. The CAD entry is labelled "Canadian Dollar (GBP)". |
| Currency Display | The symbol shown before prices on the form, up to two characters. Defaults to $. It changes the display and does not convert anything. |
| Pricing notes | Text shown above the amount in the payment step, only when there is something to pay. |
What each service charges
Service Pricing has a row for every service selected on the form. Services that are not selected are greyed out and read only.
| Column | What it does |
|---|---|
| Display price | The sell price shown to the customer. Change it in Services. |
| Calculated price | The inc tax total of the pre-builds and service fees on the service's template in Simpro. Shown for comparison only. |
| Allow Payments? | Allow switches payment on for the service. The payment step is titled "Upfront payment". |
| Payment required? | Required titles the step "Payment required". If the gateway cannot be verified the button changes to "Booking unavailable" and the booking cannot be made. |
| Payment amount | The amount to charge. Numbers only. Leave blank for no charge. |
| Service fee | A Percentage of the payment amount plus a Flat rate. Both are optional. |
| Amount charged | Payment amount plus the percentage and the flat rate. This is what the customer pays. |
| Invoice type | Tax Invoice, Deposit or Progress Claim. Blank means Tax Invoice. |
A service needs Allow or Required ticked and a charge above zero, otherwise the form says "No payment is required." for it.
Optional service variations, region add-ons and time add-ons are priced on the same page. Each has its own Payment amount and Service fee, and the amount is added to the service's charge, with the flat rate added once per item. An add-on or variation amount can be negative, as a discount. With the default pricing the charge never goes below zero. Variations also have an Additional payment amount, described on the page as the amount when the variation is not the first one selected.
When a payment amount is above the calculated price (by more than 5 cents), the row shows "The payment amount (...) is greater than the calculated price (...). The invoice and payment may not be recorded in Simpro after charging the customer!" and Invoice type is cleared and locked.
How it maps to Simpro
After the customer pays and the job is created, Formpiece reads the amount the gateway actually took, then writes two records. It does nothing in Simpro unless the account has the subscription, a job was created, a Simpro Payment Method is chosen and the gateway payment exists.
| On the form | In Simpro |
|---|---|
| Invoice type | The invoice Type. Blank means Tax Invoice. On a booking made to an existing job through an auth link, a Tax Invoice becomes a Progress Claim. |
| The booked job | The invoice's job. The invoice is created at the Approved stage. |
| Simpro Invoice Comment | The invoice Description. |
| Simpro Invoice Footnote | The invoice Notes. |
| Simpro Accounting Category | The invoice Accounting Category. |
| Payment amount on a Deposit or Progress Claim | A claim on the booked cost centre for that amount, including tax, when the booking has a cost centre. |
| Simpro Payment Method | The customer payment's Payment Method. |
| Simpro Deposit Account | The customer payment's Deposit Account. |
| The booking day | The customer payment's Date. |
| The service fee | The customer payment's Finance Charge. |
| The amount charged less the service fee | The amount the customer payment applies to the invoice. Its note is "Upfront payment from formpiece.com". |
A Tax Invoice with a payment amount below the pre-build price is marked Unpaid with a partial payment, as the page itself notes.
The invoice and payment numbers are kept on the booking and written into the Stripe payment's description. Afterpay and Zip payments get the invoice but no customer payment.
When it goes wrong
The customer paid and Simpro has no invoice
Check that Simpro Payment Method is set. The page marks it required, but the field does not stop Save. Without it the booking is made and the payment is taken, and nothing is written to Simpro. When the gateway amount cannot be read back, no invoice is raised either. When Simpro refuses the invoice or payment, the errors are saved on the booking record.
Payment is greyed out or missing from the form
Check three things in turn. Allow payments is on, the service has Allow or Required ticked with a payment amount above zero, and the customer email is mandatory. The warning "Please ensure every service has pricing rules, otherwise the payment form will not appear!" refers to the same thing.
"Please select a Square location."
Square is the processor and Allow payments is on with no location chosen. Pick one in Square location.
"Stripe integration has not been set up!"
Stripe is the processor and the linked credential has no publishable key. Fix it under Stripe.
Save is greyed out
The account has no subscription.
The Simpro Deposit Account is required and I do not use one
The box is a required field. Type the deposit account name you want the payments recorded against.
Services have been disabled
When Disable Service selection is on for the form, the page says "Services have been disabled." You can still edit payment settings and the form does not use them.