com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierinvoiceintegration

Class SupplierInvoiceTax

java.lang.Object

com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmObject<EntityT>

com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmEntity<SupplierInvoiceTax>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.supplierinvoiceintegration.SupplierInvoiceTax

public class SupplierInvoiceTax
extends VdmEntity<SupplierInvoiceTax>

CDS view for Supplier Invoice Tax API exposure

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SupplierInvoiceTax.SupplierInvoiceTaxBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static EntityFieldAll<SupplierInvoiceTax>	ALL_FIELDS Selector for all available fields of SupplierInvoiceTax.
static SupplierInvoiceTaxField<String>	DOCUMENT_CURRENCY Use with available fluent helpers to apply the DocumentCurrency field to query operations.
static SupplierInvoiceTaxField<String>	FISCAL_YEAR Use with available fluent helpers to apply the FiscalYear field to query operations.
static SupplierInvoiceTaxField<String>	SUPPLIER_INVOICE Use with available fluent helpers to apply the SupplierInvoice field to query operations.
static SupplierInvoiceTaxField<String>	SUPPLIER_INVOICE_TAX_COUNTER Use with available fluent helpers to apply the SupplierInvoiceTaxCounter field to query operations.
static SupplierInvoiceTaxField<BigDecimal>	TAX_AMOUNT Use with available fluent helpers to apply the TaxAmount field to query operations.
static SupplierInvoiceTaxField<BigDecimal>	TAX_BASE_AMOUNT_IN_TRANS_CRCY Use with available fluent helpers to apply the TaxBaseAmountInTransCrcy field to query operations.
static SupplierInvoiceTaxField<String>	TAX_CODE Use with available fluent helpers to apply the TaxCode field to query operations.
static SupplierInvoiceTaxField<String>	TAX_JURISDICTION Use with available fluent helpers to apply the TaxJurisdiction field to query operations.

Constructor Summary

Constructors

Constructor and Description
SupplierInvoiceTax()
SupplierInvoiceTax(String supplierInvoice, String fiscalYear, String taxCode, String supplierInvoiceTaxCounter, String documentCurrency, BigDecimal taxAmount, BigDecimal taxBaseAmountInTransCrcy, String taxJurisdiction, ErpConfigContext erpConfigContext)

Method Summary

Modifier and Type	Method and Description
static SupplierInvoiceTax.SupplierInvoiceTaxBuilder	builder()
boolean	equals(Object o)
static <T> SupplierInvoiceTaxField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
String	getDocumentCurrency() Constraints: Not nullable, Maximum length: 5
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
String	getFiscalYear() (Key Field) Constraints: Not nullable, Maximum length: 4
String	getSupplierInvoice() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getSupplierInvoiceTaxCounter() (Key Field) Constraints: Not nullable, Maximum length: 6
BigDecimal	getTaxAmount() Constraints: Not nullable, Precision: 14, Scale: 3
BigDecimal	getTaxBaseAmountInTransCrcy() Constraints: Not nullable, Precision: 16, Scale: 3
String	getTaxCode() (Key Field) Constraints: Not nullable, Maximum length: 2
String	getTaxJurisdiction() Constraints: Not nullable, Maximum length: 15
Class<SupplierInvoiceTax>	getType()
int	hashCode()
void	setDocumentCurrency(String documentCurrency) Constraints: Not nullable, Maximum length: 5
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g.
void	setFiscalYear(String fiscalYear) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setSupplierInvoice(String supplierInvoice) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setSupplierInvoiceTaxCounter(String supplierInvoiceTaxCounter) (Key Field) Constraints: Not nullable, Maximum length: 6
void	setTaxAmount(BigDecimal taxAmount) Constraints: Not nullable, Precision: 14, Scale: 3
void	setTaxBaseAmountInTransCrcy(BigDecimal taxBaseAmountInTransCrcy) Constraints: Not nullable, Precision: 16, Scale: 3
void	setTaxCode(String taxCode) (Key Field) Constraints: Not nullable, Maximum length: 2
void	setTaxJurisdiction(String taxJurisdiction) Constraints: Not nullable, Maximum length: 15
String	toString()

Methods inherited from class com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmObject

getCustomField, getCustomField, getCustomFieldNames, getCustomFields, hasCustomField, hasCustomField, setCustomField, setCustomField

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALL_FIELDS

public static final EntityFieldAll<SupplierInvoiceTax> ALL_FIELDS

Selector for all available fields of SupplierInvoiceTax.

SUPPLIER_INVOICE

public static final SupplierInvoiceTaxField<String> SUPPLIER_INVOICE

Use with available fluent helpers to apply the SupplierInvoice field to query operations.

FISCAL_YEAR

public static final SupplierInvoiceTaxField<String> FISCAL_YEAR

Use with available fluent helpers to apply the FiscalYear field to query operations.

TAX_CODE

public static final SupplierInvoiceTaxField<String> TAX_CODE

Use with available fluent helpers to apply the TaxCode field to query operations.

SUPPLIER_INVOICE_TAX_COUNTER

public static final SupplierInvoiceTaxField<String> SUPPLIER_INVOICE_TAX_COUNTER

Use with available fluent helpers to apply the SupplierInvoiceTaxCounter field to query operations.

DOCUMENT_CURRENCY

public static final SupplierInvoiceTaxField<String> DOCUMENT_CURRENCY

Use with available fluent helpers to apply the DocumentCurrency field to query operations.

TAX_AMOUNT

public static final SupplierInvoiceTaxField<BigDecimal> TAX_AMOUNT

Use with available fluent helpers to apply the TaxAmount field to query operations.

TAX_BASE_AMOUNT_IN_TRANS_CRCY

public static final SupplierInvoiceTaxField<BigDecimal> TAX_BASE_AMOUNT_IN_TRANS_CRCY

Use with available fluent helpers to apply the TaxBaseAmountInTransCrcy field to query operations.

TAX_JURISDICTION

public static final SupplierInvoiceTaxField<String> TAX_JURISDICTION

Use with available fluent helpers to apply the TaxJurisdiction field to query operations.

Constructor Detail

SupplierInvoiceTax

@Generated(value="lombok")
public SupplierInvoiceTax()

SupplierInvoiceTax

@ConstructorProperties(value={"supplierInvoice","fiscalYear","taxCode","supplierInvoiceTaxCounter","documentCurrency","taxAmount","taxBaseAmountInTransCrcy","taxJurisdiction","erpConfigContext"})
 @Generated(value="lombok")
public SupplierInvoiceTax(@Nullable
                                                                                                                                                                                                                                                          String supplierInvoice,
                                                                                                                                                                                                                                                          @Nullable
                                                                                                                                                                                                                                                          String fiscalYear,
                                                                                                                                                                                                                                                          @Nullable
                                                                                                                                                                                                                                                          String taxCode,
                                                                                                                                                                                                                                                          @Nullable
                                                                                                                                                                                                                                                          String supplierInvoiceTaxCounter,
                                                                                                                                                                                                                                                          @Nullable
                                                                                                                                                                                                                                                          String documentCurrency,
                                                                                                                                                                                                                                                          @Nullable
                                                                                                                                                                                                                                                          BigDecimal taxAmount,
                                                                                                                                                                                                                                                          @Nullable
                                                                                                                                                                                                                                                          BigDecimal taxBaseAmountInTransCrcy,
                                                                                                                                                                                                                                                          @Nullable
                                                                                                                                                                                                                                                          String taxJurisdiction,
                                                                                                                                                                                                                                                          @Nullable
                                                                                                                                                                                                                                                          ErpConfigContext erpConfigContext)

Method Detail

getType

public Class<SupplierInvoiceTax> getType()

Specified by:

getType in class VdmObject<SupplierInvoiceTax>

Returns:

The class of this object.

field

public static <T> SupplierInvoiceTaxField<T> field(String fieldName,
                                                   Class<T> fieldType)

Use with available fluent helpers to apply an extension field to query operations.

Parameters:

fieldName - The name of the extension field as returned by the OData service.

fieldType - The Java type to use for the extension field when performing value comparisons.

Returns:

A representation of an extension field from this entity.

builder

@Generated(value="lombok")
public static SupplierInvoiceTax.SupplierInvoiceTaxBuilder builder()

getSupplierInvoice

@Nullable
 @Generated(value="lombok")
public String getSupplierInvoice()

(Key Field) Constraints: Not nullable, Maximum length: 10

The invoice document number is unique in every company code and fiscal year. Depending on the system configuration, the invoice document number can either be entered manually or be assigned internally by the system from a predefined number range.

Returns:

Number which uniquely identifies an invoice document.

getFiscalYear

@Nullable
 @Generated(value="lombok")
public String getFiscalYear()

(Key Field) Constraints: Not nullable, Maximum length: 4

Returns:

Period, 12 months as a rule, for which the company is to create its inventory and balance sheet. The fiscal year can be the same as the calendar year, but does not have to be.

getTaxCode

@Nullable
 @Generated(value="lombok")
public String getTaxCode()

(Key Field) Constraints: Not nullable, Maximum length: 2

Returns:

Tax code

getSupplierInvoiceTaxCounter

@Nullable
 @Generated(value="lombok")
public String getSupplierInvoiceTaxCounter()

(Key Field) Constraints: Not nullable, Maximum length: 6

The system places the line selected at the top of the invoice item display.

Returns:

By entering the number of an item in an invoice document, you can go straight to the line that you want to process.

getDocumentCurrency

@Nullable
 @Generated(value="lombok")
public String getDocumentCurrency()

Constraints: Not nullable, Maximum length: 5

Returns:

Currency key for amounts in the system.

getTaxAmount

@Nullable
 @Generated(value="lombok")
public BigDecimal getTaxAmount()

Constraints: Not nullable, Precision: 14, Scale: 3

Returns:

Tax amount with +/- sign that is calculated from the tax code.

getTaxBaseAmountInTransCrcy

@Nullable
 @Generated(value="lombok")
public BigDecimal getTaxBaseAmountInTransCrcy()

Constraints: Not nullable, Precision: 16, Scale: 3

Returns:

Amount from which the tax amount is calculated by means of the tax rate.

getTaxJurisdiction

@Nullable
 @Generated(value="lombok")
public String getTaxJurisdiction()

Constraints: Not nullable, Maximum length: 15

Returns:

The tax jurisdiction is used for determining the tax rates in the USA. It defines to which tax authorities you must pay your taxes. It is always the city to which the goods are supplied.

getErpConfigContext

@Nullable
 @Generated(value="lombok")
public ErpConfigContext getErpConfigContext()

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Returns:

The stored ERP system context for executing queries, or null if no such context has been set.

setSupplierInvoice

@Generated(value="lombok")
public void setSupplierInvoice(@Nullable
                                                          String supplierInvoice)

(Key Field) Constraints: Not nullable, Maximum length: 10

The invoice document number is unique in every company code and fiscal year. Depending on the system configuration, the invoice document number can either be entered manually or be assigned internally by the system from a predefined number range.

Parameters:

supplierInvoice -

setFiscalYear

@Generated(value="lombok")
public void setFiscalYear(@Nullable
                                                     String fiscalYear)

(Key Field) Constraints: Not nullable, Maximum length: 4

Parameters:

fiscalYear -

setTaxCode

@Generated(value="lombok")
public void setTaxCode(@Nullable
                                                  String taxCode)

(Key Field) Constraints: Not nullable, Maximum length: 2

Parameters:

taxCode -

setSupplierInvoiceTaxCounter

@Generated(value="lombok")
public void setSupplierInvoiceTaxCounter(@Nullable
                                                                    String supplierInvoiceTaxCounter)

(Key Field) Constraints: Not nullable, Maximum length: 6

The system places the line selected at the top of the invoice item display.

Parameters:

supplierInvoiceTaxCounter -

setDocumentCurrency

@Generated(value="lombok")
public void setDocumentCurrency(@Nullable
                                                           String documentCurrency)

Constraints: Not nullable, Maximum length: 5

Parameters:

documentCurrency -

setTaxAmount

@Generated(value="lombok")
public void setTaxAmount(@Nullable
                                                    BigDecimal taxAmount)

Constraints: Not nullable, Precision: 14, Scale: 3

Parameters:

taxAmount -

setTaxBaseAmountInTransCrcy

@Generated(value="lombok")
public void setTaxBaseAmountInTransCrcy(@Nullable
                                                                   BigDecimal taxBaseAmountInTransCrcy)

Constraints: Not nullable, Precision: 16, Scale: 3

Parameters:

taxBaseAmountInTransCrcy -

setTaxJurisdiction

@Generated(value="lombok")
public void setTaxJurisdiction(@Nullable
                                                          String taxJurisdiction)

Constraints: Not nullable, Maximum length: 15

Parameters:

taxJurisdiction -

setErpConfigContext

@Generated(value="lombok")
public void setErpConfigContext(@Nullable
                                                           ErpConfigContext erpConfigContext)

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Parameters:

erpConfigContext -

toString

@Generated(value="lombok")
public String toString()

Overrides:

toString in class VdmObject<SupplierInvoiceTax>

equals

@Generated(value="lombok")
public boolean equals(Object o)

Overrides:

equals in class VdmObject<SupplierInvoiceTax>

hashCode

@Generated(value="lombok")
public int hashCode()

Overrides:

hashCode in class VdmObject<SupplierInvoiceTax>