Skip to main content

Specifying entity IDs in trxs sent to the single transaction ingestion API

Going forward, the single transaction ingestion API will no longer accept transactions that include both the entity's by_external_id and the embedded entity's external_id. For example, the following construction is no longer allowed:

{ 
...
"receiver": {
"by_external_id": "B7FA3237-72F6-49B3-9BA9-D35AC74F54EC",
"external_entity_type": "business",
"business": {
...
"external_id": "3CB6FBC9-7106-42C2-988B-C6F363E58381",
...
}
},
...
}

In such cases the API will respond with:

"Only provide an entity by_external_id value or an embedded entity external_id value, not both."

Please only specify the entity via the by_external_id, e.g.:

{
...
"receiver": {
"by_external_id": "B7FA3237-72F6-49B3-9BA9-D35AC74F54EC"
},
...
}

Or via the embedded entity object, e.g.:

{
...
"receiver": {
"external_entity_type": "business",
"business": {
...
"external_id": "3CB6FBC9-7106-42C2-988B-C6F363E58381",
...
}
},
...
}