TransactionInvoice (postfinancecheckout-java-sdk 4.0.10 API)

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

```
public class TransactionInvoice
extends TransactionAwareEntity
```
The transaction invoice represents the invoice document for a particular transaction.

Field Summary

Fields
Modifier and Type	Field and Description
`protected BigDecimal`	`amount`
`protected Address`	`billingAddress`
`protected TransactionCompletion`	`completion`
`protected OffsetDateTime`	`createdOn`
`protected Long`	`derecognizedBy`
`protected OffsetDateTime`	`derecognizedOn`
`protected OffsetDateTime`	`dueOn`
`protected Environment`	`environment`
`protected String`	`externalId`
`protected String`	`language`
`protected List<LineItem>`	`lineItems`
`protected String`	`merchantReference`
`protected BigDecimal`	`outstandingAmount`
`protected OffsetDateTime`	`paidOn`
`protected OffsetDateTime`	`plannedPurgeDate`
`protected Long`	`spaceViewId`
`protected TransactionInvoiceState`	`state`
`protected BigDecimal`	`taxAmount`
`protected String`	`timeZone`
`protected Integer`	`version`

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

Constructor Summary

Constructors
Constructor and Description

TransactionInvoice()

Constructors
Constructor and Description
`TransactionInvoice()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`BigDecimal`	`getAmount()`
`Address`	`getBillingAddress()`
`TransactionCompletion`	`getCompletion()`
`OffsetDateTime`	`getCreatedOn()` The date on which the invoice is created on.
`Long`	`getDerecognizedBy()` The id of the user which marked the invoice as derecognized.
`OffsetDateTime`	`getDerecognizedOn()` The date on which the invoice is marked as derecognized.
`OffsetDateTime`	`getDueOn()` The date on which the invoice should be paid on.
`Environment`	`getEnvironment()`
`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.
`String`	`getLanguage()`
`List<LineItem>`	`getLineItems()`
`String`	`getMerchantReference()`
`BigDecimal`	`getOutstandingAmount()` The outstanding amount indicates how much the buyer owes the merchant.
`OffsetDateTime`	`getPaidOn()` The date on which the invoice is marked as paid.
`OffsetDateTime`	`getPlannedPurgeDate()` The planned purge date indicates when the entity is permanently removed.
`Long`	`getSpaceViewId()`
`TransactionInvoiceState`	`getState()`
`BigDecimal`	`getTaxAmount()`
`String`	`getTimeZone()`
`Integer`	`getVersion()` The version number indicates the version of the entity.
`int`	`hashCode()`
`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
```
  - billingAddress
```
protected Address billingAddress
```
  - completion
```
protected TransactionCompletion completion
```
  - createdOn
```
protected OffsetDateTime createdOn
```
  - derecognizedBy
```
protected Long derecognizedBy
```
  - derecognizedOn
```
protected OffsetDateTime derecognizedOn
```
  - dueOn
```
protected OffsetDateTime dueOn
```
  - environment
```
protected Environment environment
```
  - externalId
```
protected String externalId
```
  - language
```
protected String language
```
  - lineItems
```
protected List<LineItem> lineItems
```
  - merchantReference
```
protected String merchantReference
```
  - outstandingAmount
```
protected BigDecimal outstandingAmount
```
  - paidOn
```
protected OffsetDateTime paidOn
```
  - plannedPurgeDate
```
protected OffsetDateTime plannedPurgeDate
```
  - spaceViewId
```
protected Long spaceViewId
```
  - state
```
protected TransactionInvoiceState state
```
  - taxAmount
```
protected BigDecimal taxAmount
```
  - timeZone
```
protected String timeZone
```
  - version
```
protected Integer version
```
- Constructor Detail
  - TransactionInvoice
```
public TransactionInvoice()
```
- Method Detail
  - getAmount
```
public BigDecimal getAmount()
```
    Returns:
    
    amount
  - getBillingAddress
```
public Address getBillingAddress()
```
    Returns:
    
    billingAddress
  - getCompletion
```
public TransactionCompletion getCompletion()
```
    Returns:
    
    completion
  - getCreatedOn
```
public OffsetDateTime getCreatedOn()
```
    The date on which the invoice is created on.
    
    Returns:
    
    createdOn
  - getDerecognizedBy
```
public Long getDerecognizedBy()
```
    The id of the user which marked the invoice as derecognized.
    
    Returns:
    
    derecognizedBy
  - getDerecognizedOn
```
public OffsetDateTime getDerecognizedOn()
```
    The date on which the invoice is marked as derecognized.
    
    Returns:
    
    derecognizedOn
  - getDueOn
```
public OffsetDateTime getDueOn()
```
    The date on which the invoice should be paid on.
    
    Returns:
    
    dueOn
  - getEnvironment
```
public Environment getEnvironment()
```
    Returns:
    
    environment
  - 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
  - getLanguage
```
public String getLanguage()
```
    Returns:
    
    language
  - getLineItems
```
public List<LineItem> getLineItems()
```
    Returns:
    
    lineItems
  - getMerchantReference
```
public String getMerchantReference()
```
    Returns:
    
    merchantReference
  - getOutstandingAmount
```
public BigDecimal getOutstandingAmount()
```
    The outstanding amount indicates how much the buyer owes the merchant. A negative amount indicates that the invoice is overpaid.
    
    Returns:
    
    outstandingAmount
  - getPaidOn
```
public OffsetDateTime getPaidOn()
```
    The date on which the invoice is marked as paid. Eventually this date lags behind of the actual paid date.
    
    Returns:
    
    paidOn
  - 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
  - getSpaceViewId
```
public Long getSpaceViewId()
```
    Returns:
    
    spaceViewId
  - getState
```
public TransactionInvoiceState getState()
```
    Returns:
    
    state
  - getTaxAmount
```
public BigDecimal getTaxAmount()
```
    Returns:
    
    taxAmount
  - getTimeZone
```
public String getTimeZone()
```
    Returns:
    
    timeZone
  - 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 TransactionAwareEntity
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class TransactionAwareEntity
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class TransactionAwareEntity

Class TransactionInvoice

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

billingAddress

completion

createdOn

derecognizedBy

derecognizedOn

dueOn

environment

externalId

language

lineItems

merchantReference

outstandingAmount

paidOn

plannedPurgeDate

spaceViewId

state

taxAmount

timeZone

version

Constructor Detail

TransactionInvoice

Method Detail

getAmount

getBillingAddress

getCompletion

getCreatedOn

getDerecognizedBy

getDerecognizedOn

getDueOn

getEnvironment

getExternalId

getLanguage

getLineItems

getMerchantReference

getOutstandingAmount

getPaidOn

getPlannedPurgeDate

getSpaceViewId

getState

getTaxAmount

getTimeZone

getVersion

equals

hashCode

toString