Breaking change
bypass_send_approval now defaults to false
- bypass_send_approval used to default to true, so an API invoice was sent at once even when the entity required approval for sending.
- It now defaults to false: if the entity has Require Approval for Sending switched on and you leave the field out, the invoice is held as WAITING_FOR_APPROVAL and the approvers are emailed.
- Send bypass_send_approval true to send the invoice without waiting, as before.
- The same applies to every PATCH: a corrected invoice sent without the field goes for approval again.
- It makes no difference when the entity does not require approval, and invoices already stored keep the value they were pushed with.
Why we changed this
- An entity that switches approval on expects its invoices to be checked by a person. Skipping it by default meant API invoices went out unchecked unless the integration knew to opt in.
What to do: If your integration pushes invoices for an entity that requires approval and you want them sent without waiting, add bypass_send_approval true to each push and each PATCH. Otherwise nothing to change.
Invoices pushed through the API →Push an invoice →
New
An app setting turns off Tax Star's welcome email for its clients
- Your apps, Settings now has Send Tax Star's welcome email. It is on by default and applies to the whole OAuth app.
- Turn it off and a client you pre-registered does not get Tax Star's welcome email when it completes FTA onboarding.
- You are still linked, client.onboarded still fires, and the company's owner still gets the partner connection notice.
- It is not a field of POST /oauth/partners/pre-register: nothing is sent with the request. It is read when the client is welcomed, so changing it applies to every client not yet welcomed.
- You can also read and change it with GET and PATCH /oauth/apps/<app_id> as send_welcome_email.
Why we changed this
- A partner that welcomes its own clients does not want them to receive a second welcome from Tax Star.
What to do: Nothing to change. Turn the setting off under Your apps, Settings when you want to welcome your clients yourself.
Partner clients →
New
Entity update can switch invoice approval on or off
- PATCH and PUT /oauth/entities/{entity_id} accept is_active_send_approver, a boolean.
- It is the same setting as Require Approval for Sending in the web app: true holds the invoices the entity sends for an approver, false sends them without approval.
- It needs admin or editor access to the entity, the same as the switch in the web app. An approver's or viewer's app gets 403.
- It does not release an invoice that is already waiting, and an API invoice can still skip approval with bypass_send_approval true.
Why we changed this
- An integration that creates and manages companies had to ask a person to open the web app to turn approval on or off.
What to do: Nothing to change. Send is_active_send_approver when you want to set approval for an entity from your integration.
Entities →