transaction_get_transactionGet a single transaction by ID or reference number
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | UUID value wrapper. |
| Name | Required | Description | Default |
|---|---|---|---|
| transaction | No |
Changes observed during successful MCP inspections.
Output schema / properties / transaction / anyOfPrevious value: -[
- {
- "properties": {
- "accountId": {
- "anyOf": [
- {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "amount": {
- "type": "string"
- },
- "authorizedDate": {
- "type": "string"
- },
- "cardId": {
- "anyOf": [
- {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "companyId": {
- "anyOf": [
- {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "counterpartyId": {
- "anyOf": [
- {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "counterpartyName": {
- "type": "string"
- },
- "createdAt": {
- "anyOf": [
- {
- "format": "date-time",
- "type": "string"
- },
- {
- "type": "null"
- }
- ]
- },
- "currencyCode": {
- "type": "string"
- },
- "date": {
- "type": "string"
- },
- "enrichments": {
- "items": {
- "properties": {
- "companyId": {
- "anyOf": [
- {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "connectionId": {
- "anyOf": [
- {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "createdAt": {
- "anyOf": [
- {
- "format": "date-time",
- "type": "string"
- },
- {
- "type": "null"
- }
- ]
- },
- "currencyCode": {
- "type": "string"
- },
- "detailDatatableCode": {
- "type": "string"
- },
- "externalAccountId": {
- "type": "string"
- },
- "id": {
- "anyOf": [
- {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "matchedAmount": {
- "type": "string"
- },
- "metadata": {
- "anyOf": [
- {
- "properties": {
- "values": {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "periodEnd": {
- "type": "string"
- },
- "periodStart": {
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "status": {
- "enum": [
- "TRANSACTION_ENRICHMENT_STATUS_UNSPECIFIED",
- "TRANSACTION_ENRICHMENT_STATUS_LINKED",
- "TRANSACTION_ENRICHMENT_STATUS_AMBIGUOUS",
- "TRANSACTION_ENRICHMENT_STATUS_UNMATCHED"
- ],
- "type": "string"
- },
- "transactionId": {
- "anyOf": [
- {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "updatedAt": {
- "anyOf": [
- {
- "format": "date-time",
- "type": "string"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "required": [
- "companyId",
- "transactionId"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "fieldValues": {
- "items": {
- "properties": {
- "companyId": {
- "anyOf": [
- {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "createdAt": {
- "anyOf": [
- {
- "format": "date-time",
- "type": "string"
- },
- {
- "type": "null"
- }
- ]
- },
- "dateValue": {
- "type": "string"
- },
- "fieldId": {
- "anyOf": [
- {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "id": {
- "anyOf": [
- {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "numberValue": {
- "type": "string"
- },
- "optionId": {
- "anyOf": [
- {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "optionPath": {
- "type": "string"
- },
- "source": {
- "type": "string"
- },
- "stringValue": {
- "type": "string"
- },
- "transactionId": {
- "anyOf": [
- {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "updatedAt": {
- "anyOf": [
- {
- "format": "date-time",
- "type": "string"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "required": [
- "companyId",
- "transactionId",
- "fieldId"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "id": {
- "anyOf": [
- {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "location": {
- "anyOf": [
- {
- "properties": {
- "address": {
- "type": "string"
- },
- "city": {
- "type": "string"
- },
- "country": {
- "type": "string"
- },
- "lat": {
- "type": "number"
- },
- "lon": {
- "type": "number"
- },
- "postalCode": {
- "type": "string"
- },
- "region": {
- "type": "string"
- },
- "storeNumber": {
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "memo": {
- "type": "string"
- },
- "metadata": {
- "anyOf": [
- {
- "properties": {
- "increase": {
- "anyOf": [
- {
- "properties": {
- "routeId": {
- "type": "string"
- },
- "routeType": {
- "type": "string"
- },
- "sourceCategory": {
- "type": "string"
- },
- "transactionId": {
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "plaid": {
- "anyOf": [
- {
- "properties": {
- "byOrderOf": {
- "type": "string"
- },
- "payee": {
- "type": "string"
- },
- "payer": {
- "type": "string"
- },
- "paymentMethod": {
- "type": "string"
- },
- "paymentProcessor": {
- "type": "string"
- },
- "ppdId": {
- "type": "string"
- },
- "reason": {
- "type": "string"
- },
- "referenceNumber": {
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "parentId": {
- "anyOf": [
- {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "provider": {
- "enum": [
- "TRANSACTION_PROVIDER_UNSPECIFIED",
- "TRANSACTION_PROVIDER_PLAID",
- "TRANSACTION_PROVIDER_MX",
- "TRANSACTION_PROVIDER_YODLEE",
- "TRANSACTION_PROVIDER_TELLER",
- "TRANSACTION_PROVIDER_MANUAL",
- "TRANSACTION_PROVIDER_OTHER",
- "TRANSACTION_PROVIDER_INCREASE"
- ],
- "type": "string"
- },
- "providerId": {
- "type": "string"
- },
- "raw": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "status": {
- "enum": [
- "TRANSACTION_STATUS_UNSPECIFIED",
- "TRANSACTION_STATUS_PENDING",
- "TRANSACTION_STATUS_POSTED",
- "TRANSACTION_STATUS_CANCELLED",
- "TRANSACTION_STATUS_FAILED",
- "TRANSACTION_STATUS_REVERSED",
- "TRANSACTION_STATUS_REMOVED"
- ],
- "type": "string"
- },
- "subtype": {
- "enum": [
- "TRANSACTION_SUBTYPE_UNSPECIFIED",
- "TRANSACTION_SUBTYPE_EXTERNAL",
- "TRANSACTION_SUBTYPE_INTERNAL",
- "TRANSACTION_SUBTYPE_TREASURY",
- "TRANSACTION_SUBTYPE_EXPENSE_REIMBURSEMENT",
- "TRANSACTION_SUBTYPE_ACH",
- "TRANSACTION_SUBTYPE_CREDIT_CARD",
- "TRANSACTION_SUBTYPE_DEBIT_CARD",
- "TRANSACTION_SUBTYPE_DOMESTIC",
- "TRANSACTION_SUBTYPE_INTERNATIONAL",
- "TRANSACTION_SUBTYPE_WIRE_FEE",
- "TRANSACTION_SUBTYPE_SUBSCRIPTION_FEE",
- "TRANSACTION_SUBTYPE_INTL_TRANSACTION_FEE",
- "TRANSACTION_SUBTYPE_CREDIT_CARD_CREDIT",
- "TRANSACTION_SUBTYPE_DEBIT_CARD_CREDIT",
- "TRANSACTION_SUBTYPE_FEE_REBATE",
- "TRANSACTION_SUBTYPE_FEE_REVERSAL"
- ],
- "type": "string"
- },
- "type": {
- "enum": [
- "TRANSACTION_TYPE_UNSPECIFIED",
- "TRANSACTION_TYPE_TRANSFER",
- "TRANSACTION_TYPE_PAYMENT",
- "TRANSACTION_TYPE_CARD",
- "TRANSACTION_TYPE_WIRE",
- "TRANSACTION_TYPE_CHECK",
- "TRANSACTION_TYPE_FEE",
- "TRANSACTION_TYPE_REFUND",
- "TRANSACTION_TYPE_INTEREST",
- "TRANSACTION_TYPE_ATM",
- "TRANSACTION_TYPE_OTHER"
- ],
- "type": "string"
- },
- "updatedAt": {
- "anyOf": [
- {
- "format": "date-time",
- "type": "string"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "required": [
- "companyId",
- "accountId"
- ],
- "type": "object"
- },
- {
- "type": "null"
- }
-]New value: +[
+ {
+ "properties": {
+ "accountId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "amount": {
+ "type": "string"
+ },
+ "authorizedDate": {
+ "type": "string"
+ },
+ "cardId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "companyId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "counterpartyId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "counterpartyName": {
+ "type": "string"
+ },
+ "createdAt": {
+ "anyOf": [
+ {
+ "format": "date-time",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "currencyCode": {
+ "type": "string"
+ },
+ "date": {
+ "type": "string"
+ },
+ "enrichments": {
+ "items": {
+ "properties": {
+ "companyId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "connectionId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "createdAt": {
+ "anyOf": [
+ {
+ "format": "date-time",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "currencyCode": {
+ "type": "string"
+ },
+ "detailDatatableCode": {
+ "type": "string"
+ },
+ "externalAccountId": {
+ "type": "string"
+ },
+ "id": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "matchedAmount": {
+ "type": "string"
+ },
+ "metadata": {
+ "anyOf": [
+ {
+ "properties": {
+ "values": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "periodEnd": {
+ "type": "string"
+ },
+ "periodStart": {
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "status": {
+ "enum": [
+ "TRANSACTION_ENRICHMENT_STATUS_UNSPECIFIED",
+ "TRANSACTION_ENRICHMENT_STATUS_LINKED",
+ "TRANSACTION_ENRICHMENT_STATUS_AMBIGUOUS",
+ "TRANSACTION_ENRICHMENT_STATUS_UNMATCHED"
+ ],
+ "type": "string"
+ },
+ "transactionId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "updatedAt": {
+ "anyOf": [
+ {
+ "format": "date-time",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ }
+ },
+ "required": [
+ "companyId",
+ "transactionId"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "fieldValues": {
+ "items": {
+ "properties": {
+ "companyId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "createdAt": {
+ "anyOf": [
+ {
+ "format": "date-time",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "dateValue": {
+ "type": "string"
+ },
+ "fieldId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "id": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "numberValue": {
+ "type": "string"
+ },
+ "optionId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "optionPath": {
+ "type": "string"
+ },
+ "source": {
+ "type": "string"
+ },
+ "stringValue": {
+ "type": "string"
+ },
+ "transactionId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "updatedAt": {
+ "anyOf": [
+ {
+ "format": "date-time",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ }
+ },
+ "required": [
+ "companyId",
+ "transactionId",
+ "fieldId"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "id": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "location": {
+ "anyOf": [
+ {
+ "properties": {
+ "address": {
+ "type": "string"
+ },
+ "city": {
+ "type": "string"
+ },
+ "country": {
+ "type": "string"
+ },
+ "lat": {
+ "type": "number"
+ },
+ "lon": {
+ "type": "number"
+ },
+ "postalCode": {
+ "type": "string"
+ },
+ "region": {
+ "type": "string"
+ },
+ "storeNumber": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "memo": {
+ "type": "string"
+ },
+ "metadata": {
+ "anyOf": [
+ {
+ "properties": {
+ "increase": {
+ "anyOf": [
+ {
+ "properties": {
+ "counterpartyExtraction": {
+ "type": "string"
+ },
+ "declineReason": {
+ "type": "string"
+ },
+ "routeId": {
+ "type": "string"
+ },
+ "routeType": {
+ "type": "string"
+ },
+ "sourceCategory": {
+ "type": "string"
+ },
+ "transactionId": {
+ "type": "string"
+ },
+ "transferId": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "plaid": {
+ "anyOf": [
+ {
+ "properties": {
+ "byOrderOf": {
+ "type": "string"
+ },
+ "payee": {
+ "type": "string"
+ },
+ "payer": {
+ "type": "string"
+ },
+ "paymentMethod": {
+ "type": "string"
+ },
+ "paymentProcessor": {
+ "type": "string"
+ },
+ "ppdId": {
+ "type": "string"
+ },
+ "reason": {
+ "type": "string"
+ },
+ "referenceNumber": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "parentId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "provider": {
+ "enum": [
+ "TRANSACTION_PROVIDER_UNSPECIFIED",
+ "TRANSACTION_PROVIDER_PLAID",
+ "TRANSACTION_PROVIDER_MX",
+ "TRANSACTION_PROVIDER_YODLEE",
+ "TRANSACTION_PROVIDER_TELLER",
+ "TRANSACTION_PROVIDER_MANUAL",
+ "TRANSACTION_PROVIDER_OTHER",
+ "TRANSACTION_PROVIDER_INCREASE"
+ ],
+ "type": "string"
+ },
+ "providerId": {
+ "type": "string"
+ },
+ "raw": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "status": {
+ "enum": [
+ "TRANSACTION_STATUS_UNSPECIFIED",
+ "TRANSACTION_STATUS_PENDING",
+ "TRANSACTION_STATUS_POSTED",
+ "TRANSACTION_STATUS_CANCELLED",
+ "TRANSACTION_STATUS_FAILED",
+ "TRANSACTION_STATUS_REVERSED",
+ "TRANSACTION_STATUS_REMOVED",
+ "TRANSACTION_STATUS_DECLINED"
+ ],
+ "type": "string"
+ },
+ "subtype": {
+ "enum": [
+ "TRANSACTION_SUBTYPE_UNSPECIFIED",
+ "TRANSACTION_SUBTYPE_EXTERNAL",
+ "TRANSACTION_SUBTYPE_INTERNAL",
+ "TRANSACTION_SUBTYPE_TREASURY",
+ "TRANSACTION_SUBTYPE_EXPENSE_REIMBURSEMENT",
+ "TRANSACTION_SUBTYPE_ACH",
+ "TRANSACTION_SUBTYPE_CREDIT_CARD",
+ "TRANSACTION_SUBTYPE_DEBIT_CARD",
+ "TRANSACTION_SUBTYPE_DOMESTIC",
+ "TRANSACTION_SUBTYPE_INTERNATIONAL",
+ "TRANSACTION_SUBTYPE_WIRE_FEE",
+ "TRANSACTION_SUBTYPE_SUBSCRIPTION_FEE",
+ "TRANSACTION_SUBTYPE_INTL_TRANSACTION_FEE",
+ "TRANSACTION_SUBTYPE_CREDIT_CARD_CREDIT",
+ "TRANSACTION_SUBTYPE_DEBIT_CARD_CREDIT",
+ "TRANSACTION_SUBTYPE_FEE_REBATE",
+ "TRANSACTION_SUBTYPE_FEE_REVERSAL",
+ "TRANSACTION_SUBTYPE_RTP",
+ "TRANSACTION_SUBTYPE_FEDNOW",
+ "TRANSACTION_SUBTYPE_BOOK"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "enum": [
+ "TRANSACTION_TYPE_UNSPECIFIED",
+ "TRANSACTION_TYPE_TRANSFER",
+ "TRANSACTION_TYPE_PAYMENT",
+ "TRANSACTION_TYPE_CARD",
+ "TRANSACTION_TYPE_WIRE",
+ "TRANSACTION_TYPE_FEE",
+ "TRANSACTION_TYPE_REFUND",
+ "TRANSACTION_TYPE_INTEREST",
+ "TRANSACTION_TYPE_ATM",
+ "TRANSACTION_TYPE_OTHER"
+ ],
+ "type": "string"
+ },
+ "updatedAt": {
+ "anyOf": [
+ {
+ "format": "date-time",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ }
+ },
+ "required": [
+ "companyId",
+ "accountId"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+]Output schema / properties / transaction / anyOfAdded value: +[
+ {
+ "properties": {
+ "accountId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "amount": {
+ "type": "string"
+ },
+ "authorizedDate": {
+ "type": "string"
+ },
+ "cardId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "companyId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "counterpartyId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "counterpartyName": {
+ "type": "string"
+ },
+ "createdAt": {
+ "anyOf": [
+ {
+ "format": "date-time",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "currencyCode": {
+ "type": "string"
+ },
+ "date": {
+ "type": "string"
+ },
+ "enrichments": {
+ "items": {
+ "properties": {
+ "companyId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "connectionId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "createdAt": {
+ "anyOf": [
+ {
+ "format": "date-time",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "currencyCode": {
+ "type": "string"
+ },
+ "detailDatatableCode": {
+ "type": "string"
+ },
+ "externalAccountId": {
+ "type": "string"
+ },
+ "id": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "matchedAmount": {
+ "type": "string"
+ },
+ "metadata": {
+ "anyOf": [
+ {
+ "properties": {
+ "values": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "periodEnd": {
+ "type": "string"
+ },
+ "periodStart": {
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "status": {
+ "enum": [
+ "TRANSACTION_ENRICHMENT_STATUS_UNSPECIFIED",
+ "TRANSACTION_ENRICHMENT_STATUS_LINKED",
+ "TRANSACTION_ENRICHMENT_STATUS_AMBIGUOUS",
+ "TRANSACTION_ENRICHMENT_STATUS_UNMATCHED"
+ ],
+ "type": "string"
+ },
+ "transactionId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "updatedAt": {
+ "anyOf": [
+ {
+ "format": "date-time",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ }
+ },
+ "required": [
+ "companyId",
+ "transactionId"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "fieldValues": {
+ "items": {
+ "properties": {
+ "companyId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "createdAt": {
+ "anyOf": [
+ {
+ "format": "date-time",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "dateValue": {
+ "type": "string"
+ },
+ "fieldId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "id": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "numberValue": {
+ "type": "string"
+ },
+ "optionId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "optionPath": {
+ "type": "string"
+ },
+ "source": {
+ "type": "string"
+ },
+ "stringValue": {
+ "type": "string"
+ },
+ "transactionId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "updatedAt": {
+ "anyOf": [
+ {
+ "format": "date-time",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ }
+ },
+ "required": [
+ "companyId",
+ "transactionId",
+ "fieldId"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "id": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "location": {
+ "anyOf": [
+ {
+ "properties": {
+ "address": {
+ "type": "string"
+ },
+ "city": {
+ "type": "string"
+ },
+ "country": {
+ "type": "string"
+ },
+ "lat": {
+ "type": "number"
+ },
+ "lon": {
+ "type": "number"
+ },
+ "postalCode": {
+ "type": "string"
+ },
+ "region": {
+ "type": "string"
+ },
+ "storeNumber": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "memo": {
+ "type": "string"
+ },
+ "metadata": {
+ "anyOf": [
+ {
+ "properties": {
+ "increase": {
+ "anyOf": [
+ {
+ "properties": {
+ "routeId": {
+ "type": "string"
+ },
+ "routeType": {
+ "type": "string"
+ },
+ "sourceCategory": {
+ "type": "string"
+ },
+ "transactionId": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "plaid": {
+ "anyOf": [
+ {
+ "properties": {
+ "byOrderOf": {
+ "type": "string"
+ },
+ "payee": {
+ "type": "string"
+ },
+ "payer": {
+ "type": "string"
+ },
+ "paymentMethod": {
+ "type": "string"
+ },
+ "paymentProcessor": {
+ "type": "string"
+ },
+ "ppdId": {
+ "type": "string"
+ },
+ "reason": {
+ "type": "string"
+ },
+ "referenceNumber": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "parentId": {
+ "anyOf": [
+ {
+ "description": "UUID value wrapper.",
+ "properties": {
+ "value": {
+ "format": "uuid",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "provider": {
+ "enum": [
+ "TRANSACTION_PROVIDER_UNSPECIFIED",
+ "TRANSACTION_PROVIDER_PLAID",
+ "TRANSACTION_PROVIDER_MX",
+ "TRANSACTION_PROVIDER_YODLEE",
+ "TRANSACTION_PROVIDER_TELLER",
+ "TRANSACTION_PROVIDER_MANUAL",
+ "TRANSACTION_PROVIDER_OTHER",
+ "TRANSACTION_PROVIDER_INCREASE"
+ ],
+ "type": "string"
+ },
+ "providerId": {
+ "type": "string"
+ },
+ "raw": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "status": {
+ "enum": [
+ "TRANSACTION_STATUS_UNSPECIFIED",
+ "TRANSACTION_STATUS_PENDING",
+ "TRANSACTION_STATUS_POSTED",
+ "TRANSACTION_STATUS_CANCELLED",
+ "TRANSACTION_STATUS_FAILED",
+ "TRANSACTION_STATUS_REVERSED",
+ "TRANSACTION_STATUS_REMOVED"
+ ],
+ "type": "string"
+ },
+ "subtype": {
+ "enum": [
+ "TRANSACTION_SUBTYPE_UNSPECIFIED",
+ "TRANSACTION_SUBTYPE_EXTERNAL",
+ "TRANSACTION_SUBTYPE_INTERNAL",
+ "TRANSACTION_SUBTYPE_TREASURY",
+ "TRANSACTION_SUBTYPE_EXPENSE_REIMBURSEMENT",
+ "TRANSACTION_SUBTYPE_ACH",
+ "TRANSACTION_SUBTYPE_CREDIT_CARD",
+ "TRANSACTION_SUBTYPE_DEBIT_CARD",
+ "TRANSACTION_SUBTYPE_DOMESTIC",
+ "TRANSACTION_SUBTYPE_INTERNATIONAL",
+ "TRANSACTION_SUBTYPE_WIRE_FEE",
+ "TRANSACTION_SUBTYPE_SUBSCRIPTION_FEE",
+ "TRANSACTION_SUBTYPE_INTL_TRANSACTION_FEE",
+ "TRANSACTION_SUBTYPE_CREDIT_CARD_CREDIT",
+ "TRANSACTION_SUBTYPE_DEBIT_CARD_CREDIT",
+ "TRANSACTION_SUBTYPE_FEE_REBATE",
+ "TRANSACTION_SUBTYPE_FEE_REVERSAL"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "enum": [
+ "TRANSACTION_TYPE_UNSPECIFIED",
+ "TRANSACTION_TYPE_TRANSFER",
+ "TRANSACTION_TYPE_PAYMENT",
+ "TRANSACTION_TYPE_CARD",
+ "TRANSACTION_TYPE_WIRE",
+ "TRANSACTION_TYPE_CHECK",
+ "TRANSACTION_TYPE_FEE",
+ "TRANSACTION_TYPE_REFUND",
+ "TRANSACTION_TYPE_INTEREST",
+ "TRANSACTION_TYPE_ATM",
+ "TRANSACTION_TYPE_OTHER"
+ ],
+ "type": "string"
+ },
+ "updatedAt": {
+ "anyOf": [
+ {
+ "format": "date-time",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ }
+ },
+ "required": [
+ "companyId",
+ "accountId"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+]Output schema / properties / transaction / propertiesRemoved value: -{
- "accountId": {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- "amount": {
- "type": "string"
- },
- "authorizedDate": {
- "type": "string"
- },
- "cardId": {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- "companyId": {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- "counterpartyId": {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- "counterpartyName": {
- "type": "string"
- },
- "createdAt": {
- "format": "date-time",
- "type": "string"
- },
- "currencyCode": {
- "type": "string"
- },
- "date": {
- "type": "string"
- },
- "enrichments": {
- "items": {
- "properties": {
- "companyId": {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- "connectionId": {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- "createdAt": {
- "format": "date-time",
- "type": "string"
- },
- "currencyCode": {
- "type": "string"
- },
- "detailDatatableCode": {
- "type": "string"
- },
- "externalAccountId": {
- "type": "string"
- },
- "id": {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- "matchedAmount": {
- "type": "string"
- },
- "metadata": {
- "properties": {
- "values": {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "periodEnd": {
- "type": "string"
- },
- "periodStart": {
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "status": {
- "enum": [
- "TRANSACTION_ENRICHMENT_STATUS_UNSPECIFIED",
- "TRANSACTION_ENRICHMENT_STATUS_LINKED",
- "TRANSACTION_ENRICHMENT_STATUS_AMBIGUOUS",
- "TRANSACTION_ENRICHMENT_STATUS_UNMATCHED"
- ],
- "type": "string"
- },
- "transactionId": {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- "updatedAt": {
- "format": "date-time",
- "type": "string"
- }
- },
- "required": [
- "companyId",
- "transactionId"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "fieldValues": {
- "items": {
- "properties": {
- "companyId": {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- "createdAt": {
- "format": "date-time",
- "type": "string"
- },
- "dateValue": {
- "type": "string"
- },
- "fieldId": {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- "id": {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- "numberValue": {
- "type": "string"
- },
- "optionId": {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- "optionPath": {
- "type": "string"
- },
- "source": {
- "type": "string"
- },
- "stringValue": {
- "type": "string"
- },
- "transactionId": {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- "updatedAt": {
- "format": "date-time",
- "type": "string"
- }
- },
- "required": [
- "companyId",
- "transactionId",
- "fieldId"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "id": {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- "location": {
- "properties": {
- "address": {
- "type": "string"
- },
- "city": {
- "type": "string"
- },
- "country": {
- "type": "string"
- },
- "lat": {
- "type": "number"
- },
- "lon": {
- "type": "number"
- },
- "postalCode": {
- "type": "string"
- },
- "region": {
- "type": "string"
- },
- "storeNumber": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "memo": {
- "type": "string"
- },
- "metadata": {
- "properties": {
- "increase": {
- "properties": {
- "routeId": {
- "type": "string"
- },
- "routeType": {
- "type": "string"
- },
- "sourceCategory": {
- "type": "string"
- },
- "transactionId": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "plaid": {
- "properties": {
- "byOrderOf": {
- "type": "string"
- },
- "payee": {
- "type": "string"
- },
- "payer": {
- "type": "string"
- },
- "paymentMethod": {
- "type": "string"
- },
- "paymentProcessor": {
- "type": "string"
- },
- "ppdId": {
- "type": "string"
- },
- "reason": {
- "type": "string"
- },
- "referenceNumber": {
- "type": "string"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "parentId": {
- "description": "UUID value wrapper.",
- "properties": {
- "value": {
- "format": "uuid",
- "type": "string"
- }
- },
- "type": "object"
- },
- "provider": {
- "enum": [
- "TRANSACTION_PROVIDER_UNSPECIFIED",
- "TRANSACTION_PROVIDER_PLAID",
- "TRANSACTION_PROVIDER_MX",
- "TRANSACTION_PROVIDER_YODLEE",
- "TRANSACTION_PROVIDER_TELLER",
- "TRANSACTION_PROVIDER_MANUAL",
- "TRANSACTION_PROVIDER_OTHER",
- "TRANSACTION_PROVIDER_INCREASE"
- ],
- "type": "string"
- },
- "providerId": {
- "type": "string"
- },
- "raw": {
- "additionalProperties": true,
- "type": "object"
- },
- "status": {
- "enum": [
- "TRANSACTION_STATUS_UNSPECIFIED",
- "TRANSACTION_STATUS_PENDING",
- "TRANSACTION_STATUS_POSTED",
- "TRANSACTION_STATUS_CANCELLED",
- "TRANSACTION_STATUS_FAILED",
- "TRANSACTION_STATUS_REVERSED",
- "TRANSACTION_STATUS_REMOVED"
- ],
- "type": "string"
- },
- "subtype": {
- "enum": [
- "TRANSACTION_SUBTYPE_UNSPECIFIED",
- "TRANSACTION_SUBTYPE_EXTERNAL",
- "TRANSACTION_SUBTYPE_INTERNAL",
- "TRANSACTION_SUBTYPE_TREASURY",
- "TRANSACTION_SUBTYPE_EXPENSE_REIMBURSEMENT",
- "TRANSACTION_SUBTYPE_ACH",
- "TRANSACTION_SUBTYPE_CREDIT_CARD",
- "TRANSACTION_SUBTYPE_DEBIT_CARD",
- "TRANSACTION_SUBTYPE_DOMESTIC",
- "TRANSACTION_SUBTYPE_INTERNATIONAL",
- "TRANSACTION_SUBTYPE_WIRE_FEE",
- "TRANSACTION_SUBTYPE_SUBSCRIPTION_FEE",
- "TRANSACTION_SUBTYPE_INTL_TRANSACTION_FEE",
- "TRANSACTION_SUBTYPE_CREDIT_CARD_CREDIT",
- "TRANSACTION_SUBTYPE_DEBIT_CARD_CREDIT",
- "TRANSACTION_SUBTYPE_FEE_REBATE",
- "TRANSACTION_SUBTYPE_FEE_REVERSAL"
- ],
- "type": "string"
- },
- "type": {
- "enum": [
- "TRANSACTION_TYPE_UNSPECIFIED",
- "TRANSACTION_TYPE_TRANSFER",
- "TRANSACTION_TYPE_PAYMENT",
- "TRANSACTION_TYPE_CARD",
- "TRANSACTION_TYPE_WIRE",
- "TRANSACTION_TYPE_CHECK",
- "TRANSACTION_TYPE_FEE",
- "TRANSACTION_TYPE_REFUND",
- "TRANSACTION_TYPE_INTEREST",
- "TRANSACTION_TYPE_ATM",
- "TRANSACTION_TYPE_OTHER"
- ],
- "type": "string"
- },
- "updatedAt": {
- "format": "date-time",
- "type": "string"
- }
-}Output schema / properties / transaction / requiredRemoved value: -[
- "companyId",
- "accountId"
-]Output schema / properties / transaction / typeRemoved value: -"object"Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already convey that this is read-only and non-destructive, covering the core safety profile. The description adds little behavioral nuance beyond the lookup-by-identifier scoping; it does not describe error behavior or response structure, but those are partially covered by the existing annotations and output schema.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single, front-loaded sentence that entirely conveys the tool's purpose and lookup modality. There is zero filler or redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a one-parameter read tool with an output schema and annotations, the definition covers the essential call surface. The only minor gap is the precise meaning and format of a 'reference number,' but the schema and output schema compensate for most of what an agent needs.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema description only says 'UUID value wrapper,' while the tool description adds that the identifier can be an ID or reference number. That is useful extra meaning beyond the schema, though the nesting nuance is left to the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states a specific action ('get'), resource ('single transaction'), and lookup keys ('by ID or reference number'). It is distinct enough from listing tools like read_transactions or summary tools like transaction_get_summary, though it does not explicitly call out those siblings.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The phrase 'by ID or reference number' gives a clear precondition for when this tool is appropriate—when a single transaction identifier is available. It does not explicitly name alternatives or exclusions, but the use case is clearly implied.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.