Accounting » AccountingIntegration/Save

AccountingIntegration/Save

Introduction

The Save endpoint allows you to save the AccountingIntegration model as a whole, including all stored Maps and SynchronizationPreferences.

How It Works

The provided integration is validated and everything that passes validation is saved. If the resultant integration is completely valid, the status is also updated to Configured (if it wasn't already).

Currently, only users with the role of MINDBODY Owner have permission to access the Save 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}/Save, where {subscriberId} is the supplied subscriber id and {integrationType} is a value from EAccountingIntegrationType.

  • Transition of State

    This is a key endpoint, because it is the only way to move an integration from the Initialized state to the Configured state. Your app can do this all at once as soon as an integration becomes Initialized, or you have the option of taking your user more slowly through the configuration options, making incremental calls to Save.

    Note that this process cannot move an integration from Inactive to Configured. An Inactive integration must go through the linking process again (or be completely Removed) in order for its state to change.

Helpful Links