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

Class SuplrInvcHeaderWhldgTax

java.lang.Object

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

com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<SuplrInvcHeaderWhldgTax>

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

public class SuplrInvcHeaderWhldgTax
extends VdmEntity<SuplrInvcHeaderWhldgTax>

Withholding Tax Data

Original entity name from the Odata EDM: A_SuplrInvcHeaderWhldgTaxType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SuplrInvcHeaderWhldgTax.SuplrInvcHeaderWhldgTaxBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static SuplrInvcHeaderWhldgTaxSelectable	ALL_FIELDS Selector for all available fields of SuplrInvcHeaderWhldgTax.
static SuplrInvcHeaderWhldgTaxField<String>	DOCUMENT_CURRENCY Use with available fluent helpers to apply the DocumentCurrency field to query operations.
static SuplrInvcHeaderWhldgTaxField<String>	FISCAL_YEAR Use with available fluent helpers to apply the FiscalYear field to query operations.
static SuplrInvcHeaderWhldgTaxField<BigDecimal>	MANUALLY_ENTERED_WHLDG_TAX_AMOUNT Use with available fluent helpers to apply the ManuallyEnteredWhldgTaxAmount field to query operations.
static SuplrInvcHeaderWhldgTaxField<String>	SUPPLIER_INVOICE Use with available fluent helpers to apply the SupplierInvoice field to query operations.
static SuplrInvcHeaderWhldgTaxField<BigDecimal>	WITHHOLDING_TAX_BASE_AMOUNT Use with available fluent helpers to apply the WithholdingTaxBaseAmount field to query operations.
static SuplrInvcHeaderWhldgTaxField<String>	WITHHOLDING_TAX_CODE Use with available fluent helpers to apply the WithholdingTaxCode field to query operations.
static SuplrInvcHeaderWhldgTaxField<String>	WITHHOLDING_TAX_TYPE Use with available fluent helpers to apply the WithholdingTaxType field to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
SuplrInvcHeaderWhldgTax()
SuplrInvcHeaderWhldgTax(String supplierInvoice, String fiscalYear, String withholdingTaxType, String documentCurrency, String withholdingTaxCode, BigDecimal withholdingTaxBaseAmount, BigDecimal manuallyEnteredWhldgTaxAmount)

Method Summary

Modifier and Type	Method and Description
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static SuplrInvcHeaderWhldgTax.SuplrInvcHeaderWhldgTaxBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
static <T> SuplrInvcHeaderWhldgTaxField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> SuplrInvcHeaderWhldgTaxField<T>	field(String fieldName, TypeConverter<T,DomainT> typeConverter) Use with available fluent helpers to apply an extension field to query operations.
protected void	fromMap(Map<String,Object> inputValues)
protected String	getDefaultServicePath() Used by fluent helpers and navigation property methods to construct OData queries.
HttpDestinationProperties	getDestinationForFetch() Convienence field for reusing the same destination with multiple queries (e.g.
String	getDocumentCurrency() Constraints: Not nullable, Maximum length: 5
protected String	getEntityCollection() Used by fluent helpers and navigation property methods to construct OData queries.
String	getFiscalYear() (Key Field) Constraints: Not nullable, Maximum length: 4
protected Map<String,Object>	getKey()
BigDecimal	getManuallyEnteredWhldgTaxAmount() Constraints: Not nullable, Precision: 16, Scale: 3
String	getSupplierInvoice() (Key Field) Constraints: Not nullable, Maximum length: 10
Class<SuplrInvcHeaderWhldgTax>	getType()
BigDecimal	getWithholdingTaxBaseAmount() Constraints: Not nullable, Precision: 16, Scale: 3
String	getWithholdingTaxCode() Constraints: Not nullable, Maximum length: 2
String	getWithholdingTaxType() (Key Field) Constraints: Not nullable, Maximum length: 2
int	hashCode()
void	setDocumentCurrency(String documentCurrency) Constraints: Not nullable, Maximum length: 5
void	setFiscalYear(String fiscalYear) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setManuallyEnteredWhldgTaxAmount(BigDecimal manuallyEnteredWhldgTaxAmount) Constraints: Not nullable, Precision: 16, Scale: 3
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
void	setSupplierInvoice(String supplierInvoice) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setWithholdingTaxBaseAmount(BigDecimal withholdingTaxBaseAmount) Constraints: Not nullable, Precision: 16, Scale: 3
void	setWithholdingTaxCode(String withholdingTaxCode) Constraints: Not nullable, Maximum length: 2
void	setWithholdingTaxType(String withholdingTaxType) (Key Field) Constraints: Not nullable, Maximum length: 2
protected Map<String,Object>	toMapOfFields()
String	toString()

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

getServicePathForFetch, getVersionIdentifier, setDestinationForFetch, setVersionIdentifier

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

getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields, toMapOfNavigationProperties

Methods inherited from class java.lang.Object

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

Field Detail

ALL_FIELDS

public static final SuplrInvcHeaderWhldgTaxSelectable ALL_FIELDS

Selector for all available fields of SuplrInvcHeaderWhldgTax.

SUPPLIER_INVOICE

public static final SuplrInvcHeaderWhldgTaxField<String> SUPPLIER_INVOICE

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

FISCAL_YEAR

public static final SuplrInvcHeaderWhldgTaxField<String> FISCAL_YEAR

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

WITHHOLDING_TAX_TYPE

public static final SuplrInvcHeaderWhldgTaxField<String> WITHHOLDING_TAX_TYPE

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

DOCUMENT_CURRENCY

public static final SuplrInvcHeaderWhldgTaxField<String> DOCUMENT_CURRENCY

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

WITHHOLDING_TAX_CODE

public static final SuplrInvcHeaderWhldgTaxField<String> WITHHOLDING_TAX_CODE

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

WITHHOLDING_TAX_BASE_AMOUNT

public static final SuplrInvcHeaderWhldgTaxField<BigDecimal> WITHHOLDING_TAX_BASE_AMOUNT

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

MANUALLY_ENTERED_WHLDG_TAX_AMOUNT

public static final SuplrInvcHeaderWhldgTaxField<BigDecimal> MANUALLY_ENTERED_WHLDG_TAX_AMOUNT

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

Constructor Detail

SuplrInvcHeaderWhldgTax

public SuplrInvcHeaderWhldgTax()

SuplrInvcHeaderWhldgTax

public SuplrInvcHeaderWhldgTax(@Nullable
                               String supplierInvoice,
                               @Nullable
                               String fiscalYear,
                               @Nullable
                               String withholdingTaxType,
                               @Nullable
                               String documentCurrency,
                               @Nullable
                               String withholdingTaxCode,
                               @Nullable
                               BigDecimal withholdingTaxBaseAmount,
                               @Nullable
                               BigDecimal manuallyEnteredWhldgTaxAmount)

Method Detail

getType

@Nonnull
public Class<SuplrInvcHeaderWhldgTax> getType()

Specified by:

getType in class VdmObject<SuplrInvcHeaderWhldgTax>

Returns:

The class of this object.

setSupplierInvoice

public void setSupplierInvoice(@Nullable
                               String supplierInvoice)

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

Original property name from the Odata EDM: SupplierInvoice

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 - Number which uniquely identifies an invoice document.

setFiscalYear

public void setFiscalYear(@Nullable
                          String fiscalYear)

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

Original property name from the Odata EDM: FiscalYear

Parameters:

fiscalYear - 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.

setWithholdingTaxType

public void setWithholdingTaxType(@Nullable
                                  String withholdingTaxType)

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

Original property name from the Odata EDM: WithholdingTaxType

Withholding tax types classify particular features of a withholding tax including:The time at which the withholding tax is postedThe basis on which the base amount is calculatedThe basis for accumulation (if applicable)Withholding tax types are to be distinguished from withholding tax codes, to which are allocated the withholding tax percentage rate example.Whether a withholding tax can be defined as an existing type by means of a new code, or if a new type needs to be defined will depend on the type of transaction (see below).Note that a business transaction can only be assigned one withholding tax code per withholding tax type. If the business transaction is subject to several withholding taxes simultaneously, these must be represented by different types.This is the case in Argentina for example, where up to four kinds of withholding tax per business transaction are possible.

Parameters:

withholdingTaxType - This indicator is used to classify the different types of withholding tax.

setDocumentCurrency

public void setDocumentCurrency(@Nullable
                                String documentCurrency)

Constraints: Not nullable, Maximum length: 5

Original property name from the Odata EDM: DocumentCurrency

Parameters:

documentCurrency - Currency key for amounts in the system.

setWithholdingTaxCode

public void setWithholdingTaxCode(@Nullable
                                  String withholdingTaxCode)

Constraints: Not nullable, Maximum length: 2

Original property name from the Odata EDM: WithholdingTaxCode

Note that when processing a business transaction, no more than one withholding tax code can be assigned per withholding tax type. If the business transaction is subject to more than one withholding taxes, these must be represented in the system by defining various withholding tax types.

Parameters:

withholdingTaxCode - One or more "withholding tax codes" are assigned to each withholding tax type. One of the things these codes determine is the various percentage rates for the withholding tax type.

setWithholdingTaxBaseAmount

public void setWithholdingTaxBaseAmount(@Nullable
                                        BigDecimal withholdingTaxBaseAmount)

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

Original property name from the Odata EDM: WithholdingTaxBaseAmount

Parameters:

withholdingTaxBaseAmount - Withholding Tax Base Amount in Document Currency

setManuallyEnteredWhldgTaxAmount

public void setManuallyEnteredWhldgTaxAmount(@Nullable
                                             BigDecimal manuallyEnteredWhldgTaxAmount)

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

Original property name from the Odata EDM: ManuallyEnteredWhldgTaxAmount

Parameters:

manuallyEnteredWhldgTaxAmount - Manually entered withholding tax amount in document currency.

getEntityCollection

protected String getEntityCollection()

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Specified by:

getEntityCollection in class VdmEntity<SuplrInvcHeaderWhldgTax>

Returns:

EDMX name of the entity collection identifier.

getKey

@Nonnull
protected Map<String,Object> getKey()

Overrides:

getKey in class VdmObject<SuplrInvcHeaderWhldgTax>

Returns:

The compound key of this object.

toMapOfFields

@Nonnull
protected Map<String,Object> toMapOfFields()

Overrides:

toMapOfFields in class VdmObject<SuplrInvcHeaderWhldgTax>

fromMap

protected void fromMap(Map<String,Object> inputValues)

Overrides:

fromMap in class VdmObject<SuplrInvcHeaderWhldgTax>

field

@Nonnull
public static <T> SuplrInvcHeaderWhldgTaxField<T> field(@Nonnull
                                                                 String fieldName,
                                                                 @Nonnull
                                                                 Class<T> fieldType)

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

Type Parameters:

T - The type of the extension field when performing value comparisons.

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.

field

@Nonnull
public static <T,DomainT> SuplrInvcHeaderWhldgTaxField<T> field(@Nonnull
                                                                         String fieldName,
                                                                         @Nonnull
                                                                         TypeConverter<T,DomainT> typeConverter)

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

Type Parameters:

T - The type of the extension field when performing value comparisons.

DomainT - The type of the extension field as returned by the OData service.

Parameters:

typeConverter - A TypeConverter instance whose first generic type matches the Java type of the field

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

Returns:

A representation of an extension field from this entity, holding a reference to the given TypeConverter.

getDestinationForFetch

@Nullable
public HttpDestinationProperties getDestinationForFetch()

Description copied from class: VdmEntity

Convienence field for reusing the same destination with multiple queries (e.g. fetching associated entities). New destination to apply to this entity

Overrides:

getDestinationForFetch in class VdmEntity<SuplrInvcHeaderWhldgTax>

Returns:

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

setServicePathForFetch

protected void setServicePathForFetch(@Nullable
                                      String servicePathForFetch)

Description copied from class: VdmEntity

The service path only used for the fetch commands of this entity.

Note: Use with caution, as this can easily break the fetch call on this entity. See the interface of the corresponding service for the default service path.

Overrides:

setServicePathForFetch in class VdmEntity<SuplrInvcHeaderWhldgTax>

attachToService

public void attachToService(@Nullable
                            String servicePath,
                            @Nonnull
                            HttpDestinationProperties destination)

Description copied from class: VdmEntity

Sets the service path and destination for the fetch commands of this entity. Also applies to any associated entities (navigation properties) that were previously fetched.

Note: Use with caution, as this can easily break the fetch calls on this entity. See the interface of the corresponding service for the default service path.

Overrides:

attachToService in class VdmEntity<SuplrInvcHeaderWhldgTax>

Parameters:

servicePath - Optional parameter. New service path to apply to this entity and any associated entities that were previously fetched. If a null value is provided and the service path has never been set, then the service path will be set to the default defined in the corresponding service interface.

destination - New destination to apply to this entity and any associated entities that were previously fetched.

getDefaultServicePath

protected String getDefaultServicePath()

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Overrides:

getDefaultServicePath in class VdmEntity<SuplrInvcHeaderWhldgTax>

Returns:

Default context path to the OData service. In other words, everything in between the protocol://hostname:port and the OData resource name (entity set, $metadata, etc.)

builder

@Nonnull
public static SuplrInvcHeaderWhldgTax.SuplrInvcHeaderWhldgTaxBuilder builder()

getSupplierInvoice

@Nullable
public String getSupplierInvoice()

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

Original property name from the Odata EDM: SupplierInvoice

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
public String getFiscalYear()

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

Original property name from the Odata EDM: FiscalYear

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.

getWithholdingTaxType

@Nullable
public String getWithholdingTaxType()

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

Original property name from the Odata EDM: WithholdingTaxType

Withholding tax types classify particular features of a withholding tax including:The time at which the withholding tax is postedThe basis on which the base amount is calculatedThe basis for accumulation (if applicable)Withholding tax types are to be distinguished from withholding tax codes, to which are allocated the withholding tax percentage rate example.Whether a withholding tax can be defined as an existing type by means of a new code, or if a new type needs to be defined will depend on the type of transaction (see below).Note that a business transaction can only be assigned one withholding tax code per withholding tax type. If the business transaction is subject to several withholding taxes simultaneously, these must be represented by different types.This is the case in Argentina for example, where up to four kinds of withholding tax per business transaction are possible.

Returns:

This indicator is used to classify the different types of withholding tax.

getDocumentCurrency

@Nullable
public String getDocumentCurrency()

Constraints: Not nullable, Maximum length: 5

Original property name from the Odata EDM: DocumentCurrency

Returns:

Currency key for amounts in the system.

getWithholdingTaxCode

@Nullable
public String getWithholdingTaxCode()

Constraints: Not nullable, Maximum length: 2

Original property name from the Odata EDM: WithholdingTaxCode

Note that when processing a business transaction, no more than one withholding tax code can be assigned per withholding tax type. If the business transaction is subject to more than one withholding taxes, these must be represented in the system by defining various withholding tax types.

Returns:

One or more "withholding tax codes" are assigned to each withholding tax type. One of the things these codes determine is the various percentage rates for the withholding tax type.

getWithholdingTaxBaseAmount

@Nullable
public BigDecimal getWithholdingTaxBaseAmount()

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

Original property name from the Odata EDM: WithholdingTaxBaseAmount

Returns:

Withholding Tax Base Amount in Document Currency

getManuallyEnteredWhldgTaxAmount

@Nullable
public BigDecimal getManuallyEnteredWhldgTaxAmount()

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

Original property name from the Odata EDM: ManuallyEnteredWhldgTaxAmount

Returns:

Manually entered withholding tax amount in document currency.

toString

@Nonnull
public String toString()

Overrides:

toString in class VdmObject<SuplrInvcHeaderWhldgTax>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class VdmObject<SuplrInvcHeaderWhldgTax>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class VdmObject<SuplrInvcHeaderWhldgTax>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<SuplrInvcHeaderWhldgTax>