Invoice (harvest-client 1.1.2 API)

All Superinterfaces:: BaseObject<Invoice>, Reference<Invoice>

@Gson.TypeAdapters(fieldNamingStrategy=true)
 @Value.Immutable
public interface Invoice
extends BaseObject<Invoice>

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class Invoice.State
Not documented online: got this from Harvest:

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Invoice.State` Not documented online: got this from Harvest:

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Double`	`getAmount()`
`Reference<Client>`	`getClient()`
`String`	`getClientKey()`
`Instant`	`getClosedAt()`
`Creator`	`getCreator()`
`String`	`getCurrency()`
`Double`	`getDiscount()`
`Double`	`getDiscountAmount()`
`Double`	`getDueAmount()`
`LocalDate`	`getDueDate()`
`Reference<Estimate>`	`getEstimate()`
`List<InvoiceItem>`	`getInvoiceItems()`
`LocalDate`	`getIssueDate()`
`String`	`getNotes()` max length = 65,535
`String`	`getNumber()`
`Instant`	`getPaidAt()`
`LocalDate`	`getPaidDate()`
`LocalDate`	`getPeriodEnd()`
`LocalDate`	`getPeriodStart()`
`String`	`getPurchaseOrder()`
`Retainer`	`getRetainer()`
`Instant`	`getSentAt()`
`default Invoice.State`	`getState(ZoneId zoneId)`
`String`	`getSubject()`
`Double`	`getTax()`
`Double`	`getTax2()`
`Double`	`getTaxAmount()`
`Double`	`getTaxAmount2()`

Methods inherited from interface ch.aaap.harvestclient.domain.BaseObject
getCreatedAt, getId, getUpdatedAt

Methods inherited from interface ch.aaap.harvestclient.domain.reference.Reference
requireId

Method Detail

getState
```
default Invoice.State getState(ZoneId zoneId)
```
Parameters:

zoneId - the timezone to use for deciding between LATE and OPEN

Returns:

the invoice current State

getClient

@SerializedName(value="client_id",
                alternate="client")
Reference<Client> getClient()

getInvoiceItems

@SerializedName(value="line_items")
 @Nullable
List<InvoiceItem> getInvoiceItems()

getEstimate

@Nullable
Reference<Estimate> getEstimate()

getRetainer
```
@Nullable
Retainer getRetainer()
```

getCreator
```
@Nullable
Creator getCreator()
```

getClientKey
```
@Nullable
String getClientKey()
```

getNumber
```
@Nullable
String getNumber()
```

getPurchaseOrder
```
@Nullable
String getPurchaseOrder()
```

getAmount
```
@Nullable
Double getAmount()
```

getDueAmount
```
@Nullable
Double getDueAmount()
```

getTax
```
@Nullable
Double getTax()
```

getTaxAmount
```
@Nullable
Double getTaxAmount()
```

getTax2
```
@Nullable
Double getTax2()
```

getTaxAmount2
```
@Nullable
Double getTaxAmount2()
```

getDiscount
```
@Nullable
Double getDiscount()
```

getDiscountAmount
```
@Nullable
Double getDiscountAmount()
```

getSubject
```
@Nullable
String getSubject()
```

getNotes
```
@Nullable
String getNotes()
```
max length = 65,535

Returns:

the current value

getCurrency
```
@Nullable
String getCurrency()
```

getPeriodStart
```
@Nullable
LocalDate getPeriodStart()
```

getPeriodEnd
```
@Nullable
LocalDate getPeriodEnd()
```

getIssueDate
```
@Nullable
LocalDate getIssueDate()
```

getDueDate
```
@Nullable
LocalDate getDueDate()
```

getSentAt
```
@Nullable
Instant getSentAt()
```

getPaidAt
```
@Nullable
Instant getPaidAt()
```

getPaidDate
```
@Nullable
LocalDate getPaidDate()
```

getClosedAt
```
@Nullable
Instant getClosedAt()
```

Interface Invoice

Nested Class Summary

Method Summary

Methods inherited from interface ch.aaap.harvestclient.domain.BaseObject

Methods inherited from interface ch.aaap.harvestclient.domain.reference.Reference

Method Detail

getState

getClient

getInvoiceItems

getEstimate

getRetainer

getCreator

getClientKey

getNumber

getPurchaseOrder

getAmount

getDueAmount

getTax

getTaxAmount

getTax2

getTaxAmount2

getDiscount

getDiscountAmount

getSubject

getNotes

getCurrency

getPeriodStart

getPeriodEnd

getIssueDate

getDueDate

getSentAt

getPaidAt

getPaidDate

getClosedAt