Integration Status — Proposed Guide

Planned API — Reference Only

Integration Status: A connection status could indicate missing authorization, configuration review or connectivity failure. It should not imply that all…

Overview

A connection status could indicate missing authorization, configuration review or connectivity failure. It should not imply that all historical records are synchronized.

Key concepts

Separate connection health, last attempted sync and unresolved exceptions. Use timestamps with defined meanings.

Implementation considerations

No health check is performed here. Provider availability and successful accounting posting cannot be inferred from this example.

Illustrative data model

This local fixture shows a possible representation for the concepts above. It is not an endpoint response, production configuration or a claim that the described capability is implemented.

JSON fixture

Fictional concept fixture

{
  "reference_only": true,
  "topic": "Integration Status",
  "integration_id": "integration_example_123",
  "status": "draft",
  "last_attempt_at": "2026-01-15T12:00:00Z",
  "error_code": "validation_error"
}

Design review checklist

Document which organization owns the integration status representation and which actor may view or change it.
Test the boundaries of integration id, status, last attempt at, error code using synthetic values, including missing or inconsistent references.
Before future implementation, obtain an approved contract and review failure behavior. This documentation does not authorize production activation.

Proposed data types

Illustrative field dictionary
Name	Type	Description
integration_id	string	Stable fictional integration reference; not a secret and not evidence that a resource exists.
status	string	Proposed lifecycle value. Its meaning depends on the resource and must not be inferred from HTTP success.
last_attempt_at	string (date-time)	Synthetic UTC timestamp. Business occurrence time may differ from delivery or processing time.
error_code	string	Illustrative machine-readable error classification; final codes remain undecided.

Integration Configuration

Integrations

QuickBooks Integration