Get Purge Pre-Start Preflight for Financial Event Groups

GET 
/api/amazon/unified/financial-event-groups/purge-pre-start/preflight

Dry run of the purge-pre-start action: lists the Amazon financial event groups whose settlement period starts BEFORE the account's inventory start date. These are historical records that will never have matching settlement reports imported. No changes are made.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

The response contains:

• purged - the number of groups that WOULD be deleted (dry-run count).
• groups - details for each group: internal id, Amazon group_id, integration name, period start_date (ISO 8601), and how many settlement data rows and accounting transactions it currently has.
• inventory_start_date - the account's inventory start date (ISO 8601, UTC) used as the cutoff.
• dry_run - always true for this endpoint.

Query parameters:

• integration_instance_ids (optional) - comma-separated integration instance IDs to scope the preview.

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.