TransactionCompletion (postfinancecheckout-java-sdk 5.1.0 API)

java.lang.Object
- ch.postfinance.sdk.model.TransactionAwareEntity
- - ch.postfinance.sdk.model.TransactionCompletion

public class TransactionCompletion
extends TransactionAwareEntity

Field Summary

Fields
Modifier and Type	Field and Description
`protected BigDecimal`	`amount`
`protected List<LineItem>`	`baseLineItems`
`protected Long`	`createdBy`
`protected OffsetDateTime`	`createdOn`
`protected String`	`externalId`
`protected OffsetDateTime`	`failedOn`
`protected FailureReason`	`failureReason`
`protected String`	`invoiceMerchantReference`
`protected List<Label>`	`labels`
`protected String`	`language`
`protected Boolean`	`lastCompletion`
`protected List<LineItem>`	`lineItems`
`protected TransactionLineItemVersion`	`lineItemVersion`
`protected TransactionCompletionMode`	`mode`
`protected OffsetDateTime`	`nextUpdateOn`
`protected String`	`paymentInformation`
`protected OffsetDateTime`	`plannedPurgeDate`
`protected OffsetDateTime`	`processingOn`
`protected String`	`processorReference`
`protected List<LineItem>`	`remainingLineItems`
`protected Long`	`spaceViewId`
`protected TransactionCompletionState`	`state`
`protected String`	`statementDescriptor`
`protected OffsetDateTime`	`succeededOn`
`protected BigDecimal`	`taxAmount`
`protected OffsetDateTime`	`timeoutOn`
`protected String`	`timeZone`
`protected Integer`	`version`

Fields inherited from class ch.postfinance.sdk.model.TransactionAwareEntity
id, linkedSpaceId, linkedTransaction

Constructor Summary

Constructors
Constructor and Description

TransactionCompletion()

Constructors
Constructor and Description
`TransactionCompletion()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`BigDecimal`	`getAmount()` The amount which is captured.
`List<LineItem>`	`getBaseLineItems()` The base line items on which the completion is applied on.
`Long`	`getCreatedBy()`
`OffsetDateTime`	`getCreatedOn()` The date and time when the object was created.
`String`	`getExternalId()` The external ID helps to identify the entity and a subsequent creation of an entity with the same ID will not create a new entity.
`OffsetDateTime`	`getFailedOn()`
`FailureReason`	`getFailureReason()`
`String`	`getInvoiceMerchantReference()`
`List<Label>`	`getLabels()`
`String`	`getLanguage()` The language that is linked to the object.
`List<LineItem>`	`getLineItems()` The line items which are captured.
`TransactionLineItemVersion`	`getLineItemVersion()`
`TransactionCompletionMode`	`getMode()`
`OffsetDateTime`	`getNextUpdateOn()`
`String`	`getPaymentInformation()`
`OffsetDateTime`	`getPlannedPurgeDate()` The date and time when the object is planned to be permanently removed.
`OffsetDateTime`	`getProcessingOn()`
`String`	`getProcessorReference()`
`List<LineItem>`	`getRemainingLineItems()`
`Long`	`getSpaceViewId()`
`TransactionCompletionState`	`getState()` The object's current state.
`String`	`getStatementDescriptor()` The statement descriptor explain charges or payments on bank statements.
`OffsetDateTime`	`getSucceededOn()`
`BigDecimal`	`getTaxAmount()` The total sum of all taxes of line items.
`OffsetDateTime`	`getTimeoutOn()`
`String`	`getTimeZone()`
`Integer`	`getVersion()` The version is used for optimistic locking and incremented whenever the object is updated.
`int`	`hashCode()`
`Boolean`	`isLastCompletion()` Indicates if this is the last completion.
`String`	`toString()`

Methods inherited from class ch.postfinance.sdk.model.TransactionAwareEntity
getId, getLinkedSpaceId, getLinkedTransaction

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

- Field Detail
  - amount
```
protected BigDecimal amount
```
  - baseLineItems
```
protected List<LineItem> baseLineItems
```
  - createdBy
```
protected Long createdBy
```
  - createdOn
```
protected OffsetDateTime createdOn
```
  - externalId
```
protected String externalId
```
  - failedOn
```
protected OffsetDateTime failedOn
```
  - failureReason
```
protected FailureReason failureReason
```
  - invoiceMerchantReference
```
protected String invoiceMerchantReference
```
  - labels
```
protected List<Label> labels
```
  - language
```
protected String language
```
  - lastCompletion
```
protected Boolean lastCompletion
```
  - lineItemVersion
```
protected TransactionLineItemVersion lineItemVersion
```
  - lineItems
```
protected List<LineItem> lineItems
```
  - mode
```
protected TransactionCompletionMode mode
```
  - nextUpdateOn
```
protected OffsetDateTime nextUpdateOn
```
  - paymentInformation
```
protected String paymentInformation
```
  - plannedPurgeDate
```
protected OffsetDateTime plannedPurgeDate
```
  - processingOn
```
protected OffsetDateTime processingOn
```
  - processorReference
```
protected String processorReference
```
  - remainingLineItems
```
protected List<LineItem> remainingLineItems
```
  - spaceViewId
```
protected Long spaceViewId
```
  - state
```
protected TransactionCompletionState state
```
  - statementDescriptor
```
protected String statementDescriptor
```
  - succeededOn
```
protected OffsetDateTime succeededOn
```
  - taxAmount
```
protected BigDecimal taxAmount
```
  - timeZone
```
protected String timeZone
```
  - timeoutOn
```
protected OffsetDateTime timeoutOn
```
  - version
```
protected Integer version
```
- Constructor Detail
  - TransactionCompletion
```
public TransactionCompletion()
```
- Method Detail
  - getAmount
```
public BigDecimal getAmount()
```
    The amount which is captured. The amount represents sum of line items including taxes.
    
    Returns:
    
    amount
  - getBaseLineItems
```
public List<LineItem> getBaseLineItems()
```
    The base line items on which the completion is applied on.
    
    Returns:
    
    baseLineItems
  - getCreatedBy
```
public Long getCreatedBy()
```
    Returns:
    
    createdBy
  - getCreatedOn
```
public OffsetDateTime getCreatedOn()
```
    The date and time when the object was created.
    
    Returns:
    
    createdOn
  - getExternalId
```
public String getExternalId()
```
    The external ID helps to identify the entity and a subsequent creation of an entity with the same ID will not create a new entity.
    
    Returns:
    
    externalId
  - getFailedOn
```
public OffsetDateTime getFailedOn()
```
    Returns:
    
    failedOn
  - getFailureReason
```
public FailureReason getFailureReason()
```
    Returns:
    
    failureReason
  - getInvoiceMerchantReference
```
public String getInvoiceMerchantReference()
```
    Returns:
    
    invoiceMerchantReference
  - getLabels
```
public List<Label> getLabels()
```
    Returns:
    
    labels
  - getLanguage
```
public String getLanguage()
```
    The language that is linked to the object.
    
    Returns:
    
    language
  - isLastCompletion
```
public Boolean isLastCompletion()
```
    Indicates if this is the last completion. After the last completion is created the transaction cannot be completed anymore.
    
    Returns:
    
    lastCompletion
  - getLineItemVersion
```
public TransactionLineItemVersion getLineItemVersion()
```
    Returns:
    
    lineItemVersion
  - getLineItems
```
public List<LineItem> getLineItems()
```
    The line items which are captured.
    
    Returns:
    
    lineItems
  - getMode
```
public TransactionCompletionMode getMode()
```
    Returns:
    
    mode
  - getNextUpdateOn
```
public OffsetDateTime getNextUpdateOn()
```
    Returns:
    
    nextUpdateOn
  - getPaymentInformation
```
public String getPaymentInformation()
```
    Returns:
    
    paymentInformation
  - getPlannedPurgeDate
```
public OffsetDateTime getPlannedPurgeDate()
```
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
    
    Returns:
    
    plannedPurgeDate
  - getProcessingOn
```
public OffsetDateTime getProcessingOn()
```
    Returns:
    
    processingOn
  - getProcessorReference
```
public String getProcessorReference()
```
    Returns:
    
    processorReference
  - getRemainingLineItems
```
public List<LineItem> getRemainingLineItems()
```
    Returns:
    
    remainingLineItems
  - getSpaceViewId
```
public Long getSpaceViewId()
```
    Returns:
    
    spaceViewId
  - getState
```
public TransactionCompletionState getState()
```
    The object's current state.
    
    Returns:
    
    state
  - getStatementDescriptor
```
public String getStatementDescriptor()
```
    The statement descriptor explain charges or payments on bank statements.
    
    Returns:
    
    statementDescriptor
  - getSucceededOn
```
public OffsetDateTime getSucceededOn()
```
    Returns:
    
    succeededOn
  - getTaxAmount
```
public BigDecimal getTaxAmount()
```
    The total sum of all taxes of line items.
    
    Returns:
    
    taxAmount
  - getTimeZone
```
public String getTimeZone()
```
    Returns:
    
    timeZone
  - getTimeoutOn
```
public OffsetDateTime getTimeoutOn()
```
    Returns:
    
    timeoutOn
  - getVersion
```
public Integer getVersion()
```
    The version is used for optimistic locking and incremented whenever the object is updated.
    
    Returns:
    
    version
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class TransactionAwareEntity
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class TransactionAwareEntity
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class TransactionAwareEntity

Class TransactionCompletion

Field Summary

Fields inherited from class ch.postfinance.sdk.model.TransactionAwareEntity

Constructor Summary

Method Summary

Methods inherited from class ch.postfinance.sdk.model.TransactionAwareEntity

Methods inherited from class java.lang.Object

Field Detail

amount

baseLineItems

createdBy

createdOn

externalId

failedOn

failureReason

invoiceMerchantReference

labels

language

lastCompletion

lineItemVersion

lineItems

mode

nextUpdateOn

paymentInformation

plannedPurgeDate

processingOn

processorReference

remainingLineItems

spaceViewId

state

statementDescriptor

succeededOn

taxAmount

timeZone

timeoutOn

version

Constructor Detail

TransactionCompletion

Method Detail

getAmount

getBaseLineItems

getCreatedBy

getCreatedOn

getExternalId

getFailedOn

getFailureReason

getInvoiceMerchantReference

getLabels

getLanguage

isLastCompletion

getLineItemVersion

getLineItems

getMode

getNextUpdateOn

getPaymentInformation

getPlannedPurgeDate

getProcessingOn

getProcessorReference

getRemainingLineItems

getSpaceViewId

getState

getStatementDescriptor

getSucceededOn

getTaxAmount

getTimeZone

getTimeoutOn

getVersion

equals

hashCode

toString