Integration GET API Documentation

Purpose

This API retrieves a list of all integration connections configured in the system. The response includes metadata for each integration connection such as connection UUID, integration partner, remote instance ID and name, client credentials, and token details. This endpoint is useful for managing or auditing third-party integrations connected to the user's account or organization.

Use Case

This API is useful for retrieving all existing integration connections associated with the authenticated environment. It supports system administrators and developers in monitoring active third-party integrations, validating setup configurations, and displaying connection data in administrative or diagnostic dashboards. The endpoint helps identify integration providers, connection status, and related credentials. In case of authentication errors, permission issues, or service failures, the API responds with error details to assist in troubleshooting and analysis.

Path Parameters

No path parameters required for this endpoint.

Query Parameters

Parameter	Type	Description
order_by	String	Field name to sort the result set.
direction	String	Sorting direction. Accepts asc or desc.
limit	Integer	Number of records to retrieve per page.
offset	Integer	Number of records to skip from the beginning.
fields	String	Comma-separated list of fields to include in the response.

Request Body

No request body is required for this endpoint.

Response

Returns a list of integration connections with associated metadata, including connection UUID, integration partner name, remote instance ID and name, client ID, client secret, access token, and refresh token. The API responds with a JSON object where the integration connections are listed under the integration_connection key, accompanied by a pagination object to support paginated results. In case of errors, such as invalid authentication credentials, insufficient permissions, or internal service issues, the API returns a structured error response containing diagnostic details to assist with troubleshooting.

Response Body

                JSON
              

                      {
  "integration_connection": [
    {
      "status": "CONNECTION_STATUS",
      "uuid": "CONNECTION_UUID",
      "integration_partner": "INTEGRATION_PARTNER_NAME",
      "remote_instance_id": "REMOTE_INSTANCE_UUID",
      "remote_instance_name": "REMOTE_INSTANCE_NAME",
      "client_id": "CLIENT_ID",
      "client_secret": "CLIENT_SECRET",
      "access_token": "ACCESS_TOKEN_STRING",
      "refresh_token": "REFRESH_TOKEN_STRING"
    }
  ],
  "pagination": {}
}

                    

Purpose

This API retrieves the details of a specific integration connection configured in the system using its unique connection UUID. The response includes metadata for the selected integration connection such as connection UUID, integration partner, remote instance ID and name, client credentials, and token details. This endpoint is useful for inspecting or managing a single third-party integration linked to the user's account or organization.

Use Case

This API is useful for retrieving detailed information about a particular integration connection associated with the authenticated environment. It supports system administrators and developers in monitoring a specific integration, validating its configuration, and displaying the data in administrative or diagnostic dashboards. The endpoint helps identify the integration provider, connection status, and credentials for the specified connection. In case of authentication errors, permission issues, or service failures, the API responds with error details to assist in troubleshooting and analysis.

Path Parameters

Parameter	Type	Description
`connection_uuid`	String	Unique ID of a integration connection

Query Parameters

This endpoint does not have any query parameters.

Request Body

No request body is required for this endpoint.

Response

Returns a single integration connection with associated metadata, including connection UUID, integration partner name, remote instance ID and name, client ID, client secret, access token, and refresh token. The API responds with a JSON object where the integration connection is provided under the integration_connection key. In case of errors, such as an invalid connection UUID, authentication failure, or internal server issues, the API returns a structured error response with diagnostic details to assist in troubleshooting.

Response Body

                JSON
              

                      {
  "integration_connection": [
    {
      "status": "CONNECTION_STATUS",
      "uuid": "CONNECTION_UUID",
      "integration_partner": "INTEGRATION_PARTNER_NAME",
      "remote_instance_id": "REMOTE_INSTANCE_UUID",
      "remote_instance_name": "REMOTE_INSTANCE_NAME",
      "client_id": "CLIENT_ID",
      "client_secret": "CLIENT_SECRET",
      "access_token": "ACCESS_TOKEN_STRING",
      "refresh_token": "REFRESH_TOKEN_STRING"
    }
  ]
}

                    

Purpose

This API retrieves the complete integration configuration for a specified integration connection. The configuration is returned module-wise (account, item, transaction, and purchase), where each module includes both export and import settings. Export settings define which entities are enabled for synchronization (e.g., accounts, invoices, payments), while import settings provide boolean flags for enabled data types and mappings (e.g., tax enablement, account mapping support). This information allows consumers to audit and manage the integration behavior programmatically.

Use Case

This endpoint is commonly used by developers or system administrators to programmatically fetch and review the integration configuration, ensuring proper synchronization rules are set between systems. For example, it helps confirm whether invoice-to-export is enabled, if purchase payments are mapped, or if item-related imports are active. If the integration UUID is incorrect or the user lacks sufficient access, the API returns detailed error information to assist in resolving configuration or permission issues.

Path Parameters

Parameter	Type	Description
integration_uuid	String	Unique ID of the integration connection

Query Parameters

This endpoint does not accept any query parameters.

Request Body

No request body is required for this endpoint.

Response

A successful call to this endpoint returns a detailed JSON structure containing the current integration configuration for the specified connection. The response is organized into four primary modules, account, item, transaction, and purchase — each containing export and import sections. The export section lists flags (e.g., true, false) indicating whether specific data types such as accounts, invoices, or purchase orders are being sent to the external system. The import section shows which data types are retrieved from the external source, such as accounts, items, payments, or tax information. These configuration flags help determine what synchronization features are active. If the integration UUID is invalid or inaccessible, the API responds with appropriate error details and status codes to guide issue resolution.

Response Body

                JSON
              

                      {
  "integration": {
    "account": {
      "provider": "PROVIDER_NAME_PLACEHOLDER",
      "account_sync_to_xero": "BOOLEAN_FLAG",
      "export": {
        "account_to_xero_enabled": "BOOLEAN_FLAG",
        "account_to_xero_account_receivable_enable": "BOOLEAN_FLAG",
        "account_to_xero_account_payable_enable": "BOOLEAN_FLAG",
        "account_to_xero_tax_enable": "BOOLEAN_FLAG"
      },
      "import": {
        "account_from_xero_enabled": "BOOLEAN_FLAG",
        "account_to_xero_account_receivable_enable": "BOOLEAN_FLAG",
        "account_to_xero_account_payable_enable": "BOOLEAN_FLAG",
        "account_to_xero_tax_enable": "BOOLEAN_FLAG"
      }
    },
    "item": {
      "provider": "PROVIDER_NAME_PLACEHOLDER",
      "item_sync_to_xero": "BOOLEAN_FLAG",
      "export": {
        "item_to_xero_enabled": "BOOLEAN_FLAG",
        "product_to_xero_sales_revenue_enable": "BOOLEAN_FLAG",
        "product_to_xero_tax_enable": "BOOLEAN_FLAG"
      },
      "import": {
        "item_from_xero_enabled": "BOOLEAN_FLAG",
        "product_from_xero_sales_revenue_enable": "BOOLEAN_FLAG",
        "product_from_xero_tax_enable": "BOOLEAN_FLAG"
      }
    },
    "transaction": {
      "provider": "PROVIDER_NAME_PLACEHOLDER",
      "invoice_sync_to_xero": "BOOLEAN_FLAG",
      "payment_sync_to_xero": "BOOLEAN_FLAG",
      "credit_note_sync_to_xero": "BOOLEAN_FLAG",
      "refund_sync_to_xero": "BOOLEAN_FLAG",
      "export": {
        "invoice_to_xero_enabled": "BOOLEAN_FLAG",
        "invoice_to_xero_sales_revenue_enable": "BOOLEAN_FLAG",
        "invoice_to_xero_tax_enable": "BOOLEAN_FLAG",
        "payment_to_xero_enabled": "BOOLEAN_FLAG",
        "credit_note_to_xero_enabled": "BOOLEAN_FLAG",
        "refund_to_xero_enabled": "BOOLEAN_FLAG"
      },
      "import": {
        "invoice_from_xero_enabled": "BOOLEAN_FLAG",
        "invoice_from_xero_sales_revenue_enable": "BOOLEAN_FLAG",
        "invoice_from_xero_tax_enable": "BOOLEAN_FLAG",
        "payment_from_xero_enabled": "BOOLEAN_FLAG",
        "credit_note_from_xero_enabled": "BOOLEAN_FLAG",
        "refund_from_xero_enabled": "BOOLEAN_FLAG"
      }
    },
    "purchase": {
      "provider": "PROVIDER_NAME_PLACEHOLDER",
      "purchase_order_sync_to_xero": "BOOLEAN_FLAG",
      "purchase_invoice_sync_to_xero": "BOOLEAN_FLAG",
      "purchase_payment_sync_to_xero": "BOOLEAN_FLAG",
      "export": {
        "purchase_order_to_xero_enabled": "BOOLEAN_FLAG",
        "purchase_order_to_xero_tax_enable": "BOOLEAN_FLAG",
        "purchase_invoice_to_xero_enabled": "BOOLEAN_FLAG",
        "purchase_invoice_to_xero_tax_enable": "BOOLEAN_FLAG",
        "purchase_payment_to_xero_enabled": "BOOLEAN_FLAG",
        "purchase_payment_to_xero_tax_enable": "BOOLEAN_FLAG",
        "purchase_credit_note_to_xero_enabled": "BOOLEAN_FLAG",
        "purchase_refund_to_xero_enabled": "BOOLEAN_FLAG"
      },
      "import": {
        "purchase_order_from_xero_enabled": "BOOLEAN_FLAG",
        "purchase_order_from_xero_expense_enable": "BOOLEAN_FLAG",
        "purchase_order_from_xero_tax_enable": "BOOLEAN_FLAG",
        "purchase_bill_from_xero_enabled": "BOOLEAN_FLAG",
        "purchase_bill_from_xero_expense_enable": "BOOLEAN_FLAG",
        "purchase_bill_from_xero_tax_enable": "BOOLEAN_FLAG",
        "purchase_payment_from_xero_enabled": "BOOLEAN_FLAG",
        "purchase_payment_processor_from_xero_enable": "BOOLEAN_FLAG",
        "purchase_credit_note_from_xero_enabled": "BOOLEAN_FLAG",
        "purchase_refund_from_xero_enabled": "BOOLEAN_FLAG"
      }
    }
  }
}
                    

Purpose

This API retrieves the list of partner functions configured under a specific integration. Each partner function represents a data operation (such as import or export) that the integration can perform. The response includes details like direction, object type, event triggers, and metadata required for managing or executing automation workflows.

Use Case

This endpoint is used by developers or integration administrators to view all partner functions linked to a specific integration. It is particularly helpful when reviewing existing data operations, checking function configurations, or preparing to update or automate workflows. If the provided UUID is invalid or the user lacks necessary permissions, the API returns a structured error to aid in resolution.

Path Parameters

Parameter	Type	Description
integration_uuid	String	Unique ID of the integration connection

Query Parameters

Parameter	Type	Description
records	Integer	Total number of records returned in the current result set.
limit	Integer	Maximum number of records returned per page.
offset	Integer	Number of records skipped before starting to collect results.
previousPage	String	URL or token for the previous page of results (if applicable).
nextPage	String	URL or token for the next page of results (if applicable)

Request Body

No request body is required for this endpoint.

Response

Retrieving the partner function list returns a structured response that includes a list of partner functions available for the given integration. Each partner function object contains details such as UUID, name, description, direction (e.g., IMPORT), event name, provider name, related object name, mapping ID, status (enabled/disabled), and associated script IDs. The response also includes pagination metadata (records, limit, offset, previous page, and next page), helping clients manage large result sets. This allows users to efficiently browse or filter partner functions linked to an integration.

Response Body

                JSON
              

                      {
  "partner_functions": [
    {
      "uuid": "UUID_PLACEHOLDER_1",
      "name": "FUNCTION_NAME_1",
      "description": "FUNCTION_DESCRIPTION_1",
      "direction": "DIRECTION_TYPE_1",
      "event_name": "EVENT_NAME_1",
      "provider_name": "PROVIDER_NAME_1",
      "object_name": "OBJECT_NAME_1",
      "mapping_id": "MAPPING_ID_1",
      "enabled": "BOOLEAN_FLAG_1",
      "pre_run_script_id": "SCRIPT_ID_BEFORE_1",
      "post_run_script_id": "SCRIPT_ID_AFTER_1",
      "tag": "TAG_LABEL_1",
      "created": "CREATED_TIMESTAMP_1",
      "updated": "UPDATED_TIMESTAMP_1",
      "object_mapping": "OBJECT_MAPPING_1"
    },
    {
      "uuid": "UUID_PLACEHOLDER_2",
      "name": "FUNCTION_NAME_2",
      "description": "FUNCTION_DESCRIPTION_2",
      "direction": "DIRECTION_TYPE_2",
      "event_name": "EVENT_NAME_2",
      "provider_name": "PROVIDER_NAME_2",
      "object_name": "OBJECT_NAME_2",
      "mapping_id": "MAPPING_ID_2",
      "enabled": "BOOLEAN_FLAG_2",
      "pre_run_script_id": "SCRIPT_ID_BEFORE_2",
      "post_run_script_id": "SCRIPT_ID_AFTER_2",
      "tag": "TAG_LABEL_2",
      "created": "CREATED_TIMESTAMP_2",
      "updated": "UPDATED_TIMESTAMP_2",
      "object_mapping": "OBJECT_MAPPING_2"
    },
    {
      "uuid": "UUID_PLACEHOLDER_3",
      "name": "FUNCTION_NAME_3",
      "description": "FUNCTION_DESCRIPTION_3",
      "direction": "DIRECTION_TYPE_3",
      "event_name": "EVENT_NAME_3",
      "provider_name": "PROVIDER_NAME_3",
      "object_name": "OBJECT_NAME_3",
      "mapping_id": "MAPPING_ID_3",
      "enabled": "BOOLEAN_FLAG_3",
      "pre_run_script_id": "SCRIPT_ID_BEFORE_3",
      "post_run_script_id": "SCRIPT_ID_AFTER_3",
      "tag": "TAG_LABEL_3",
      "created": "CREATED_TIMESTAMP_3",
      "updated": "UPDATED_TIMESTAMP_3",
      "object_mapping": "OBJECT_MAPPING_3"
    },
    {
      "uuid": "UUID_PLACEHOLDER_4",
      "name": "FUNCTION_NAME_4",
      "description": "FUNCTION_DESCRIPTION_4",
      "direction": "DIRECTION_TYPE_4",
      "event_name": "EVENT_NAME_4",
      "provider_name": "PROVIDER_NAME_4",
      "object_name": "OBJECT_NAME_4",
      "mapping_id": "MAPPING_ID_4",
      "enabled": "BOOLEAN_FLAG_4",
      "pre_run_script_id": "SCRIPT_ID_BEFORE_4",
      "post_run_script_id": "SCRIPT_ID_AFTER_4",
      "tag": "TAG_LABEL_4",
      "created": "CREATED_TIMESTAMP_4",
      "updated": "UPDATED_TIMESTAMP_4",
      "object_mapping": "OBJECT_MAPPING_4"
    }
  ],
  "pagination": {
    "records": "TOTAL_RECORDS",
    "limit": "PAGE_LIMIT",
    "offset": "PAGE_OFFSET",
    "previous_page": "PREVIOUS_PAGE_URL_OR_EMPTY",
    "next_page": "NEXT_PAGE_URL_OR_NULL"
  }
}
                    

Purpose

This API retrieves the details of a single partner function associated with a specific integration. It returns comprehensive configuration data for the partner function, such as direction (IMPORT or EXPORT), object mapping, event name, provider, and additional metadata like script IDs and status. This enables users to review or audit individual partner functions as part of their integration setup.

Use Case

This endpoint is useful when a developer or integration administrator wants to inspect a specific partner function to verify its configuration, such as ensuring correct mapping and triggers, reviewing tags or descriptions, or preparing for updates. It is commonly used when managing integrations with platforms like Xero, NetSuite, or QuickBooks where specific data objects need to be tracked. If the provided UUID is invalid or permissions are insufficient, the API returns an appropriate error message for resolution.

Path Parameters

Parameter	Type	Description
integration_uuid	String	Unique ID of the integration connection
partner_function_uuid	String	Unique ID of the partner function to retrieve

Query Parameters

This endpoint does not support any query parameters.

Request Body

No request body is required for this endpoint.

Response

The API returns a structured JSON response containing all relevant configuration fields of the requested partner function. These include the UUID, name, description, direction (e.g., IMPORT), provider name, object and mapping details, and timestamps for when the function was created and last updated. Fields such as pre-run and post-run script IDs, tags, and enabled status are also included. If the request is invalid or the partner function is not found, the API will return an appropriate error message and status code.

Response Body

                JSON
              

                      {
  "partner_function": {
    "uuid": "PARTNER_FUNCTION_UUID",
    "name": "FUNCTION_NAME_PLACEHOLDER",
    "description": "FUNCTION_DESCRIPTION_PLACEHOLDER",
    "direction": "DIRECTION_TYPE",  // e.g., IMPORT or EXPORT
    "event_name": "EVENT_NAME_PLACEHOLDER",
    "provider_name": "PROVIDER_NAME_PLACEHOLDER",
    "object_name": "OBJECT_NAME_PLACEHOLDER",
    "mapping_id": "MAPPING_ID_PLACEHOLDER",
    "enabled": "BOOLEAN_FLAG",
    "pre_run_script_id": "PRE_RUN_SCRIPT_ID_PLACEHOLDER",
    "post_run_script_id": "POST_RUN_SCRIPT_ID_PLACEHOLDER",
    "tag": "TAG_PLACEHOLDER",
    "created": "CREATED_TIMESTAMP_PLACEHOLDER",
    "updated": "UPDATED_TIMESTAMP_PLACEHOLDER",
    "object_mapping": "OBJECT_MAPPING_PLACEHOLDER"
  }
}
                    

Purpose

This API retrieves a list of automations configured under a specific integration. It returns metadata and configuration details for each automation, such as trigger type, direction (IMPORT/EXPORT), execution schedule, and associated partner functions. The response includes pagination support to navigate through large automation datasets.

Use Case

This endpoint is used when developers or integration administrators need to audit or manage automations linked to a particular integration. It’s useful for displaying all configured automation workflows, reviewing their current status, or preparing for updates or deletions. Common scenarios include listing all automations for a provider like Xero or NetSuite and analyzing their execution configurations.

Path Parameters

Parameter	Type	Description
integration_uuid	String	Unique ID of the integration connection.

Query Parameters

Parameter	Type	Description
records	Integer	Total number of records returned in the current result set.
limit	Integer	Maximum number of records returned per page.
offset	Integer	Number of records skipped before starting to collect results.
previousPage	String	URL or token for the previous page of results (if applicable).
nextPage	String	URL or token for the next page of results (if applicable).

Request Body

No request body is required for this endpoint.

Response

Fetching the list of automations under an integration connection returns a structured JSON response. It includes an integration_automations array containing each automation’s details—such as automation UUID, name, code, direction (e.g., IMPORT), type (e.g., timerBased), status, provider, trigger condition, and associated partner function information. Additionally, the response includes a pagination object that provides metadata about the result set, including the total number of records, current limit, offset, and navigation fields for previous and next pages. This format supports efficient browsing and filtering of automation workflows configured for the integration.

                JSON
              

                      {
  "integration_automations": [
    {
      "check_on": "CHECK_INTERVAL_PLACEHOLDER",
      "check_on_minutes": "CHECK_INTERVAL_MINUTES_PLACEHOLDER",
      "additional_criteria": "BOOLEAN_FLAG",
      "applies_to": "ENTITY_TYPE_PLACEHOLDER",
      "applies_to_function": "FUNCTION_TYPE_PLACEHOLDER",
      "automation_type": "AUTOMATION_TYPE_PLACEHOLDER",
      "code": "AUTOMATION_CODE_PLACEHOLDER",
      "custom_day": "CUSTOM_DAY_PLACEHOLDER",
      "custom_day_time": "CUSTOM_DAY_TIME_PLACEHOLDER",
      "custom_time": "CUSTOM_TIME_PLACEHOLDER",
      "description": "AUTOMATION_DESCRIPTION_PLACEHOLDER",
      "direction": "DIRECTION_PLACEHOLDER",
      "display_name": "DISPLAY_NAME_PLACEHOLDER",
      "name": "AUTOMATION_NAME_PLACEHOLDER",
      "perform_function": "FUNCTION_UUID_PLACEHOLDER",
      "provider": "PROVIDER_NAME_PLACEHOLDER",
      "status": "AUTOMATION_STATUS_PLACEHOLDER",
      "uuid": "AUTOMATION_UUID_PLACEHOLDER",
      "trigger_condition_text": "TRIGGER_CONDITION_PLACEHOLDER",
      "performActionText": "ACTION_LABEL_PLACEHOLDER",
      "checkOnText": "CHECK_INTERVAL_LABEL_PLACEHOLDER"
    }
  ],
  "pagination": {
    "records": TOTAL_RECORDS_PLACEHOLDER,
    "limit": LIMIT_PLACEHOLDER,
    "offset": OFFSET_PLACEHOLDER,
    "previous_page": "PREVIOUS_PAGE_PLACEHOLDER",
    "next_page": "NEXT_PAGE_PLACEHOLDER"
  }
}
                    

Purpose

This API retrieves detailed information for a specific automation under a given integration connection. It returns the full configuration for the automation, including its type, trigger settings, direction (IMPORT/EXPORT), applicable entity, schedule, and associated partner function. This allows users to review or inspect how an automation is currently configured in the system.

Use Case

This endpoint is used when a developer, administrator, or system operator needs to fetch the setup details of a specific automation — for example, to verify if the automation is set to run on a timer, determine what entity it applies to, or view the current partner function and logic. It is especially useful for displaying configuration in an admin panel or validating setup before editing or deleting. If the provided UUIDs are incorrect or access is denied, the API returns an error with detailed context for resolution.

Path Parameters

Parameter	Type	Description
integration_uuid	String	Unique ID of the integration connection
automation_uuid	String	Unique ID of the automation

Query Parameters

No query parameters are required for this endpoint.

Request Body

No request body is required.

Response

Retrieving an automation by ID returns a JSON object containing the full configuration of the requested automation under the integration_automation key. The response includes fields such as the automation name, display name, automation type (timerBased), execution interval (check_on), direction (IMPORT), applicable entity (supplier), partner function, and provider (xero). It also includes optional metadata such as description, trigger condition text, status (ACTIVE), and UUID. If the automation is not found or access is unauthorized, the API responds with an appropriate error message and status code to assist with debugging.

                CSS
              

                      {
  "integration_automation": {
    "check_on": "CHECK_INTERVAL",
    "check_on_minutes": "CHECK_INTERVAL_MINUTES",
    "additional_criteria": "BOOLEAN_FLAG",
    "applies_to": "ENTITY_TYPE",
    "applies_to_function": "FUNCTION_TYPE",
    "automation_type": "AUTOMATION_TYPE",
    "code": "AUTOMATION_CODE",
    "custom_day": "CUSTOM_DAY",
    "custom_day_time": "CUSTOM_DAY_TIME",
    "custom_time": "CUSTOM_TIME",
    "description": "AUTOMATION_DESCRIPTION",
    "direction": "DIRECTION_TYPE",
    "display_name": "DISPLAY_NAME",
    "name": "AUTOMATION_NAME",
    "perform_function": "FUNCTION_UUID",
    "provider": "PROVIDER_NAME",
    "status": "AUTOMATION_STATUS",
    "uuid": "AUTOMATION_UUID",
    "trigger_condition_text": "TRIGGER_CONDITION_LABEL",
    "performActionText": "PERFORM_ACTION_LABEL",
    "checkOnText": "CHECK_INTERVAL_LABEL"
  }
}
                    

Retrieve Integration Connection List: /integration-connections

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Integration Connection Details by ID: /integration-connections/{connection_uuid}

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Integration Configuration: /integration/{connection_uuid}/configuration

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Partner Function List: /integration/{integration_uuid}/partner-function

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Partner Function Details by ID: /integration/{integration_uuid}/partner-function/{partner_function_uuid}

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Integration Automation List: /integration/{integration_uuid}/automation

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Retrieve Integration Automation Details by ID: /integration/{integration_uuid}/automation/{automation_uuid}

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response