Transaction (finapi-adapter 3.0.28 API)

java.lang.Object
- io.swagger.client.model.Transaction

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2018-05-14T19:12:52.919Z")
public class Transaction
extends Object

Container for a transaction's data

Constructor Summary

Constructors
Constructor and Description

Transaction()

Constructors
Constructor and Description
`Transaction()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Transaction`	`accountId(Long accountId)`
`Transaction`	`addChildrenItem(Long childrenItem)`
`Transaction`	`addLabelsItem(Label labelsItem)`
`Transaction`	`amount(BigDecimal amount)`
`Transaction`	`bankBookingDate(String bankBookingDate)`
`Transaction`	`category(Category category)`
`Transaction`	`children(List<Long> children)`
`Transaction`	`counterpartAccountNumber(String counterpartAccountNumber)`
`Transaction`	`counterpartBankName(String counterpartBankName)`
`Transaction`	`counterpartBic(String counterpartBic)`
`Transaction`	`counterpartBlz(String counterpartBlz)`
`Transaction`	`counterpartCreditorId(String counterpartCreditorId)`
`Transaction`	`counterpartCustomerReference(String counterpartCustomerReference)`
`Transaction`	`counterpartIban(String counterpartIban)`
`Transaction`	`counterpartMandateReference(String counterpartMandateReference)`
`Transaction`	`counterpartName(String counterpartName)`
`boolean`	`equals(Object o)`
`Transaction`	`finapiBookingDate(String finapiBookingDate)`
`Long`	`getAccountId()` Account identifier
`BigDecimal`	`getAmount()` Transaction amount
`String`	`getBankBookingDate()` Bank booking date in the format 'yyyy-MM-dd HH:mm:ss.SSS' (german time).
`Category`	`getCategory()` Transaction category, if any is assigned.
`List<Long>`	`getChildren()` Sub-transactions identifiers (if this transaction is split)
`String`	`getCounterpartAccountNumber()` Counterpart account number
`String`	`getCounterpartBankName()` Counterpart Bank name
`String`	`getCounterpartBic()` Counterpart BIC
`String`	`getCounterpartBlz()` Counterpart BLZ
`String`	`getCounterpartCreditorId()` The creditor ID of the counterpart
`String`	`getCounterpartCustomerReference()` The customer reference of the counterpart
`String`	`getCounterpartIban()` Counterpart IBAN
`String`	`getCounterpartMandateReference()` The mandate reference of the counterpart
`String`	`getCounterpartName()` Counterpart name
`String`	`getFinapiBookingDate()` finAPI Booking date in the format 'yyyy-MM-dd HH:mm:ss.SSS' (german time).
`Long`	`getId()` Transaction identifier
`String`	`getImportDate()` Date of transaction import, in the format 'yyyy-MM-dd HH:mm:ss.SSS' (german time).
`List<Label>`	`getLabels()` Array of assigned labels
`Long`	`getParentId()` Parent transaction identifier
`PaypalTransactionData`	`getPaypalData()` Additional, PayPal-specific transaction data.
`String`	`getPrimanota()` Transaction primanota (bank side identification number)
`String`	`getPurpose()` Transaction purpose
`String`	`getType()` Transaction type, according to the bank.
`String`	`getTypeCodeSwift()` SWIFT transaction type code.
`String`	`getTypeCodeZka()` ZKA business transaction code which relates to the transaction's type.
`String`	`getValueDate()` Value date in the format 'yyyy-MM-dd HH:mm:ss.SSS' (german time).
`int`	`hashCode()`
`Transaction`	`id(Long id)`
`Transaction`	`importDate(String importDate)`
`Transaction`	`isAdjustingEntry(Boolean isAdjustingEntry)`
`Boolean`	`isIsAdjustingEntry()` Indicating whether this transaction is an adjusting entry ('Zwischensaldo').<br/><br/>Adjusting entries do not originate from the bank, but are added by finAPI during an account update when the bank reported account balance does not add up to the set of transactions that finAPI receives for the account.
`Boolean`	`isIsNew()` Indicating whether this transaction is 'new' or not.
`Boolean`	`isIsPotentialDuplicate()` While finAPI uses a well-elaborated algorithm for uniquely identifying transactions, there is still the possibility that during an account update, a transaction that was imported previously may be imported a second time as a new transaction.
`Transaction`	`isNew(Boolean isNew)`
`Transaction`	`isPotentialDuplicate(Boolean isPotentialDuplicate)`
`Transaction`	`labels(List<Label> labels)`
`Transaction`	`parentId(Long parentId)`
`Transaction`	`paypalData(PaypalTransactionData paypalData)`
`Transaction`	`primanota(String primanota)`
`Transaction`	`purpose(String purpose)`
`void`	`setAccountId(Long accountId)`
`void`	`setAmount(BigDecimal amount)`
`void`	`setBankBookingDate(String bankBookingDate)`
`void`	`setCategory(Category category)`
`void`	`setChildren(List<Long> children)`
`void`	`setCounterpartAccountNumber(String counterpartAccountNumber)`
`void`	`setCounterpartBankName(String counterpartBankName)`
`void`	`setCounterpartBic(String counterpartBic)`
`void`	`setCounterpartBlz(String counterpartBlz)`
`void`	`setCounterpartCreditorId(String counterpartCreditorId)`
`void`	`setCounterpartCustomerReference(String counterpartCustomerReference)`
`void`	`setCounterpartIban(String counterpartIban)`
`void`	`setCounterpartMandateReference(String counterpartMandateReference)`
`void`	`setCounterpartName(String counterpartName)`
`void`	`setFinapiBookingDate(String finapiBookingDate)`
`void`	`setId(Long id)`
`void`	`setImportDate(String importDate)`
`void`	`setIsAdjustingEntry(Boolean isAdjustingEntry)`
`void`	`setIsNew(Boolean isNew)`
`void`	`setIsPotentialDuplicate(Boolean isPotentialDuplicate)`
`void`	`setLabels(List<Label> labels)`
`void`	`setParentId(Long parentId)`
`void`	`setPaypalData(PaypalTransactionData paypalData)`
`void`	`setPrimanota(String primanota)`
`void`	`setPurpose(String purpose)`
`void`	`setType(String type)`
`void`	`setTypeCodeSwift(String typeCodeSwift)`
`void`	`setTypeCodeZka(String typeCodeZka)`
`void`	`setValueDate(String valueDate)`
`String`	`toString()`
`Transaction`	`type(String type)`
`Transaction`	`typeCodeSwift(String typeCodeSwift)`
`Transaction`	`typeCodeZka(String typeCodeZka)`
`Transaction`	`valueDate(String valueDate)`

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

- Constructor Detail
 - Transaction
```
public Transaction()
```
- Method Detail
 - id
```
public Transaction id(Long id)
```
 - getId
```
public Long getId()
```
 Transaction identifier
 
 Returns:
 
 id
 - setId
```
public void setId(Long id)
```
 - parentId
```
public Transaction parentId(Long parentId)
```
 - getParentId
```
public Long getParentId()
```
 Parent transaction identifier
 
 Returns:
 
 parentId
 - setParentId
```
public void setParentId(Long parentId)
```
 - accountId
```
public Transaction accountId(Long accountId)
```
 - getAccountId
```
public Long getAccountId()
```
 Account identifier
 
 Returns:
 
 accountId
 - setAccountId
```
public void setAccountId(Long accountId)
```
 - valueDate
```
public Transaction valueDate(String valueDate)
```
 - getValueDate
```
public String getValueDate()
```
 Value date in the format 'yyyy-MM-dd HH:mm:ss.SSS' (german time).
 
 Returns:
 
 valueDate
 - setValueDate
```
public void setValueDate(String valueDate)
```
 - bankBookingDate
```
public Transaction bankBookingDate(String bankBookingDate)
```
 - getBankBookingDate
```
public String getBankBookingDate()
```
 Bank booking date in the format 'yyyy-MM-dd HH:mm:ss.SSS' (german time).
 
 Returns:
 
 bankBookingDate
 - setBankBookingDate
```
public void setBankBookingDate(String bankBookingDate)
```
 - finapiBookingDate
```
public Transaction finapiBookingDate(String finapiBookingDate)
```
 - getFinapiBookingDate
```
public String getFinapiBookingDate()
```
 finAPI Booking date in the format 'yyyy-MM-dd HH:mm:ss.SSS' (german time). NOTE: In some cases, banks may deliver transactions that are booked in future, but already included in the current account balance. To keep the account balance consistent with the set of transactions, such \"future transactions\" will be imported with their finapiBookingDate set to the current date (i.e.: date of import). The finapiBookingDate will automatically get adjusted towards the bankBookingDate each time the associated bank account is updated. Example: A transaction is imported on July, 3rd, with a bank reported booking date of July, 6th. The transaction will be imported with its finapiBookingDate set to July, 3rd. Then, on July 4th, the associated account is updated. During this update, the transaction's finapiBookingDate will be automatically adjusted to July 4th. This adjustment of the finapiBookingDate takes place on each update until the bank account is updated on July 6th or later, in which case the transaction's finapiBookingDate will be adjusted to its final value, July 6th. The finapiBookingDate is the date that is used by the finAPI PFM services. E.g. when you calculate the spendings of an account for the current month, and have a transaction with finapiBookingDate in the current month but bankBookingDate at the beginning of the next month, then this transaction is included in the calculations (as the bank has this transaction's amount included in the current account balance as well).
 
 Returns:
 
 finapiBookingDate
 - setFinapiBookingDate
```
public void setFinapiBookingDate(String finapiBookingDate)
```
 - amount
```
public Transaction amount(BigDecimal amount)
```
 - getAmount
```
public BigDecimal getAmount()
```
 Transaction amount
 
 Returns:
 
 amount
 - setAmount
```
public void setAmount(BigDecimal amount)
```
 - purpose
```
public Transaction purpose(String purpose)
```
 - getPurpose
```
public String getPurpose()
```
 Transaction purpose
 
 Returns:
 
 purpose
 - setPurpose
```
public void setPurpose(String purpose)
```
 - counterpartName
```
public Transaction counterpartName(String counterpartName)
```
 - getCounterpartName
```
public String getCounterpartName()
```
 Counterpart name
 
 Returns:
 
 counterpartName
 - setCounterpartName
```
public void setCounterpartName(String counterpartName)
```
 - counterpartAccountNumber
```
public Transaction counterpartAccountNumber(String counterpartAccountNumber)
```
 - getCounterpartAccountNumber
```
public String getCounterpartAccountNumber()
```
 Counterpart account number
 
 Returns:
 
 counterpartAccountNumber
 - setCounterpartAccountNumber
```
public void setCounterpartAccountNumber(String counterpartAccountNumber)
```
 - counterpartIban
```
public Transaction counterpartIban(String counterpartIban)
```
 - getCounterpartIban
```
public String getCounterpartIban()
```
 Counterpart IBAN
 
 Returns:
 
 counterpartIban
 - setCounterpartIban
```
public void setCounterpartIban(String counterpartIban)
```
 - counterpartBlz
```
public Transaction counterpartBlz(String counterpartBlz)
```
 - getCounterpartBlz
```
public String getCounterpartBlz()
```
 Counterpart BLZ
 
 Returns:
 
 counterpartBlz
 - setCounterpartBlz
```
public void setCounterpartBlz(String counterpartBlz)
```
 - counterpartBic
```
public Transaction counterpartBic(String counterpartBic)
```
 - getCounterpartBic
```
public String getCounterpartBic()
```
 Counterpart BIC
 
 Returns:
 
 counterpartBic
 - setCounterpartBic
```
public void setCounterpartBic(String counterpartBic)
```
 - counterpartBankName
```
public Transaction counterpartBankName(String counterpartBankName)
```
 - getCounterpartBankName
```
public String getCounterpartBankName()
```
 Counterpart Bank name
 
 Returns:
 
 counterpartBankName
 - setCounterpartBankName
```
public void setCounterpartBankName(String counterpartBankName)
```
 - counterpartMandateReference
```
public Transaction counterpartMandateReference(String counterpartMandateReference)
```
 - getCounterpartMandateReference
```
public String getCounterpartMandateReference()
```
 The mandate reference of the counterpart
 
 Returns:
 
 counterpartMandateReference
 - setCounterpartMandateReference
```
public void setCounterpartMandateReference(String counterpartMandateReference)
```
 - counterpartCustomerReference
```
public Transaction counterpartCustomerReference(String counterpartCustomerReference)
```
 - getCounterpartCustomerReference
```
public String getCounterpartCustomerReference()
```
 The customer reference of the counterpart
 
 Returns:
 
 counterpartCustomerReference
 - setCounterpartCustomerReference
```
public void setCounterpartCustomerReference(String counterpartCustomerReference)
```
 - counterpartCreditorId
```
public Transaction counterpartCreditorId(String counterpartCreditorId)
```
 - getCounterpartCreditorId
```
public String getCounterpartCreditorId()
```
 The creditor ID of the counterpart
 
 Returns:
 
 counterpartCreditorId
 - setCounterpartCreditorId
```
public void setCounterpartCreditorId(String counterpartCreditorId)
```
 - type
```
public Transaction type(String type)
```
 - getType
```
public String getType()
```
 Transaction type, according to the bank. If set, this will contain a German term that you can display to the user. Some examples of common values are: \"Lastschrift\", \"Auslandsüberweisung\", \"Gebühren\", \"Zinsen\". The maximum possible length of this field is 255 characters.
 
 Returns:
 
 type
 - setType
```
public void setType(String type)
```
 - typeCodeZka
```
public Transaction typeCodeZka(String typeCodeZka)
```
 - getTypeCodeZka
```
public String getTypeCodeZka()
```
 ZKA business transaction code which relates to the transaction's type. Possible values range from 1 through 999. If no information about the ZKA type code is available, then this field will be null.
 
 Returns:
 
 typeCodeZka
 - setTypeCodeZka
```
public void setTypeCodeZka(String typeCodeZka)
```
 - typeCodeSwift
```
public Transaction typeCodeSwift(String typeCodeSwift)
```
 - getTypeCodeSwift
```
public String getTypeCodeSwift()
```
 SWIFT transaction type code. If no information about the SWIFT code is available, then this field will be null.
 
 Returns:
 
 typeCodeSwift
 - setTypeCodeSwift
```
public void setTypeCodeSwift(String typeCodeSwift)
```
 - primanota
```
public Transaction primanota(String primanota)
```
 - getPrimanota
```
public String getPrimanota()
```
 Transaction primanota (bank side identification number)
 
 Returns:
 
 primanota
 - setPrimanota
```
public void setPrimanota(String primanota)
```
 - category
```
public Transaction category(Category category)
```
 - getCategory
```
public Category getCategory()
```
 Transaction category, if any is assigned. Note: Recently imported transactions that have currently no category assigned might still get categorized by the background categorization process. To check the status of the background categorization, see GET /bankConnections. Manual category assignments to a transaction will remove the transaction from the background categorization process (i.e. the background categorization process will never overwrite a manual category assignment).
 
 Returns:
 
 category
 - setCategory
```
public void setCategory(Category category)
```
 - labels
```
public Transaction labels(List<Label> labels)
```
 - addLabelsItem
```
public Transaction addLabelsItem(Label labelsItem)
```
 - getLabels
```
public List<Label> getLabels()
```
 Array of assigned labels
 
 Returns:
 
 labels
 - setLabels
```
public void setLabels(List<Label> labels)
```
 - isPotentialDuplicate
```
public Transaction isPotentialDuplicate(Boolean isPotentialDuplicate)
```
 - isIsPotentialDuplicate
```
public Boolean isIsPotentialDuplicate()
```
 While finAPI uses a well-elaborated algorithm for uniquely identifying transactions, there is still the possibility that during an account update, a transaction that was imported previously may be imported a second time as a new transaction. For example, this can happen if some transaction data changes on the bank server side. However, finAPI also includes an algorithm of identifying such \"potential duplicate\" transactions. If this field is set to true, it means that finAPI detected a similar transaction that might actually be the same. It is recommended to communicate this information to the end user, and give him an option to delete the transaction in case he confirms that it really is a duplicate.
 
 Returns:
 
 isPotentialDuplicate
 - setIsPotentialDuplicate
```
public void setIsPotentialDuplicate(Boolean isPotentialDuplicate)
```
 - isAdjustingEntry
```
public Transaction isAdjustingEntry(Boolean isAdjustingEntry)
```
 - isIsAdjustingEntry
```
public Boolean isIsAdjustingEntry()
```
 Indicating whether this transaction is an adjusting entry ('Zwischensaldo'). Adjusting entries do not originate from the bank, but are added by finAPI during an account update when the bank reported account balance does not add up to the set of transactions that finAPI receives for the account. In this case, the adjusting entry will fix the deviation between the balance and the received transactions so that both adds up again. Possible causes for such deviations are: - Inconsistencies in how the bank calculates the balance, for instance when not yet booked transactions are already included in the balance, but not included in the set of transactions - Gaps in the transaction history that finAPI receives, for instance because the account has not been updated for a while and older transactions are no longer available
 
 Returns:
 
 isAdjustingEntry
 - setIsAdjustingEntry
```
public void setIsAdjustingEntry(Boolean isAdjustingEntry)
```
 - isNew
```
public Transaction isNew(Boolean isNew)
```
 - isIsNew
```
public Boolean isIsNew()
```
 Indicating whether this transaction is 'new' or not. Any newly imported transaction will have this flag initially set to true. How you use this field is up to your interpretation. For example, you might want to set it to false once a user has clicked on/seen the transaction. You can change this flag to 'false' with the PATCH method.
 
 Returns:
 
 isNew
 - setIsNew
```
public void setIsNew(Boolean isNew)
```
 - importDate
```
public Transaction importDate(String importDate)
```
 - getImportDate
```
public String getImportDate()
```
 Date of transaction import, in the format 'yyyy-MM-dd HH:mm:ss.SSS' (german time).
 
 Returns:
 
 importDate
 - setImportDate
```
public void setImportDate(String importDate)
```
 - children
```
public Transaction children(List<Long> children)
```
 - addChildrenItem
```
public Transaction addChildrenItem(Long childrenItem)
```
 - getChildren
```
public List<Long> getChildren()
```
 Sub-transactions identifiers (if this transaction is split)
 
 Returns:
 
 children
 - setChildren
```
public void setChildren(List<Long> children)
```
 - paypalData
```
public Transaction paypalData(PaypalTransactionData paypalData)
```
 - getPaypalData
```
public PaypalTransactionData getPaypalData()
```
 Additional, PayPal-specific transaction data. This field is only set for transactions that belong to an account of the 'PayPal' bank (BLZ 'PAYPAL').
 
 Returns:
 
 paypalData
 - setPaypalData
```
public void setPaypalData(PaypalTransactionData paypalData)
```
 - 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 Transaction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Transaction

Method Detail

id

getId

setId

parentId

getParentId

setParentId

accountId

getAccountId

setAccountId

valueDate

getValueDate

setValueDate

bankBookingDate

getBankBookingDate

setBankBookingDate

finapiBookingDate

getFinapiBookingDate

setFinapiBookingDate

amount

getAmount

setAmount

purpose

getPurpose

setPurpose

counterpartName

getCounterpartName

setCounterpartName

counterpartAccountNumber

getCounterpartAccountNumber

setCounterpartAccountNumber

counterpartIban

getCounterpartIban

setCounterpartIban

counterpartBlz

getCounterpartBlz

setCounterpartBlz

counterpartBic

getCounterpartBic

setCounterpartBic

counterpartBankName

getCounterpartBankName

setCounterpartBankName

counterpartMandateReference

getCounterpartMandateReference

setCounterpartMandateReference

counterpartCustomerReference

getCounterpartCustomerReference

setCounterpartCustomerReference

counterpartCreditorId

getCounterpartCreditorId

setCounterpartCreditorId

type

getType

setType

typeCodeZka

getTypeCodeZka

setTypeCodeZka

typeCodeSwift

getTypeCodeSwift

setTypeCodeSwift

primanota

getPrimanota

setPrimanota

category

getCategory

setCategory

labels

addLabelsItem

getLabels

setLabels

isPotentialDuplicate

isIsPotentialDuplicate

setIsPotentialDuplicate