Ready To Transact

The graphiteConnect Ready to Transact feature allows integrations to synchronize critical data on company changes while also identifying companies that should not have transactions processed until outstanding issues are resolved.

Ready To Transact uses two complementary mechanisms: blocked companies and the Ready To Transact answer key.

Blocked Companies

The changes API categorizes companies with pending changes into two groups: blocked and non-blocked.

Blocked companies have outstanding tasks or validations that generally indicate their data should not be synchronized into downstream systems until the blocking conditions are resolved. A company is blocked if it has any of the following:

Confirmation tasks (validating banking or location data updates)
Review tasks
Pending graphiteConnect validations of banking or location data

Fetching Blocked Companies

To retrieve a list of all companies currently in the blocked state, add the blocked=true query parameter to the changes API:

GET /api/public/api/v1/changes/connections?blocked=true

This returns blocked companies regardless of whether their profile data has changed since the last sync date.

Ready To Transact Answer Key

In addition to the blocked flag, the ERP_Record group includes two answer keys that communicate transaction readiness directly within the supplier's profile data:

Answer Key	Values	Description
`ERP_Ready_To_Transaction`	`"y"` or `"n"`	`"y"` if the company is ready for transactions; `"n"` if transactions should be blocked.
`ERP_Ready_To_Transaction_Reason`	Free text	A plain English explanation of why transactions are blocked (e.g., `"Contract open for review"` or `"pending annual security review"`).

These fields are part of the ERP_Record group. See ERP Record for the full field reference.

Using Tasks to Determine Readiness

You can also determine transaction readiness by checking for open tasks on a supplier connection using the Tasks API. If there are any open tasks of type acknowledgment or type review, the supplier is not ready to transact.

Recommended Integration Pattern

A robust integration should check both signals:

Call GET /changes/connections?blocked=true to identify blocked companies. Do not process ERP transactions for these companies until they are unblocked.
When processing a non-blocked company's profile, check ERP_Ready_To_Transaction in the ERP_Record group:
- If "n", log the ERP_Ready_To_Transaction_Reason and skip transaction processing.
- If "y", proceed with normal ERP synchronization.