it.fattureincloud.sdk.model

Class ReceivedDocument

java.lang.Object

it.fattureincloud.sdk.model.ReceivedDocument

All Implemented Interfaces:

java.io.Serializable

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-10-30T09:09:50.123536Z[Etc/UTC]",
           comments="Generator version: 7.9.0")
public class ReceivedDocument
extends java.lang.Object
implements java.io.Serializable

ReceivedDocument

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SERIALIZED_NAME_AMORTIZATION
static java.lang.String	SERIALIZED_NAME_AMOUNT_GROSS
static java.lang.String	SERIALIZED_NAME_AMOUNT_NET
static java.lang.String	SERIALIZED_NAME_AMOUNT_OTHER_WITHHOLDING_TAX
static java.lang.String	SERIALIZED_NAME_AMOUNT_VAT
static java.lang.String	SERIALIZED_NAME_AMOUNT_WITHHOLDING_TAX
static java.lang.String	SERIALIZED_NAME_ATTACHMENT_PREVIEW_URL
static java.lang.String	SERIALIZED_NAME_ATTACHMENT_TOKEN
static java.lang.String	SERIALIZED_NAME_ATTACHMENT_URL
static java.lang.String	SERIALIZED_NAME_AUTO_CALCULATE
static java.lang.String	SERIALIZED_NAME_CATEGORY
static java.lang.String	SERIALIZED_NAME_CREATED_AT
static java.lang.String	SERIALIZED_NAME_CURRENCY
static java.lang.String	SERIALIZED_NAME_DATE
static java.lang.String	SERIALIZED_NAME_DESCRIPTION
static java.lang.String	SERIALIZED_NAME_E_INVOICE
static java.lang.String	SERIALIZED_NAME_ENTITY
static java.lang.String	SERIALIZED_NAME_ID
static java.lang.String	SERIALIZED_NAME_INVOICE_NUMBER
static java.lang.String	SERIALIZED_NAME_IS_DETAILED
static java.lang.String	SERIALIZED_NAME_IS_MARKED
static java.lang.String	SERIALIZED_NAME_ITEMS_LIST
static java.lang.String	SERIALIZED_NAME_LOCKED
static java.lang.String	SERIALIZED_NAME_NEXT_DUE_DATE
static java.lang.String	SERIALIZED_NAME_PAYMENTS_LIST
static java.lang.String	SERIALIZED_NAME_RC_CENTER
static java.lang.String	SERIALIZED_NAME_TAX_DEDUCTIBILITY
static java.lang.String	SERIALIZED_NAME_TYPE
static java.lang.String	SERIALIZED_NAME_UPDATED_AT
static java.lang.String	SERIALIZED_NAME_VAT_DEDUCTIBILITY

Constructor Summary

Constructors

Constructor and Description
ReceivedDocument()
ReceivedDocument(java.math.BigDecimal amountGross, java.time.LocalDate nextDueDate, java.lang.String attachmentUrl, java.lang.String attachmentPreviewUrl) Constructor with only readonly parameters

Method Summary

Modifier and Type	Method and Description
ReceivedDocument	addItemsListItem(ReceivedDocumentItemsListItem itemsListItem)
ReceivedDocument	addPaymentsListItem(ReceivedDocumentPaymentsListItem paymentsListItem)
ReceivedDocument	amortization(java.math.BigDecimal amortization)
ReceivedDocument	amountNet(java.math.BigDecimal amountNet)
ReceivedDocument	amountOtherWithholdingTax(java.math.BigDecimal amountOtherWithholdingTax)
ReceivedDocument	amountVat(java.math.BigDecimal amountVat)
ReceivedDocument	amountWithholdingTax(java.math.BigDecimal amountWithholdingTax)
ReceivedDocument	attachmentToken(java.lang.String attachmentToken)
ReceivedDocument	autoCalculate(java.lang.Boolean autoCalculate)
ReceivedDocument	category(java.lang.String category)
ReceivedDocument	createdAt(java.lang.String createdAt)
ReceivedDocument	currency(Currency currency)
ReceivedDocument	date(java.time.LocalDate date)
ReceivedDocument	description(java.lang.String description)
ReceivedDocument	eInvoice(java.lang.Boolean eInvoice)
ReceivedDocument	entity(Entity entity)
boolean	equals(java.lang.Object o)
java.math.BigDecimal	getAmortization() Received document amortization value
java.math.BigDecimal	getAmountGross() [Read Only] Received document total gross amount
java.math.BigDecimal	getAmountNet() Received document total net amount
java.math.BigDecimal	getAmountOtherWithholdingTax() Received document other withholding tax amount
java.math.BigDecimal	getAmountVat() Received document total vat amount
java.math.BigDecimal	getAmountWithholdingTax() Received document withholding tax amount
java.lang.String	getAttachmentPreviewUrl() [Temporary] [Read Only] Received document url of the attachment preview
java.lang.String	getAttachmentToken() [Write Only] Received document attachment token returned by POST /received_documents/attachment
java.lang.String	getAttachmentUrl() [Temporary] [Read Only] Received document url of the attached file
java.lang.Boolean	getAutoCalculate() Received document total items amount and total payments amount can differ if this field is set to false
java.lang.String	getCategory() Received document category
java.lang.String	getCreatedAt() Received document creation date
Currency	getCurrency() Get currency
java.time.LocalDate	getDate() Received document date [defaults to today's date]
java.lang.String	getDescription() Received document description
java.lang.Boolean	geteInvoice() [Read Only] Received document is an e-invoice
Entity	getEntity() Get entity
java.lang.Integer	getId() Received document id
java.lang.String	getInvoiceNumber() Received document invoice number
java.lang.Boolean	getIsDetailed() Received document has items
java.lang.Boolean	getIsMarked() Received document is marked
java.util.List<ReceivedDocumentItemsListItem>	getItemsList() Get itemsList
java.lang.Boolean	getLocked() Received Document can't be edited
java.time.LocalDate	getNextDueDate() [Read Only] Received document date of the next not paid payment
java.util.List<ReceivedDocumentPaymentsListItem>	getPaymentsList() Get paymentsList
java.lang.String	getRcCenter() Received document revenue center
java.math.BigDecimal	getTaxDeductibility() Received document tax deducibility percentage
ReceivedDocumentType	getType() Get type
java.lang.String	getUpdatedAt() Received document last update date
java.math.BigDecimal	getVatDeductibility() Received document vat deducibility percentage
int	hashCode()
ReceivedDocument	id(java.lang.Integer id)
ReceivedDocument	invoiceNumber(java.lang.String invoiceNumber)
ReceivedDocument	isDetailed(java.lang.Boolean isDetailed)
ReceivedDocument	isMarked(java.lang.Boolean isMarked)
ReceivedDocument	itemsList(java.util.List<ReceivedDocumentItemsListItem> itemsList)
ReceivedDocument	locked(java.lang.Boolean locked)
ReceivedDocument	paymentsList(java.util.List<ReceivedDocumentPaymentsListItem> paymentsList)
ReceivedDocument	rcCenter(java.lang.String rcCenter)
void	setAmortization(java.math.BigDecimal amortization)
void	setAmountNet(java.math.BigDecimal amountNet)
void	setAmountOtherWithholdingTax(java.math.BigDecimal amountOtherWithholdingTax)
void	setAmountVat(java.math.BigDecimal amountVat)
void	setAmountWithholdingTax(java.math.BigDecimal amountWithholdingTax)
void	setAttachmentToken(java.lang.String attachmentToken)
void	setAutoCalculate(java.lang.Boolean autoCalculate)
void	setCategory(java.lang.String category)
void	setCreatedAt(java.lang.String createdAt)
void	setCurrency(Currency currency)
void	setDate(java.time.LocalDate date)
void	setDescription(java.lang.String description)
void	seteInvoice(java.lang.Boolean eInvoice)
void	setEntity(Entity entity)
void	setId(java.lang.Integer id)
void	setInvoiceNumber(java.lang.String invoiceNumber)
void	setIsDetailed(java.lang.Boolean isDetailed)
void	setIsMarked(java.lang.Boolean isMarked)
void	setItemsList(java.util.List<ReceivedDocumentItemsListItem> itemsList)
void	setLocked(java.lang.Boolean locked)
void	setPaymentsList(java.util.List<ReceivedDocumentPaymentsListItem> paymentsList)
void	setRcCenter(java.lang.String rcCenter)
void	setTaxDeductibility(java.math.BigDecimal taxDeductibility)
void	setType(ReceivedDocumentType type)
void	setUpdatedAt(java.lang.String updatedAt)
void	setVatDeductibility(java.math.BigDecimal vatDeductibility)
ReceivedDocument	taxDeductibility(java.math.BigDecimal taxDeductibility)
java.lang.String	toString()
ReceivedDocument	type(ReceivedDocumentType type)
ReceivedDocument	updatedAt(java.lang.String updatedAt)
ReceivedDocument	vatDeductibility(java.math.BigDecimal vatDeductibility)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_ID

public static final java.lang.String SERIALIZED_NAME_ID

See Also:

Constant Field Values

SERIALIZED_NAME_TYPE

public static final java.lang.String SERIALIZED_NAME_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_ENTITY

public static final java.lang.String SERIALIZED_NAME_ENTITY

See Also:

Constant Field Values

SERIALIZED_NAME_DATE

public static final java.lang.String SERIALIZED_NAME_DATE

See Also:

Constant Field Values

SERIALIZED_NAME_CATEGORY

public static final java.lang.String SERIALIZED_NAME_CATEGORY

See Also:

Constant Field Values

SERIALIZED_NAME_DESCRIPTION

public static final java.lang.String SERIALIZED_NAME_DESCRIPTION

See Also:

Constant Field Values

SERIALIZED_NAME_AMOUNT_NET

public static final java.lang.String SERIALIZED_NAME_AMOUNT_NET

See Also:

Constant Field Values

SERIALIZED_NAME_AMOUNT_VAT

public static final java.lang.String SERIALIZED_NAME_AMOUNT_VAT

See Also:

Constant Field Values

SERIALIZED_NAME_AMOUNT_WITHHOLDING_TAX

public static final java.lang.String SERIALIZED_NAME_AMOUNT_WITHHOLDING_TAX

See Also:

Constant Field Values

SERIALIZED_NAME_AMOUNT_OTHER_WITHHOLDING_TAX

public static final java.lang.String SERIALIZED_NAME_AMOUNT_OTHER_WITHHOLDING_TAX

See Also:

Constant Field Values

SERIALIZED_NAME_AMOUNT_GROSS

public static final java.lang.String SERIALIZED_NAME_AMOUNT_GROSS

See Also:

Constant Field Values

SERIALIZED_NAME_AMORTIZATION

public static final java.lang.String SERIALIZED_NAME_AMORTIZATION

See Also:

Constant Field Values

SERIALIZED_NAME_RC_CENTER

public static final java.lang.String SERIALIZED_NAME_RC_CENTER

See Also:

Constant Field Values

SERIALIZED_NAME_INVOICE_NUMBER

public static final java.lang.String SERIALIZED_NAME_INVOICE_NUMBER

See Also:

Constant Field Values

SERIALIZED_NAME_IS_MARKED

public static final java.lang.String SERIALIZED_NAME_IS_MARKED

See Also:

Constant Field Values

SERIALIZED_NAME_IS_DETAILED

public static final java.lang.String SERIALIZED_NAME_IS_DETAILED

See Also:

Constant Field Values

SERIALIZED_NAME_E_INVOICE

public static final java.lang.String SERIALIZED_NAME_E_INVOICE

See Also:

Constant Field Values

SERIALIZED_NAME_NEXT_DUE_DATE

public static final java.lang.String SERIALIZED_NAME_NEXT_DUE_DATE

See Also:

Constant Field Values

SERIALIZED_NAME_CURRENCY

public static final java.lang.String SERIALIZED_NAME_CURRENCY

See Also:

Constant Field Values

SERIALIZED_NAME_TAX_DEDUCTIBILITY

public static final java.lang.String SERIALIZED_NAME_TAX_DEDUCTIBILITY

See Also:

Constant Field Values

SERIALIZED_NAME_VAT_DEDUCTIBILITY

public static final java.lang.String SERIALIZED_NAME_VAT_DEDUCTIBILITY

See Also:

Constant Field Values

SERIALIZED_NAME_ITEMS_LIST

public static final java.lang.String SERIALIZED_NAME_ITEMS_LIST

See Also:

Constant Field Values

SERIALIZED_NAME_PAYMENTS_LIST

public static final java.lang.String SERIALIZED_NAME_PAYMENTS_LIST

See Also:

Constant Field Values

SERIALIZED_NAME_ATTACHMENT_URL

public static final java.lang.String SERIALIZED_NAME_ATTACHMENT_URL

See Also:

Constant Field Values

SERIALIZED_NAME_ATTACHMENT_PREVIEW_URL

public static final java.lang.String SERIALIZED_NAME_ATTACHMENT_PREVIEW_URL

See Also:

Constant Field Values

SERIALIZED_NAME_AUTO_CALCULATE

public static final java.lang.String SERIALIZED_NAME_AUTO_CALCULATE

See Also:

Constant Field Values

SERIALIZED_NAME_ATTACHMENT_TOKEN

public static final java.lang.String SERIALIZED_NAME_ATTACHMENT_TOKEN

See Also:

Constant Field Values

SERIALIZED_NAME_LOCKED

public static final java.lang.String SERIALIZED_NAME_LOCKED

See Also:

Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final java.lang.String SERIALIZED_NAME_CREATED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_UPDATED_AT

public static final java.lang.String SERIALIZED_NAME_UPDATED_AT

See Also:

Constant Field Values

Constructor Detail

ReceivedDocument

public ReceivedDocument()

ReceivedDocument

public ReceivedDocument(java.math.BigDecimal amountGross,
                        java.time.LocalDate nextDueDate,
                        java.lang.String attachmentUrl,
                        java.lang.String attachmentPreviewUrl)

Constructor with only readonly parameters

Method Detail

id

public ReceivedDocument id(java.lang.Integer id)

getId

@Nullable
public java.lang.Integer getId()

Received document id

Returns:

id

setId

public void setId(java.lang.Integer id)

type

public ReceivedDocument type(ReceivedDocumentType type)

getType

@Nullable
public ReceivedDocumentType getType()

Get type

Returns:

type

setType

public void setType(ReceivedDocumentType type)

entity

public ReceivedDocument entity(Entity entity)

getEntity

@Nullable
public Entity getEntity()

Get entity

Returns:

entity

setEntity

public void setEntity(Entity entity)

date

public ReceivedDocument date(java.time.LocalDate date)

getDate

@Nullable
public java.time.LocalDate getDate()

Received document date [defaults to today's date]

Returns:

date

setDate

public void setDate(java.time.LocalDate date)

category

public ReceivedDocument category(java.lang.String category)

getCategory

@Nullable
public java.lang.String getCategory()

Received document category

Returns:

category

setCategory

public void setCategory(java.lang.String category)

description

public ReceivedDocument description(java.lang.String description)

getDescription

@Nullable
public java.lang.String getDescription()

Received document description

Returns:

description

setDescription

public void setDescription(java.lang.String description)

amountNet

public ReceivedDocument amountNet(java.math.BigDecimal amountNet)

getAmountNet

@Nullable
public java.math.BigDecimal getAmountNet()

Received document total net amount

Returns:

amountNet

setAmountNet

public void setAmountNet(java.math.BigDecimal amountNet)

amountVat

public ReceivedDocument amountVat(java.math.BigDecimal amountVat)

getAmountVat

@Nullable
public java.math.BigDecimal getAmountVat()

Received document total vat amount

Returns:

amountVat

setAmountVat

public void setAmountVat(java.math.BigDecimal amountVat)

amountWithholdingTax

public ReceivedDocument amountWithholdingTax(java.math.BigDecimal amountWithholdingTax)

getAmountWithholdingTax

@Nullable
public java.math.BigDecimal getAmountWithholdingTax()

Received document withholding tax amount

Returns:

amountWithholdingTax

setAmountWithholdingTax

public void setAmountWithholdingTax(java.math.BigDecimal amountWithholdingTax)

amountOtherWithholdingTax

public ReceivedDocument amountOtherWithholdingTax(java.math.BigDecimal amountOtherWithholdingTax)

getAmountOtherWithholdingTax

@Nullable
public java.math.BigDecimal getAmountOtherWithholdingTax()

Received document other withholding tax amount

Returns:

amountOtherWithholdingTax

setAmountOtherWithholdingTax

public void setAmountOtherWithholdingTax(java.math.BigDecimal amountOtherWithholdingTax)

getAmountGross

@Nullable
public java.math.BigDecimal getAmountGross()

[Read Only] Received document total gross amount

Returns:

amountGross

amortization

public ReceivedDocument amortization(java.math.BigDecimal amortization)

getAmortization

@Nullable
public java.math.BigDecimal getAmortization()

Received document amortization value

Returns:

amortization

setAmortization

public void setAmortization(java.math.BigDecimal amortization)

rcCenter

public ReceivedDocument rcCenter(java.lang.String rcCenter)

getRcCenter

@Nullable
public java.lang.String getRcCenter()

Received document revenue center

Returns:

rcCenter

setRcCenter

public void setRcCenter(java.lang.String rcCenter)

invoiceNumber

public ReceivedDocument invoiceNumber(java.lang.String invoiceNumber)

getInvoiceNumber

@Nullable
public java.lang.String getInvoiceNumber()

Received document invoice number

Returns:

invoiceNumber

setInvoiceNumber

public void setInvoiceNumber(java.lang.String invoiceNumber)

isMarked

public ReceivedDocument isMarked(java.lang.Boolean isMarked)

getIsMarked

@Nullable
public java.lang.Boolean getIsMarked()

Received document is marked

Returns:

isMarked

setIsMarked

public void setIsMarked(java.lang.Boolean isMarked)

isDetailed

public ReceivedDocument isDetailed(java.lang.Boolean isDetailed)

getIsDetailed

@Nullable
public java.lang.Boolean getIsDetailed()

Received document has items

Returns:

isDetailed

setIsDetailed

public void setIsDetailed(java.lang.Boolean isDetailed)

eInvoice

public ReceivedDocument eInvoice(java.lang.Boolean eInvoice)

geteInvoice

@Nullable
public java.lang.Boolean geteInvoice()

[Read Only] Received document is an e-invoice

Returns:

eInvoice

seteInvoice

public void seteInvoice(java.lang.Boolean eInvoice)

getNextDueDate

@Nullable
public java.time.LocalDate getNextDueDate()

[Read Only] Received document date of the next not paid payment

Returns:

nextDueDate

currency

public ReceivedDocument currency(Currency currency)

getCurrency

@Nullable
public Currency getCurrency()

Get currency

Returns:

currency

setCurrency

public void setCurrency(Currency currency)

taxDeductibility

public ReceivedDocument taxDeductibility(java.math.BigDecimal taxDeductibility)

getTaxDeductibility

@Nullable
public java.math.BigDecimal getTaxDeductibility()

Received document tax deducibility percentage

Returns:

taxDeductibility

setTaxDeductibility

public void setTaxDeductibility(java.math.BigDecimal taxDeductibility)

vatDeductibility

public ReceivedDocument vatDeductibility(java.math.BigDecimal vatDeductibility)

getVatDeductibility

@Nullable
public java.math.BigDecimal getVatDeductibility()

Received document vat deducibility percentage

Returns:

vatDeductibility

setVatDeductibility

public void setVatDeductibility(java.math.BigDecimal vatDeductibility)

itemsList

public ReceivedDocument itemsList(java.util.List<ReceivedDocumentItemsListItem> itemsList)

addItemsListItem

public ReceivedDocument addItemsListItem(ReceivedDocumentItemsListItem itemsListItem)

getItemsList

@Nullable
public java.util.List<ReceivedDocumentItemsListItem> getItemsList()

Get itemsList

Returns:

itemsList

setItemsList

public void setItemsList(java.util.List<ReceivedDocumentItemsListItem> itemsList)

paymentsList

public ReceivedDocument paymentsList(java.util.List<ReceivedDocumentPaymentsListItem> paymentsList)

addPaymentsListItem

public ReceivedDocument addPaymentsListItem(ReceivedDocumentPaymentsListItem paymentsListItem)

getPaymentsList

@Nullable
public java.util.List<ReceivedDocumentPaymentsListItem> getPaymentsList()

Get paymentsList

Returns:

paymentsList

setPaymentsList

public void setPaymentsList(java.util.List<ReceivedDocumentPaymentsListItem> paymentsList)

getAttachmentUrl

@Nullable
public java.lang.String getAttachmentUrl()

[Temporary] [Read Only] Received document url of the attached file

Returns:

attachmentUrl

getAttachmentPreviewUrl

@Nullable
public java.lang.String getAttachmentPreviewUrl()

[Temporary] [Read Only] Received document url of the attachment preview

Returns:

attachmentPreviewUrl

autoCalculate

public ReceivedDocument autoCalculate(java.lang.Boolean autoCalculate)

getAutoCalculate

@Nullable
public java.lang.Boolean getAutoCalculate()

Received document total items amount and total payments amount can differ if this field is set to false

Returns:

autoCalculate

setAutoCalculate

public void setAutoCalculate(java.lang.Boolean autoCalculate)

attachmentToken

public ReceivedDocument attachmentToken(java.lang.String attachmentToken)

getAttachmentToken

@Nullable
public java.lang.String getAttachmentToken()

[Write Only] Received document attachment token returned by POST /received_documents/attachment

Returns:

attachmentToken

setAttachmentToken

public void setAttachmentToken(java.lang.String attachmentToken)

locked

public ReceivedDocument locked(java.lang.Boolean locked)

getLocked

@Nullable
public java.lang.Boolean getLocked()

Received Document can't be edited

Returns:

locked

setLocked

public void setLocked(java.lang.Boolean locked)

createdAt

public ReceivedDocument createdAt(java.lang.String createdAt)

getCreatedAt

@Nullable
public java.lang.String getCreatedAt()

Received document creation date

Returns:

createdAt

setCreatedAt

public void setCreatedAt(java.lang.String createdAt)

updatedAt

public ReceivedDocument updatedAt(java.lang.String updatedAt)

getUpdatedAt

@Nullable
public java.lang.String getUpdatedAt()

Received document last update date

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(java.lang.String updatedAt)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object