Refund (postfinancecheckout-java-sdk 4.0.2 API)

java.lang.Object
- ch.postfinance.sdk.model.Refund

```
public class Refund
extends Object
```
The refund represents a credit back to the customer. It can be issued by the merchant or by the customer (reversal).

Field Summary

Fields
Modifier and Type	Field and Description
`protected BigDecimal`	`amount`
`protected List<LineItem>`	`baseLineItems`
`protected Long`	`completion`
`protected Long`	`createdBy`
`protected OffsetDateTime`	`createdOn`
`protected Environment`	`environment`
`protected String`	`externalId`
`protected OffsetDateTime`	`failedOn`
`protected FailureReason`	`failureReason`
`protected Long`	`id`
`protected List<Label>`	`labels`
`protected String`	`language`
`protected List<LineItem>`	`lineItems`
`protected Long`	`linkedSpaceId`
`protected String`	`merchantReference`
`protected OffsetDateTime`	`nextUpdateOn`
`protected OffsetDateTime`	`plannedPurgeDate`
`protected OffsetDateTime`	`processingOn`
`protected String`	`processorReference`
`protected List<LineItem>`	`reducedLineItems`
`protected List<LineItemReduction>`	`reductions`
`protected RefundState`	`state`
`protected OffsetDateTime`	`succeededOn`
`protected List<Tax>`	`taxes`
`protected OffsetDateTime`	`timeoutOn`
`protected String`	`timeZone`
`protected BigDecimal`	`totalAppliedFees`
`protected BigDecimal`	`totalSettledAmount`
`protected Transaction`	`transaction`
`protected RefundType`	`type`
`protected Long`	`updatedInvoice`
`protected Integer`	`version`

Constructor Summary

Constructors
Constructor and Description

Refund()

Constructors
Constructor and Description
`Refund()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`BigDecimal`	`getAmount()`
`List<LineItem>`	`getBaseLineItems()`
`Long`	`getCompletion()`
`Long`	`getCreatedBy()`
`OffsetDateTime`	`getCreatedOn()` The created on date indicates the date on which the entity was stored into the database.
`Environment`	`getEnvironment()`
`String`	`getExternalId()` The external id helps to identify duplicate calls to the refund service.
`OffsetDateTime`	`getFailedOn()`
`FailureReason`	`getFailureReason()`
`Long`	`getId()` The ID is the primary key of the entity.
`List<Label>`	`getLabels()`
`String`	`getLanguage()`
`List<LineItem>`	`getLineItems()`
`Long`	`getLinkedSpaceId()` The linked space id holds the ID of the space to which the entity belongs to.
`String`	`getMerchantReference()`
`OffsetDateTime`	`getNextUpdateOn()`
`OffsetDateTime`	`getPlannedPurgeDate()` The planned purge date indicates when the entity is permanently removed.
`OffsetDateTime`	`getProcessingOn()`
`String`	`getProcessorReference()`
`List<LineItem>`	`getReducedLineItems()`
`List<LineItemReduction>`	`getReductions()`
`RefundState`	`getState()`
`OffsetDateTime`	`getSucceededOn()`
`List<Tax>`	`getTaxes()`
`OffsetDateTime`	`getTimeoutOn()`
`String`	`getTimeZone()`
`BigDecimal`	`getTotalAppliedFees()` The total applied fees is the sum of all fees that have been applied so far.
`BigDecimal`	`getTotalSettledAmount()` The total settled amount is the total amount which has been settled so far.
`Transaction`	`getTransaction()`
`RefundType`	`getType()`
`Long`	`getUpdatedInvoice()`
`Integer`	`getVersion()` The version number indicates the version of the entity.
`int`	`hashCode()`
`String`	`toString()`

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
```

completion
```
protected Long completion
```

createdBy
```
protected Long createdBy
```

createdOn
```
protected OffsetDateTime createdOn
```

environment
```
protected Environment environment
```

externalId
```
protected String externalId
```

failedOn
```
protected OffsetDateTime failedOn
```

failureReason
```
protected FailureReason failureReason
```

id
```
protected Long id
```

labels
```
protected List<Label> labels
```

language
```
protected String language
```

lineItems
```
protected List<LineItem> lineItems
```

linkedSpaceId
```
protected Long linkedSpaceId
```

merchantReference
```
protected String merchantReference
```

nextUpdateOn
```
protected OffsetDateTime nextUpdateOn
```

plannedPurgeDate

protected OffsetDateTime plannedPurgeDate

processingOn
```
protected OffsetDateTime processingOn
```

processorReference
```
protected String processorReference
```

reducedLineItems

protected List<LineItem> reducedLineItems

reductions

protected List<LineItemReduction> reductions

state
```
protected RefundState state
```

succeededOn
```
protected OffsetDateTime succeededOn
```

taxes
```
protected List<Tax> taxes
```

timeZone
```
protected String timeZone
```

timeoutOn
```
protected OffsetDateTime timeoutOn
```

totalAppliedFees
```
protected BigDecimal totalAppliedFees
```

totalSettledAmount

protected BigDecimal totalSettledAmount

transaction
```
protected Transaction transaction
```

type
```
protected RefundType type
```

updatedInvoice
```
protected Long updatedInvoice
```

version
```
protected Integer version
```

Constructor Detail
- Refund
```
public Refund()
```

Method Detail
- getAmount
```
public BigDecimal getAmount()
```
  Returns:
  
  amount
- getBaseLineItems
```
public List<LineItem> getBaseLineItems()
```
  Returns:
  
  baseLineItems
- getCompletion
```
public Long getCompletion()
```
  Returns:
  
  completion
- getCreatedBy
```
public Long getCreatedBy()
```
  Returns:
  
  createdBy
- getCreatedOn
```
public OffsetDateTime getCreatedOn()
```
  The created on date indicates the date on which the entity was stored into the database.
  
  Returns:
  
  createdOn
- getEnvironment
```
public Environment getEnvironment()
```
  Returns:
  
  environment
- getExternalId
```
public String getExternalId()
```
  The external id helps to identify duplicate calls to the refund service. As such the external ID has to be unique per transaction.
  
  Returns:
  
  externalId
- getFailedOn
```
public OffsetDateTime getFailedOn()
```
  Returns:
  
  failedOn
- getFailureReason
```
public FailureReason getFailureReason()
```
  Returns:
  
  failureReason
- getId
```
public Long getId()
```
  The ID is the primary key of the entity. The ID identifies the entity uniquely.
  
  Returns:
  
  id
- getLabels
```
public List<Label> getLabels()
```
  Returns:
  
  labels
- getLanguage
```
public String getLanguage()
```
  Returns:
  
  language
- getLineItems
```
public List<LineItem> getLineItems()
```
  Returns:
  
  lineItems
- getLinkedSpaceId
```
public Long getLinkedSpaceId()
```
  The linked space id holds the ID of the space to which the entity belongs to.
  
  Returns:
  
  linkedSpaceId
- getMerchantReference
```
public String getMerchantReference()
```
  Returns:
  
  merchantReference
- getNextUpdateOn
```
public OffsetDateTime getNextUpdateOn()
```
  Returns:
  
  nextUpdateOn
- getPlannedPurgeDate
```
public OffsetDateTime getPlannedPurgeDate()
```
  The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.
  
  Returns:
  
  plannedPurgeDate
- getProcessingOn
```
public OffsetDateTime getProcessingOn()
```
  Returns:
  
  processingOn
- getProcessorReference
```
public String getProcessorReference()
```
  Returns:
  
  processorReference
- getReducedLineItems
```
public List<LineItem> getReducedLineItems()
```
  Returns:
  
  reducedLineItems
- getReductions
```
public List<LineItemReduction> getReductions()
```
  Returns:
  
  reductions
- getState
```
public RefundState getState()
```
  Returns:
  
  state
- getSucceededOn
```
public OffsetDateTime getSucceededOn()
```
  Returns:
  
  succeededOn
- getTaxes
```
public List<Tax> getTaxes()
```
  Returns:
  
  taxes
- getTimeZone
```
public String getTimeZone()
```
  Returns:
  
  timeZone
- getTimeoutOn
```
public OffsetDateTime getTimeoutOn()
```
  Returns:
  
  timeoutOn
- getTotalAppliedFees
```
public BigDecimal getTotalAppliedFees()
```
  The total applied fees is the sum of all fees that have been applied so far.
  
  Returns:
  
  totalAppliedFees
- getTotalSettledAmount
```
public BigDecimal getTotalSettledAmount()
```
  The total settled amount is the total amount which has been settled so far.
  
  Returns:
  
  totalSettledAmount
- getTransaction
```
public Transaction getTransaction()
```
  Returns:
  
  transaction
- getType
```
public RefundType getType()
```
  Returns:
  
  type
- getUpdatedInvoice
```
public Long getUpdatedInvoice()
```
  Returns:
  
  updatedInvoice
- getVersion
```
public Integer getVersion()
```
  The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
  
  Returns:
  
  version
- 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 Refund

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

amount

baseLineItems

completion

createdBy

createdOn

environment

externalId

failedOn

failureReason

id

labels

language

lineItems

linkedSpaceId

merchantReference

nextUpdateOn

plannedPurgeDate

processingOn

processorReference

reducedLineItems

reductions

state

succeededOn

taxes

timeZone

timeoutOn

totalAppliedFees

totalSettledAmount

transaction

type

updatedInvoice

version

Constructor Detail

Refund

Method Detail

getAmount

getBaseLineItems

getCompletion

getCreatedBy

getCreatedOn

getEnvironment

getExternalId

getFailedOn

getFailureReason

getId

getLabels

getLanguage

getLineItems

getLinkedSpaceId

getMerchantReference

getNextUpdateOn

getPlannedPurgeDate

getProcessingOn

getProcessorReference

getReducedLineItems

getReductions

getState

getSucceededOn

getTaxes

getTimeZone

getTimeoutOn

getTotalAppliedFees

getTotalSettledAmount

getTransaction

getType

getUpdatedInvoice

getVersion

equals

hashCode

toString