ClientProvidedTransaction (com.plaid:plaid-java 18.0.0 API)

java.lang.Object
- com.plaid.client.model.ClientProvidedTransaction

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class ClientProvidedTransaction
extends Object

A client-provided transaction for Plaid to enrich.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ACCOUNT_SUBTYPE`
`static String`	`SERIALIZED_NAME_ACCOUNT_TYPE`
`static String`	`SERIALIZED_NAME_AMOUNT`
`static String`	`SERIALIZED_NAME_CLIENT_ACCOUNT_ID`
`static String`	`SERIALIZED_NAME_CLIENT_USER_ID`
`static String`	`SERIALIZED_NAME_DATE_POSTED`
`static String`	`SERIALIZED_NAME_DESCRIPTION`
`static String`	`SERIALIZED_NAME_DIRECTION`
`static String`	`SERIALIZED_NAME_ID`
`static String`	`SERIALIZED_NAME_ISO_CURRENCY_CODE`
`static String`	`SERIALIZED_NAME_LOCATION`
`static String`	`SERIALIZED_NAME_MCC`

Constructor Summary

Constructors
Constructor and Description

ClientProvidedTransaction()

Constructors
Constructor and Description
`ClientProvidedTransaction()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClientProvidedTransaction`	`accountSubtype(String accountSubtype)`
`ClientProvidedTransaction`	`accountType(String accountType)`
`ClientProvidedTransaction`	`amount(Double amount)`
`ClientProvidedTransaction`	`clientAccountId(String clientAccountId)`
`ClientProvidedTransaction`	`clientUserId(String clientUserId)`
`ClientProvidedTransaction`	`datePosted(LocalDate datePosted)`
`ClientProvidedTransaction`	`description(String description)`
`ClientProvidedTransaction`	`direction(EnrichTransactionDirection direction)`
`boolean`	`equals(Object o)`
`String`	`getAccountSubtype()` The account subtype associated with the transaction.
`String`	`getAccountType()` The account type associated with the transaction.
`Double`	`getAmount()` The absolute value of the transaction (>= 0).
`String`	`getClientAccountId()` A unique account id used to group transactions for a given account, as a unique identifier from your application.
`String`	`getClientUserId()` A unique user id used to group transactions for a given user, as a unique identifier from your application.
`LocalDate`	`getDatePosted()` The date the transaction posted, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format.
`String`	`getDescription()` The raw description of the transaction.
`EnrichTransactionDirection`	`getDirection()` Get direction
`String`	`getId()` A unique ID for the transaction used to help you tie data back to your systems.
`String`	`getIsoCurrencyCode()` The ISO-4217 currency code of the transaction e.g.
`ClientProvidedTransactionLocation`	`getLocation()` Get location
`String`	`getMcc()` Merchant category codes (MCCs) are four-digit numbers that describe a merchant's primary business activities.
`int`	`hashCode()`
`ClientProvidedTransaction`	`id(String id)`
`ClientProvidedTransaction`	`isoCurrencyCode(String isoCurrencyCode)`
`ClientProvidedTransaction`	`location(ClientProvidedTransactionLocation location)`
`ClientProvidedTransaction`	`mcc(String mcc)`
`void`	`setAccountSubtype(String accountSubtype)`
`void`	`setAccountType(String accountType)`
`void`	`setAmount(Double amount)`
`void`	`setClientAccountId(String clientAccountId)`
`void`	`setClientUserId(String clientUserId)`
`void`	`setDatePosted(LocalDate datePosted)`
`void`	`setDescription(String description)`
`void`	`setDirection(EnrichTransactionDirection direction)`
`void`	`setId(String id)`
`void`	`setIsoCurrencyCode(String isoCurrencyCode)`
`void`	`setLocation(ClientProvidedTransactionLocation location)`
`void`	`setMcc(String mcc)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_ID
```
public static final String SERIALIZED_NAME_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CLIENT_USER_ID
```
public static final String SERIALIZED_NAME_CLIENT_USER_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CLIENT_ACCOUNT_ID
```
public static final String SERIALIZED_NAME_CLIENT_ACCOUNT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ACCOUNT_TYPE
```
public static final String SERIALIZED_NAME_ACCOUNT_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ACCOUNT_SUBTYPE
```
public static final String SERIALIZED_NAME_ACCOUNT_SUBTYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DESCRIPTION
```
public static final String SERIALIZED_NAME_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_AMOUNT
```
public static final String SERIALIZED_NAME_AMOUNT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DIRECTION
```
public static final String SERIALIZED_NAME_DIRECTION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ISO_CURRENCY_CODE
```
public static final String SERIALIZED_NAME_ISO_CURRENCY_CODE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LOCATION
```
public static final String SERIALIZED_NAME_LOCATION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MCC
```
public static final String SERIALIZED_NAME_MCC
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DATE_POSTED
```
public static final String SERIALIZED_NAME_DATE_POSTED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ClientProvidedTransaction
```
public ClientProvidedTransaction()
```
- Method Detail
  - id
```
public ClientProvidedTransaction id(String id)
```
  - getId
```
public String getId()
```
    A unique ID for the transaction used to help you tie data back to your systems.
    
    Returns:
    
    id
  - setId
```
public void setId(String id)
```
  - clientUserId
```
public ClientProvidedTransaction clientUserId(String clientUserId)
```
  - getClientUserId
```
@Nullable
public String getClientUserId()
```
    A unique user id used to group transactions for a given user, as a unique identifier from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.
    
    Returns:
    
    clientUserId
  - setClientUserId
```
public void setClientUserId(String clientUserId)
```
  - clientAccountId
```
public ClientProvidedTransaction clientAccountId(String clientAccountId)
```
  - getClientAccountId
```
@Nullable
public String getClientAccountId()
```
    A unique account id used to group transactions for a given account, as a unique identifier from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_account_id.
    
    Returns:
    
    clientAccountId
  - setClientAccountId
```
public void setClientAccountId(String clientAccountId)
```
  - accountType
```
public ClientProvidedTransaction accountType(String accountType)
```
  - getAccountType
```
@Nullable
public String getAccountType()
```
    The account type associated with the transaction. For a full list of valid types and subtypes, see the [Account schema](https://plaid.com/docs/api/accounts#account-type-schema).
    
    Returns:
    
    accountType
  - setAccountType
```
public void setAccountType(String accountType)
```
  - accountSubtype
```
public ClientProvidedTransaction accountSubtype(String accountSubtype)
```
  - getAccountSubtype
```
@Nullable
public String getAccountSubtype()
```
    The account subtype associated with the transaction. For a full list of valid types and subtypes, see the [Account schema](https://plaid.com/docs/api/accounts#account-type-schema).
    
    Returns:
    
    accountSubtype
  - setAccountSubtype
```
public void setAccountSubtype(String accountSubtype)
```
  - description
```
public ClientProvidedTransaction description(String description)
```
  - getDescription
```
public String getDescription()
```
    The raw description of the transaction. If you have location data in available an unstructured format, it may be appended to the `description` field.
    
    Returns:
    
    description
  - setDescription
```
public void setDescription(String description)
```
  - amount
```
public ClientProvidedTransaction amount(Double amount)
```
  - getAmount
```
public Double getAmount()
```
    The absolute value of the transaction (>= 0). When testing Enrich, note that `amount` data should be realistic. Unrealistic or inaccurate `amount` data may result in reduced quality output.
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Double amount)
```
  - direction
```
public ClientProvidedTransaction direction(EnrichTransactionDirection direction)
```
  - getDirection
```
public EnrichTransactionDirection getDirection()
```
    Get direction
    
    Returns:
    
    direction
  - setDirection
```
public void setDirection(EnrichTransactionDirection direction)
```
  - isoCurrencyCode
```
public ClientProvidedTransaction isoCurrencyCode(String isoCurrencyCode)
```
  - getIsoCurrencyCode
```
public String getIsoCurrencyCode()
```
    The ISO-4217 currency code of the transaction e.g. USD.
    
    Returns:
    
    isoCurrencyCode
  - setIsoCurrencyCode
```
public void setIsoCurrencyCode(String isoCurrencyCode)
```
  - location
```
public ClientProvidedTransaction location(ClientProvidedTransactionLocation location)
```
  - getLocation
```
@Nullable
public ClientProvidedTransactionLocation getLocation()
```
    Get location
    
    Returns:
    
    location
  - setLocation
```
public void setLocation(ClientProvidedTransactionLocation location)
```
  - mcc
```
public ClientProvidedTransaction mcc(String mcc)
```
  - getMcc
```
@Nullable
public String getMcc()
```
    Merchant category codes (MCCs) are four-digit numbers that describe a merchant's primary business activities.
    
    Returns:
    
    mcc
  - setMcc
```
public void setMcc(String mcc)
```
  - datePosted
```
public ClientProvidedTransaction datePosted(LocalDate datePosted)
```
  - getDatePosted
```
@Nullable
public LocalDate getDatePosted()
```
    The date the transaction posted, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format.
    
    Returns:
    
    datePosted
  - setDatePosted
```
public void setDatePosted(LocalDate datePosted)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ClientProvidedTransaction

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ID

SERIALIZED_NAME_CLIENT_USER_ID

SERIALIZED_NAME_CLIENT_ACCOUNT_ID

SERIALIZED_NAME_ACCOUNT_TYPE

SERIALIZED_NAME_ACCOUNT_SUBTYPE

SERIALIZED_NAME_DESCRIPTION

SERIALIZED_NAME_AMOUNT

SERIALIZED_NAME_DIRECTION

SERIALIZED_NAME_ISO_CURRENCY_CODE

SERIALIZED_NAME_LOCATION

SERIALIZED_NAME_MCC

SERIALIZED_NAME_DATE_POSTED

Constructor Detail

ClientProvidedTransaction

Method Detail

id

getId

setId

clientUserId

getClientUserId

setClientUserId

clientAccountId

getClientAccountId

setClientAccountId

accountType

getAccountType

setAccountType

accountSubtype

getAccountSubtype

setAccountSubtype

description

getDescription

setDescription

amount

getAmount

setAmount

direction

getDirection

setDirection

isoCurrencyCode

getIsoCurrencyCode

setIsoCurrencyCode

location

getLocation

setLocation

mcc

getMcc

setMcc

datePosted

getDatePosted

setDatePosted

equals

hashCode

toString