Invoice (billforward-java 1.2014.260 API)

java.lang.Object
- net.billforward.model.BillingEntity
- - net.billforward.model.Invoice

public class Invoice
extends BillingEntity

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Invoice.InvoiceState

static class Invoice.InvoiceType

Nested Classes
Modifier and Type	Class and Description
`static class`	`Invoice.InvoiceState`
`static class`	`Invoice.InvoiceType`

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`accountID`
`protected String`	`changedBy`
`protected BigDecimal`	`costExcludingTax`
`protected Date`	`created`
`protected String`	`currency`
`protected Boolean`	`deleted`
`protected BigDecimal`	`discountAmount`
`protected Date`	`finalExecutionAttempt`
`protected String`	`id`
`protected Boolean`	`initialInvoice`
`protected BigDecimal`	`invoiceCost`
`protected InvoiceLine[]`	`invoiceLines`
`protected BigDecimal`	`invoicePaid`
`protected InvoicePayment[]`	`invoicePayments`
`protected BigDecimal`	`invoiceRefunded`
`protected Date`	`lastExecutionAttempt`
`protected String`	`locked`
`protected String`	`managedBy`
`protected Date`	`nextExecutionAttempt`
`protected String`	`organizationID`
`protected Date`	`paymentReceived`
`protected Date`	`periodEnd`
`protected Date`	`periodStart`
`protected static ResourcePath`	`resourcePath`
`protected String`	`state`
`protected String`	`subscriptionID`
`protected int`	`totalExecutionAttempts`
`protected String`	`type`
`protected Date`	`updated`
`protected String`	`versionID`
`protected int`	`versionNumber`

Fields inherited from class net.billforward.model.BillingEntity
m_client, PRETTY_PRINT_GSON

Constructor Summary

Constructors
Modifier Constructor and Description

protected Invoice()

protected Invoice(BillForwardClient client_)

Constructors
Modifier	Constructor and Description
`protected`	`Invoice()`
`protected`	`Invoice(BillForwardClient client_)`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getAccountID()`
`static Invoice`	`getByID(String ID)`
`static Invoice[]`	`getByState(Invoice.InvoiceState invoiceState_)`
`static Invoice[]`	`getBySubscriptionID(String subscriptionID)`
`String`	`getChangedBy()`
`BigDecimal`	`getCostExcludingTax()`
`Date`	`getCreated()`
`String`	`getCurrency()`
`Boolean`	`getDeleted()`
`BigDecimal`	`getDiscountAmount()`
`Date`	`getFinalExecutionAttempt()`
`String`	`getID()`
`Boolean`	`getInitialInvoice()`
`BigDecimal`	`getInvoiceCost()`
`InvoiceLine[]`	`getInvoiceLines()`
`BigDecimal`	`getInvoicePaid()`
`InvoicePayment[]`	`getInvoicePayments()`
`BigDecimal`	`getInvoiceRefunded()`
`Date`	`getLastExecutionAttempt()`
`String`	`getLocked()`
`String`	`getManagedBy()`
`Date`	`getNextExecutionAttempt()`
`String`	`getOrganizationID()`
`Date`	`getPaymentReceived()`
`Date`	`getPeriodEnd()`
`Date`	`getPeriodStart()`
`protected ResourcePath`	`getResourcePath()`
`Invoice.InvoiceState`	`getState()`
`String`	`getStateAsString()`
`String`	`getSubscriptionID()`
`int`	`getTotalExecutionAttempts()`
`Invoice.InvoiceType`	`getType()`
`String`	`getTypeAsString()`
`Date`	`getUpdated()`
`String`	`getVersionID()`
`int`	`getVersionNumber()`
`IssueInvoiceAmendment`	`issue()`
`InvoiceRecalculationAmendment`	`recalculate(Invoice.InvoiceState newInvoiceState)`
`protected static ResourcePath`	`ResourcePath()`
`InvoiceNextExecutionAttemptAmendment`	`retryTakingPayment()`
`InvoiceNextExecutionAttemptAmendment`	`retryTakingPayment(Date dateToExecute_)`
`void`	`setUsage(int usage)`

Methods inherited from class net.billforward.model.BillingEntity
getAll, getByID, getByID, getByIDPostPath, getClient, setClient, toString

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

Field Detail

id
```
protected String id
```

versionID
```
protected String versionID
```

subscriptionID
```
protected String subscriptionID
```

accountID
```
protected String accountID
```

organizationID
```
protected String organizationID
```

state
```
protected String state
```

periodStart
```
protected Date periodStart
```

periodEnd
```
protected Date periodEnd
```

deleted
```
protected Boolean deleted
```

totalExecutionAttempts
```
protected int totalExecutionAttempts
```

lastExecutionAttempt
```
protected Date lastExecutionAttempt
```

nextExecutionAttempt
```
protected Date nextExecutionAttempt
```

finalExecutionAttempt
```
protected Date finalExecutionAttempt
```

paymentReceived
```
protected Date paymentReceived
```

currency
```
protected String currency
```

costExcludingTax
```
protected BigDecimal costExcludingTax
```

invoiceCost
```
protected BigDecimal invoiceCost
```

invoicePaid
```
protected BigDecimal invoicePaid
```

discountAmount
```
protected BigDecimal discountAmount
```

invoiceRefunded
```
protected BigDecimal invoiceRefunded
```

type
```
protected String type
```

locked
```
protected String locked
```

managedBy
```
protected String managedBy
```

initialInvoice
```
protected Boolean initialInvoice
```

versionNumber
```
protected int versionNumber
```

updated
```
protected Date updated
```

changedBy
```
protected String changedBy
```

created
```
protected Date created
```

invoiceLines
```
protected InvoiceLine[] invoiceLines
```

invoicePayments

protected InvoicePayment[] invoicePayments

resourcePath

protected static ResourcePath resourcePath

Constructor Detail

Invoice

protected Invoice(BillForwardClient client_)

Invoice
```
protected Invoice()
```

Method Detail

getID
```
public String getID()
```

getVersionID
```
public String getVersionID()
```

getSubscriptionID
```
public String getSubscriptionID()
```

getAccountID
```
public String getAccountID()
```

getOrganizationID
```
public String getOrganizationID()
```

getStateAsString
```
public String getStateAsString()
```

getState

public Invoice.InvoiceState getState()

getPeriodStart
```
public Date getPeriodStart()
```

getPeriodEnd
```
public Date getPeriodEnd()
```

getDeleted
```
public Boolean getDeleted()
```

getTotalExecutionAttempts

public int getTotalExecutionAttempts()

getLastExecutionAttempt
```
public Date getLastExecutionAttempt()
```

getNextExecutionAttempt
```
public Date getNextExecutionAttempt()
```

getFinalExecutionAttempt

public Date getFinalExecutionAttempt()

getPaymentReceived
```
public Date getPaymentReceived()
```

getCurrency
```
public String getCurrency()
```

getCostExcludingTax

public BigDecimal getCostExcludingTax()

getInvoiceCost
```
public BigDecimal getInvoiceCost()
```

getInvoicePaid
```
public BigDecimal getInvoicePaid()
```

getDiscountAmount
```
public BigDecimal getDiscountAmount()
```

getInvoiceRefunded

public BigDecimal getInvoiceRefunded()

getTypeAsString
```
public String getTypeAsString()
```

getType
```
public Invoice.InvoiceType getType()
```

getLocked
```
public String getLocked()
```

getManagedBy
```
public String getManagedBy()
```

getInitialInvoice
```
public Boolean getInitialInvoice()
```

getVersionNumber
```
public int getVersionNumber()
```

getUpdated
```
public Date getUpdated()
```

getChangedBy
```
public String getChangedBy()
```

getCreated
```
public Date getCreated()
```

getInvoiceLines

public InvoiceLine[] getInvoiceLines()

getInvoicePayments

public InvoicePayment[] getInvoicePayments()

getByID

public static Invoice getByID(String ID)
                       throws AuthenticationException,
                              InvalidRequestException,
                              APIConnectionException,
                              CardException,
                              APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

getBySubscriptionID

public static Invoice[] getBySubscriptionID(String subscriptionID)
                                     throws AuthenticationException,
                                            InvalidRequestException,
                                            APIConnectionException,
                                            CardException,
                                            APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

getByState

public static Invoice[] getByState(Invoice.InvoiceState invoiceState_)
                            throws AuthenticationException,
                                   InvalidRequestException,
                                   APIConnectionException,
                                   CardException,
                                   APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

getResourcePath
```
protected ResourcePath getResourcePath()
```
Specified by:

getResourcePath in class BillingEntity

ResourcePath

protected static ResourcePath ResourcePath()

recalculate

public InvoiceRecalculationAmendment recalculate(Invoice.InvoiceState newInvoiceState)
                                          throws AuthenticationException,
                                                 InvalidRequestException,
                                                 APIConnectionException,
                                                 CardException,
                                                 APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

retryTakingPayment

public InvoiceNextExecutionAttemptAmendment retryTakingPayment()
                                                        throws AuthenticationException,
                                                               InvalidRequestException,
                                                               APIConnectionException,
                                                               CardException,
                                                               APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

retryTakingPayment

public InvoiceNextExecutionAttemptAmendment retryTakingPayment(Date dateToExecute_)
                                                        throws AuthenticationException,
                                                               InvalidRequestException,
                                                               APIConnectionException,
                                                               CardException,
                                                               APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

issue

public IssueInvoiceAmendment issue()
                            throws AuthenticationException,
                                   InvalidRequestException,
                                   APIConnectionException,
                                   CardException,
                                   APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

setUsage

public void setUsage(int usage)
              throws AuthenticationException,
                     InvalidRequestException,
                     APIConnectionException,
                     CardException,
                     APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

Class Invoice

Nested Class Summary

Field Summary

Fields inherited from class net.billforward.model.BillingEntity

Constructor Summary

Method Summary

Methods inherited from class net.billforward.model.BillingEntity

Methods inherited from class java.lang.Object

Field Detail

id

versionID

subscriptionID

accountID

organizationID

state

periodStart

periodEnd

deleted

totalExecutionAttempts

lastExecutionAttempt

nextExecutionAttempt

finalExecutionAttempt

paymentReceived

currency

costExcludingTax

invoiceCost

invoicePaid

discountAmount

invoiceRefunded

type

locked

managedBy

initialInvoice

versionNumber

updated

changedBy

created

invoiceLines

invoicePayments

resourcePath

Constructor Detail

Invoice

Invoice

Method Detail

getID

getVersionID

getSubscriptionID

getAccountID

getOrganizationID

getStateAsString

getState

getPeriodStart

getPeriodEnd

getDeleted

getTotalExecutionAttempts

getLastExecutionAttempt

getNextExecutionAttempt

getFinalExecutionAttempt

getPaymentReceived

getCurrency

getCostExcludingTax

getInvoiceCost

getInvoicePaid

getDiscountAmount

getInvoiceRefunded

getTypeAsString

getType

getLocked

getManagedBy

getInitialInvoice

getVersionNumber

getUpdated

getChangedBy

getCreated

getInvoiceLines

getInvoicePayments

getByID

getBySubscriptionID

getByState

getResourcePath