Accounting » AccountingIntegration/Initialize

AccountingIntegration/Initialize

Introduction

The Initialize endpoint is the entry point for any and all accounting integration actions your app might wish to take between MINDBODY and a third-party accounting integration partner. This endpoint works as a "workflow manager" of sorts, accepting requests for scopes (i.e., subscribers and integration types) in any stage of the integration process and returning a response that identifies where they are and what their next step is based on our internal regulations.

How It Works

Given the provided scope, a lookup is performed on any stored integration data to determine whether the given subscriber has established a link with an integration partner. If not, the subscriber is run through internal regulations to determine whether or not an integration is available for them. If they do have an established integration link, their progress in configuring said integration is validated and the result returned.

Currently, only users with the role of MINDBODY Owner, MINDBODY Admin, or MINDBODY Automated System have permission to access the Initialize endpoint.

How To Use It

  • Scoping

    URL conventions are used to specify the request scope. Every request must provide 2 scope parameters: the subscriber domain scope (Subscriber/Region/Custom) and the accounting integration type scope. Currently the only supported domain scope type is subscriber, so every request must include the subscriber id. All currently supported integration types are specified in EAccountingIntegrationType.

    All requests should look like:
    https://subscriber.mindbodyonline.com/Subscriber_{subscriberId}/AccountingIntegration/Type_{integrationType}/Initialize, where {subscriberId} is the supplied subscriber id and {integrationType} is a value from EAccountingIntegrationType.

  • Determining the Next Step

    Based on a status of ___________ » your app should ___________.

    • Unavailable » Inform the user the integration is not available for them. Additional information is provided in the UnavailableReasons property on the AccountingIntegration model.
    • Available » Allow the user to link to the available integration.
    • Initialized » Begin the configuration process.
    • Configured » Present the user with any history of sent data they may have, and give them options to edit their configuration, manually send their data, or unlink their integration.
    • Inactive » Inform the user that their link has been lost and give them a call to action to re-establish.
    • Error » Inform the user that their configuration is an error state and give them calls to action on the specific items that need attention. This information is provided through the ErrorFlag property on the AccountingMapItem model.

Helpful Links