Appearance
data.commerce.bank-line.query ​
Read a bounded window of bank statement lines for reconciliation
Read one window of bank lines, shaped for a matcher.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-commerce |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | — |
account_ref | string | No | — | — |
provider | string | No | — | — |
data_environment | string | No | production | Defaults to 'production'. Never widened to 'any': a reconciliation that mixes sanitized and real lines produces a number nobody can trust. |
posted_from | string | No | — | — |
posted_to | string | No | — | — |
direction | string | No | — | 'credit' or 'debit'. Omit for both. |
statement_artifact_uuid | uuid | No | — | — |
limit | integer | No | 200 | — |
offset | integer | No | 0 | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
items | list | Yes | — | — |
item_count | integer | Yes | — | — |
total_count | integer | Yes | — | — |
net_amount | string | Yes | — | — |
limit | integer | Yes | — | — |
offset | integer | Yes | — | — |
data_environment | string | Yes | — | — |
queried_at | string | Yes | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | json | No | — | — |
failed_layer | json | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
failed_at | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
done | Yes | Yes | Yes | — | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "data.commerce.bank-line.query",
"initial_data": {
"organization_uuid": "value"
}
}