--- schema_version: "1" id: 446a17cba9f6c1857ebf65fd6fc25fb8c5a73be47ca3353f7ced8569faad7707 title: Customers collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/industries-integrations/financial_services/references/generated-api-specs/customers.md canonical_url: https://developer.salesforce.com/docs/industries/fsc/references/customers source_site: developer.salesforce.com content_type: documentation content_hash: 56032b4230baf8164b67ffa203517aa30247d973a7866e23ec6b9afb9d8d3f26 products: - Agentforce Financial Services - Industries Integrations --- Customers # Customers Use the Customers API to handle customer related events. **Version:** v1 Protocols: HTTPS. ## Operations ### GET Get customer profile `GET /customers/{customerId}` Get a customer profile, including related accounts with their balances and recent transactions. #### Parameters * `customerId` (path, string, required) ID of the customer to get the details for. Example: `CID776623`. * `transactionLimit` (query, integer) Maximum number of recent transactions to return for each related account of the customer. If not specified, the default number of transactions is returned. Example: `10`. * `shouldIncludeCustomerProfile` (query, boolean) Indicates whether to include customer's personal and business profile details in the response (`true`) or not (`false`). The default value is `true`. If set to `false`, `personCustomer` isn't shown in the response. Example: `true`. * `requestId` (query, string) Specifies the unique tracking ID of the request. Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies a unique flow reference ID from the source system of the request. Example: `006E0077774TquXIAS`. #### Responses * **200** Customer profile retrieved. Media type: `application/json`. Schema: `CustomerProfileResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** The server couldn't find any valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "406" errorMessage: The requested resource cannot generate acceptable content according to the Accept headers sent in the request. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "415" errorMessage: The server denied the request because it was not in a format supported by the target resource. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **429** The server exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeding rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### PATCH Estate Planning `PATCH /customers/{customerId}` Use this resource for estate planning. #### Parameters * `customerId` (path, string, required) ID of the customer to get the details for. Example: `CID776623`. * `requestId` (query, string) Specifies the unique tracking ID of the request. Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) Specifies a unique flow reference ID from the source system of the request. Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `EstatePlanningRequest`. #### Responses * **200** Estate Planning Request Submitted. Media type: `application/json`. Schema: `EstatePlanningResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** The server couldn't find any valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Required credentials are missing or invalid. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: Access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Requested resource was not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as GET /customers/{customerId} 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as GET /customers/{customerId} 415 response._ * **429** The server exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server is refusing to handle the request due to exceeding rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ## Schemas ### CustomerProfileResponse Response details for retrieving customer profile information. * `isSuccess` (_boolean_, required) Indicates whether the API successfully retrieves the customer details (`true`) or not (`false`). Example: `true`. * `apiName` (_string_, required) API that processed the request. Example: `cbs-ent-customerlookup-xapi`. * `apiVersion` (_string_, required) Version of the API. Example: `2.0.3`. * `correlationId` (_string_, required) Unique identifier for tracking the request across systems. Example: `a00a0000-0aa0-000a-0000-0000aa0000aa`. * `timestamp` (_datetime_, required) Date and time when the response was generated. Example: `2026-06-25T17:04:11.482Z`. * `data` (_object_, required) Customer profile data object containing `personCustomer`, `organizationCustomer`, and `relatedAccounts`. Includes all fields of `CustomerProfileDataType`. _Example_ ``` { "isSuccess": true, "apiName": "cbs-ent-customerlookup-xapi", "apiVersion": "2.0.3", "correlationId": "a00a0000-0aa0-000a-0000-0000aa0000aa", "timestamp": "2026-06-25T17:04:11.482Z", "data": { "isPersonalDataRestricted": false, "personCustomer": [ { "customerNumber": "0000123456", "customerStatus": "Active", "firstName": "JOHN", "middleName": "FRANKLIN", "lastName": "DOE", "namePrefix": "DR", "nameSuffix": "JR", "shortName": "DOE JOHN FRANKLIN", "addresses": [ { "addressType": "Primary", "streetNumber": "123", "streetName": "EASY ST.", "apartmentType": "APT", "apartmentNumber": "50", "city": "HONOLULU", "state": "HI", "zipCode": "96814-6825", "militaryRegionCode": "APO AA" } ], "phoneNumbers": [ { "phoneType": "EvePhone", "phoneNumber": "+1-555-1234567", "isPreferredPhoneNumber": true, "hasOptedOutOfContact": false }, { "phoneType": "DayPhone", "phoneNumber": "+1-555-1234568", "isPreferredPhoneNumber": false, "hasOptedOutOfContact": true } ], "emailAddresses": [ { "emailType": "Business", "emailAddress": "CSAWORK@EXAMPLE.COM" }, { "emailType": "Home", "emailAddress": "CSAHOME@EXAMPLE.COM" } ], "taxExemptStatus": "NotTaxExempt", "taxIdType": "SSN", "taxIdNumber": "987654321", "taxIdCertificationStatus": "Certified", "idDocument": { "idDocumentType": "DL", "idDocumentNumber": "H12336534", "idDocumentIssueDate": "2023-12-20", "idDocumentExpirationDate": "2033-12-20", "idDocumentIssuingState": "HI" }, "branchCode": "130", "lastContactedDate": "2025-03-06", "employeeStatusCode": "", "relationshipManager": { "relationshipManagerId": "130", "relationshipManagerRole": "Officer" }, "serviceLevel": "", "occupationCode": "125", "birthDate": "1980-12-12", "deceasedDate": null, "createdDate": "2020-10-17", "lastModifiedDate": "2025-07-07" } ], "organizationCustomer": [], "relatedAccounts": [ { "relationshipType": "SoleOwner", "relationshipOrder": null, "accountNumber": "8976543210", "accountType": "DDA", "accountStatus": "Active", "currentBalance": 1550.55, "availableCreditBalance": 650.07, "isPrimaryOwner": true, "transactions": [ { "transactionId": "TXN-0098B0", "postedDate": "2025-06-24", "effectiveDate": null, "transactionAmount": 2400.00, "currencyCode": "USD", "transactionType": "Credit", "transactionStatus": "pending", "description": "ACH DEPOSIT - PAYROLL", "runningBalance": null, "transactionChannel": "ACH" }, { "transactionId": "TXN-0098A9", "postedDate": "2025-06-23", "effectiveDate": "2025-06-23", "transactionAmount": -85.40, "currencyCode": "USD", "transactionType": "Debit", "transactionStatus": "posted", "description": "POS PURCHASE - FOODLAND HONOLULU", "runningBalance": 1550.55, "transactionChannel": "POS" }, { "transactionId": "TXN-0098A8", "postedDate": "2025-06-22", "effectiveDate": "2025-06-22", "transactionAmount": -42.10, "currencyCode": "USD", "transactionType": "Debit", "transactionStatus": "posted", "description": "POS PURCHASE - SHELL OIL 4471", "runningBalance": 1635.95, "transactionChannel": "POS" }, { "transactionId": "TXN-0098A7", "postedDate": "2025-06-21", "effectiveDate": "2025-06-21", "transactionAmount": -120.00, "currencyCode": "USD", "transactionType": "Debit", "transactionStatus": "posted", "description": "ATM WITHDRAWAL - BISHOP ST", "runningBalance": 1678.05, "transactionChannel": "ATM" }, { "transactionId": "TXN-0098A6", "postedDate": "2025-06-19", "effectiveDate": "2025-06-19", "transactionAmount": -15.99, "currencyCode": "USD", "transactionType": "Debit", "transactionStatus": "posted", "description": "RECURRING - STREAMING SVC", "runningBalance": 1798.05, "transactionChannel": "Online" }, { "transactionId": "TXN-0098A5", "postedDate": "2025-06-18", "effectiveDate": "2025-06-18", "transactionAmount": -200.00, "currencyCode": "USD", "transactionType": "Transfer", "transactionStatus": "posted", "description": "TRANSFER TO SAVINGS 8976543212", "runningBalance": 1814.04, "transactionChannel": "Online" }, { "transactionId": "TXN-0098A4", "postedDate": "2025-06-16", "effectiveDate": "2025-06-16", "transactionAmount": -9.50, "currencyCode": "USD", "transactionType": "Fee", "transactionStatus": "posted", "description": "MONTHLY MAINTENANCE FEE", "runningBalance": 2014.04, "transactionChannel": "System" }, { "transactionId": "TXN-0098A3", "postedDate": "2025-06-13", "effectiveDate": "2025-06-13", "transactionAmount": -64.27, "currencyCode": "USD", "transactionType": "Debit", "transactionStatus": "posted", "description": "POS PURCHASE - SAFEWAY 1123", "runningBalance": 2023.54, "transactionChannel": "POS" }, { "transactionId": "TXN-0098A2", "postedDate": "2025-06-10", "effectiveDate": "2025-06-10", "transactionAmount": 2400.00, "currencyCode": "USD", "transactionType": "Credit", "transactionStatus": "posted", "description": "ACH DEPOSIT - PAYROLL", "runningBalance": 2087.81, "transactionChannel": "ACH" }, { "transactionId": "TXN-0098A1", "postedDate": "2025-06-06", "effectiveDate": "2025-06-06", "transactionAmount": -312.45, "currencyCode": "USD", "transactionType": "Payment", "transactionStatus": "posted", "description": "BILL PAY - HECO ELECTRIC", "runningBalance": -312.19, "transactionChannel": "Online" } ] }, { "relationshipType": "Trustee", "relationshipOrder": null, "accountNumber": "8976543212", "accountType": "CDA", "accountStatus": "Active", "currentBalance": 31700.99, "initialAmount": 30000.68, "isPrimaryOwner": false, "transactions": [ { "transactionId": "TXN-0100C7", "postedDate": "2025-06-01", "effectiveDate": "2025-06-01", "transactionAmount": 42.31, "currencyCode": "USD", "transactionType": "Interest", "transactionStatus": "posted", "description": "INTEREST CREDIT", "runningBalance": 31700.99, "transactionChannel": "System" } ] }, { "relationshipType": "IndirectLiability", "relationshipOrder": null, "accountNumber": "8976543213", "accountType": "LOAN", "accountStatus": "Active", "principalBalance": 19000.25, "availableCreditBalance": 2000.75, "initialAmount": 25000.32, "isPrimaryOwner": false, "transactions": [ { "transactionId": "TXN-0101L3", "postedDate": "2025-06-15", "effectiveDate": "2025-06-15", "transactionAmount": -550.00, "currencyCode": "USD", "transactionType": "Payment", "transactionStatus": "posted", "description": "LOAN PAYMENT - AUTOPAY", "runningBalance": 19000.25, "transactionChannel": "ACH" } ] } ] } } ``` ### ErrorResponse Represents a standard message body to be returned with the error responses. * `errorCode` (_string_, required) Specifies the short code to identify the error. Example: `INVALID_PARAMETER`. * `errorMessage` (_string_, required) Specifies the verbose, human-readable error message. Example: `The value you entered is out of bounds`. * `transactionId` (_string_, required) Specifies the request identifier. Example: `dd960082-abbf-47c2-8c65-f18eeb35848b`. * `timeStamp` (_datetime_, required) Specifies the event date and time. Example: `2019-09-23T11:46:44.256-05:00`. ### EstatePlanningRequest * `DetailsOfDeath` (_object_, required) * `DateOfDeath` (_string_, required) Specifies the date of death. Example: `2025-06-08`. * `CauseOfDeath` (_string_, required) Specifies the cause of death. Example: `Accident`. * `LastMaritalStatus` (_string_, required) Specifies the Marital status of the person. Example: `Married`. * `LastResidencyStatus` (_string_, required) Specifies the Residency status of the person. Example: `Resident`. * `Comments` (_string_, required) Specifies the additional information. Example: `Car Accident`. * `NotifierDetails` (_object_, required) Specifies details about the person who notified about the incident. Includes all fields of `NotifierDetailsType`. ### EstatePlanningResponse * `Status` (_string_, required) Specifies the status of the request. Example: `Submitted`. * `CustomerId` (_string_, required) Specifies the customer ID. Example: `CID776623`. ### CustomerProfileDataType * `isPersonalDataRestricted` (_boolean_, required) Indicates whether access to the customer data is restricted due to privacy or compliance requirements (`true`) or not (`false`). Example: `false`. * `personCustomer` (_array of PersonCustomerType_, required) Personal customer details. Shown for individual customers. * `organizationCustomer` (_array of OrgCustomerType_, required) Business customer details. Shown for organization customers. * `relatedAccounts` (_array of RelatedAccountType_, required) Accounts associated with the customer. Each account includes its balance information and a list of recent transactions. ### NotifierDetailsType * `Salutation` (_string_) Specifies the salutation for the person. Example: `Mrs`. * `FirstName` (_string_, required) Specifies the firstname of the person. Example: `Josh`. * `LastName` (_string_, required) Specifies the lastname of the person. Example: `Greens`. * `RelationWithDeceased` (_string_, required) Specifies the relationship of the person with the main person in context. Example: `Brother`. * `Phone` (_string_) Specifies the phone number of the person. Example: `8888888888`. * `Email` (_string_) Specifies the email of the person. Example: `josh.greens@xyz.com`. ### PersonCustomerType * `customerNumber` (_string_, required) Unique number to identify the customer. Example: `0000123456`. * `customerStatus` (_string_, required) Current status of the customer, such as Active. Example: `Active`. * `firstName` (_string_, required) First name of the customer. Example: `JOHN`. * `middleName` (_string_, required) Middle name of the customer. Example: `FRANKLIN`. * `lastName` (_string_, required) Last name of the customer. Example: `DOE`. * `namePrefix` (_string_, required) Title that appears before the customer's name, such as _Mr._ or _Dr._ Example: `DR`. * `nameSuffix` (_string_, required) Suffix that appears after the customer's name, such as _Jr._ or _III_. Example: `JR`. * `shortName` (_string_, required) Short display name to identify the customer. Example: `DOE JOHN FRANKLIN`. * `addresses` (_array of AddressType_, required) List of addresses associated with the customer. * `phoneNumbers` (_array of PhoneType_, required) List of phone numbers associated with the customer. * `emailAddresses` (_array of EmailType_, required) List of email addresses associated with the customer. * `taxExemptStatus` (_string_, required) Tax exemption status of the customer. It indicates whether the customer is exempted from paying taxes or not. Example: `NotTaxExempt`. * `taxIdType` (_string_, required) Type of tax identifier number, such as SSN or EIN. Example: `SSN`. * `taxIdNumber` (_string_, required) Tax identification number of the customer. Example: `987654321`. * `taxIdCertificationStatus` (_string_, required) Status of the customer's tax identification certification. Example: `Certified`. * `idDocument` (_object_, required) Details of the identity document associated with the customer. Includes all fields of `IdentityDocumentType`. * `branchCode` (_string_, required) Code of the branch that the customer is associated with. Example: `130`. * `lastContactedDate` (_date-only_, required) Date when the customer was last contacted. Example: `2025-03-06`. * `employeeStatusCode` (_string_) Employee status code of the customer if the customer is an employee. Empty if the customer isn't an employee. * `relationshipManager` (_object_, required) Details of the relationship manager who's assigned to the customer. Includes all fields of `RelationshipManagerType`. * `serviceLevel` (_string_) Service level tier of the customer. * `occupationCode` (_string_, required) Occupation code of the customer. Example: `125`. * `birthDate` (_date-only_, required) Date of birth of the customer. Example: `1980-12-12`. * `deceasedDate` (_date-only | any_, required) Date the customer died. Shows `null` if the customer is alive. One of: `date-only`, `any`. * `createdDate` (_date-only_, required) Date when the customer record was created. Example: `2020-10-17`. * `lastModifiedDate` (_date-only_, required) Date when the customer record was last updated. Example: `2025-07-07`. ### OrgCustomerType * `customerNumber` (_string_) Example: `0000987654`. * `customerStatus` (_string_) Example: `Active`. * `legalName` (_string_) Example: `ACME CORPORATION`. ### RelatedAccountType * `relationshipType` (_string_, required) Relationship between the customer and the account. For example, SoleOwner, Trustee, or IndirectLiability. Example: `SoleOwner`. * `relationshipOrder` (_integer | any_, required) Order in which the relationship applies, when multiple relationships exist. Shows `null` if not applicable. One of: `integer`, `any`. * `accountNumber` (_string_, required) Account number. Example: `8976543210`. * `accountType` (_string_, required) Type of account. For example, DDA, CDA, or Loan. Example: `DDA`. * `accountStatus` (_string_, required) Current status of the account, such as Active or Closed. Example: `Active`. * `currentBalance` (_number_) Current balance of the account. Example: `1550.55`. * `availableCreditBalance` (_number_) Available credit balance for the account. Example: `650.07`. * `principalBalance` (_number_) Outstanding principal balance of the loan account. Example: `19000.25`. * `initialAmount` (_number_) Original amount when the account was created. Example: `30000.68`. * `isPrimaryOwner` (_boolean_, required) Indicates whether the customer is the primary owner of this account (`true`) or not (`false`). Example: `true`. * `transactions` (_array of TransactionType_, required) List of recent transactions on the account. ### AddressType * `addressType` (_string_, required) Type of address. For example, Primary or Mailing. Example: `Primary`. * `streetNumber` (_string_, required) Street number of the address. Example: `123`. * `streetName` (_string_, required) Street name of the address. Example: `EASY ST.`. * `apartmentType` (_string_, required) Type of apartment or unit. For example, APT, UNIT, or STE. Example: `APT`. * `apartmentNumber` (_string_, required) Apartment or unit number of the customer's address. Example: `50`. * `city` (_string_, required) City of the address. Example: `HONOLULU`. * `state` (_string_, required) State or province of the address. Example: `HI`. * `zipCode` (_string_, required) Postal or ZIP code of the customer's address. Example: `96814-6825`. * `militaryRegionCode` (_string_, required) Military region code for the address, if applicable. For example, APO AA or FPO AP. Example: `APO AA`. ### PhoneType * `phoneType` (_string_, required) Type of phone number. For example, EvePhone, DayPhone, or Mobile. Example: `EvePhone`. * `phoneNumber` (_string_, required) Phone number of the customer. The phone number must be in the E.164 format. Example: `+1-555-1234567`. * `isPreferredPhoneNumber` (_boolean_, required) Indicates whether this is the customer's preferred phone number (`true`) or not (`false`). Example: `true`. * `hasOptedOutOfContact` (_boolean_, required) Indicates whether the customer has requested not to be contacted using this phone number (`true`) or not (`false`). Example: `false`. ### EmailType * `emailType` (_string_, required) Type of email address, such as Business or Home. Example: `Business`. * `emailAddress` (_string_, required) Email address of the customer. Example: `CSAWORK@EXAMPLE.COM`. ### IdentityDocumentType * `idDocumentType` (_string_, required) Type of identity document. For example, DL or Passport. Example: `DL`. * `idDocumentNumber` (_string_, required) Identity document number. Example: `H12336534`. * `idDocumentIssueDate` (_date-only_, required) Date when the identity document was issued. Example: `2023-12-20`. * `idDocumentExpirationDate` (_date-only_, required) Expiration date of the identity document. Example: `2033-12-20`. * `idDocumentIssuingState` (_string_, required) State or jurisdiction that issued the identity document. Example: `HI`. ### RelationshipManagerType * `relationshipManagerId` (_string_, required) ID of the relationship manager. Example: `130`. * `relationshipManagerRole` (_string_, required) Role of the relationship manager, such as Officer or Advisor. Example: `Officer`. ### TransactionType * `transactionId` (_string_, required) Unique identifier of the transaction. Example: `TXN-0098B0`. * `postedDate` (_date-only_, required) Date when the transaction was posted. Example: `2025-06-24`. * `effectiveDate` (_date-only | any_, required) Date when the transaction took place or became effective. Shows `null` if `transactionStatus` is `Pending`. One of: `date-only`, `any`. * `transactionAmount` (_number_, required) Amount of the transaction. Shows a negative number for `Debit` and `Payments` transaction types. Example: `-85.40`. * `currencyCode` (_string_, required) Currency used for the transaction, such as USD. Example: `USD`. * `transactionType` (_string_, required) Type of transaction, such as Credit, Debit, Transfer, Fee, Payment, or Interest. Example: `Debit`. * `transactionStatus` (_string_, required) Current status of the transaction, such as Posted or Pending. Example: `posted`. * `description` (_string_, required) Description of the transaction. Example: `POS PURCHASE - FOODLAND HONOLULU`. * `runningBalance` (_number | any_, required) Account balance after the transaction was processed. Shows `null` if no balance is available. One of: `number`, `any`. * `transactionChannel` (_string_, required) Channel through which the transaction was initiated. For example, POS, ATM, ACH, Online, or System. Example: `POS`.