STstedi

GET /executions

Changed on

Fetch a list of executions, sorted by the date they were created from newest to oldest.

Request

  • Base URL
    https://core.us.stedi.com/2023-08-01
  • URL
    https://core.us.stedi.com/2023-08-01/executions
  • Auth
    API key in header Authorization

Query parameters

pageSizenumber

The maximum number of elements to return in a page. You can set this to a maximum of 500 elements. If not specified, the default is 100.

pageTokenstring

An opaque token returned by a previous call to this operation in the nextPageToken. If not specified, Stedi returns the first page of results.

direction'INBOUND' | 'OUTBOUND' | 'UNKNOWN'

The direction of the transaction. Inbound transactions are those you receive from a payer, provider, or other trading partner. Outbound transactions are those you send to a payer, provider, or other trading partner.

faultCode'DELIVERY_FAILURE' | 'FAILED_TO_EXTRACT_BUSINESS_IDENTIFIERS' | 'FAILED_TO_FIND_GUIDE' | 'FAILED_TO_FIND_LOCAL_PROFILE' | 'FAILED_TO_FIND_PARTNER_PROFILE' | 'FAILED_TO_FIND_PARTNERSHIP' | 'FAILED_TO_FIND_PROFILES' | 'FAILED_TO_FIND_RECEIVER_PROFILE' | 'FAILED_TO_FIND_SENDER_PROFILE' | 'FAILED_TO_FIND_CONNECTION' | 'FAILED_TO_GENERATE_CONTROL_NUMBERS' | 'FAILED_TO_PARSE' | 'FAILED_TO_PARSE_METADATA' | 'FAILED_TO_TRANSLATE' | 'FAILED_TO_ACK' | 'FAILED_TO_ACK_INTERCHANGE' | 'FILE_NOT_FOUND' | 'INVALID_EVENT' | 'INVALID_CONFIGURATION' | 'MISMATCHED_PARTNERSHIP_CONNECTION' | 'MISSING_FUNCTIONAL_GROUP_CONTROL_NUMBER' | 'MISSING_FUNCTIONAL_GROUP_RELEASE' | 'MISSING_INTERCHANGE_CONTROL_NUMBER' | 'MISSING_TRANSACTION_SET_CONTROL_NUMBER' | 'MISSING_RECEIVER_ID' | 'MISSING_RECEIVER_QUALIFIER' | 'MISSING_SENDER_ID' | 'MISSING_SENDER_QUALIFIER' | 'MULTIPLE_MATCHING_GUIDES' | 'MULTIPLE_MATCHING_TRANSACTION_SETTINGS' | 'MULTIPLE_PARTNERSHIPS' | 'NO_TRANSLATION_OUTPUT' | 'NO_TRANSACTION_SETS' | 'NOT_SUPPORTED' | 'NO_FUNCTIONAL_GROUPS' | 'NO_USAGE_INDICATOR_CODE' | 'PREVIOUSLY_RETRIED' | 'TRANSLATION_ERROR' | 'UNKNOWN_ERROR'

A code specifying the reason for the fault. This code appears in the code property of the HTTP error response.

partnershipIdstring

The unique identifier for the partnership within the Stedi platform. If you're sending or receiving transactions through the Stedi clearinghouse, Stedi configures the necessary partnership for you automatically when you set up your account.

status'COMPLETED' | 'PARTIALLY_COMPLETED' | 'FAILED' | 'IGNORED' | 'IN_PROGRESS' | 'RETRYING' | 'RETRIED' | 'STARTED'

The status of the execution.

  • You can only retry executions with a FAILED or IGNORED status.
  • An execution is COMPLETED when Stedi has finished processing the file with no errors. If the file is an outbound file, a COMPLETED status also means that Stedi successfully delivered it to the configured connection.
mode'test' | 'production' | 'other' | 'unknown'

Indicates whether the file execution contains test or production data. Stedi determines this from the value in ISA15 (Usage Indicator Code).

Indicates whether the file execution contains test or production data. Stedi determines this from the value in ISA15 (Usage Indicator Code).

fromstring date-time

The start of the time range to filter file executions. The results will include executions created at or after this timestamp.

tostring date-time

The end of the time range to filter file executions. The results will include executions up to and including this timestamp.

Response

ListExecutions 200 response

nextPageTokenstring

Token that you can supply in subsequent requests to retrieve the next page of results. If not returned, there are no more results.

Changes