SupplierInvoiceTax (SAP Cloud SDK - Parent POM 3.17.1 API)

java.lang.Object
- com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
- - com.sap.cloud.sdk.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

Original entity name from the Odata EDM: A_SupplierInvoiceTaxType

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SupplierInvoiceTax.SupplierInvoiceTaxBuilder

Nested Classes
Modifier and Type	Class and Description
`static class`	`SupplierInvoiceTax.SupplierInvoiceTaxBuilder`

Field Summary

Fields
Modifier and Type	Field and Description
`static SupplierInvoiceTaxSelectable`	`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.

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

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 SupplierInvoiceTax.SupplierInvoiceTaxBuilder`	`builder()`
`protected boolean`	`canEqual(Object other)`
`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.
`static <T,DomainT> SupplierInvoiceTaxField<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()`
`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`	`setFiscalYear(String fiscalYear)` (Key Field) Constraints: Not nullable, Maximum length: 4
`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`	`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
`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 SupplierInvoiceTaxSelectable 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
```
public SupplierInvoiceTax()
```
  - SupplierInvoiceTax
```
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)
```
- Method Detail
  - getType
```
@Nonnull
public Class<SupplierInvoiceTax> getType()
```
    Specified by:
    
    getType in class VdmObject<SupplierInvoiceTax>
    
    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.
  - setTaxCode
```
public void setTaxCode(@Nullable
                       String taxCode)
```
    (Key Field) Constraints: Not nullable, Maximum length: 2
    Original property name from the Odata EDM: TaxCode
    
    Parameters:
    
    taxCode - Tax code
  - setSupplierInvoiceTaxCounter
```
public void setSupplierInvoiceTaxCounter(@Nullable
                                         String supplierInvoiceTaxCounter)
```
    (Key Field) Constraints: Not nullable, Maximum length: 6
    Original property name from the Odata EDM: SupplierInvoiceTaxCounter
    
    The system places the line selected at the top of the invoice item display.
    
    Parameters:
    
    supplierInvoiceTaxCounter - By entering the number of an item in an invoice document, you can go straight to the line that you want to process.
  - 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.
  - setTaxAmount
```
public void setTaxAmount(@Nullable
                         BigDecimal taxAmount)
```
    Constraints: Not nullable, Precision: 14, Scale: 3
    Original property name from the Odata EDM: TaxAmount
    
    Parameters:
    
    taxAmount - Tax amount with +/- sign that is calculated from the tax code.
  - setTaxBaseAmountInTransCrcy
```
public void setTaxBaseAmountInTransCrcy(@Nullable
                                        BigDecimal taxBaseAmountInTransCrcy)
```
    Constraints: Not nullable, Precision: 16, Scale: 3
    Original property name from the Odata EDM: TaxBaseAmountInTransCrcy
    
    Parameters:
    
    taxBaseAmountInTransCrcy - Amount from which the tax amount is calculated by means of the tax rate.
  - setTaxJurisdiction
```
public void setTaxJurisdiction(@Nullable
                               String taxJurisdiction)
```
    Constraints: Not nullable, Maximum length: 15
    Original property name from the Odata EDM: TaxJurisdiction
    
    Parameters:
    
    taxJurisdiction - 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.
  - 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<SupplierInvoiceTax>
    
    Returns:
    
    EDMX name of the entity collection identifier.
  - getKey
```
@Nonnull
protected Map<String,Object> getKey()
```
    Overrides:
    
    getKey in class VdmObject<SupplierInvoiceTax>
    
    Returns:
    
    The compound key of this object.
  - toMapOfFields
```
@Nonnull
protected Map<String,Object> toMapOfFields()
```
    Overrides:
    
    toMapOfFields in class VdmObject<SupplierInvoiceTax>
  - fromMap
```
protected void fromMap(Map<String,Object> inputValues)
```
    Overrides:
    
    fromMap in class VdmObject<SupplierInvoiceTax>
  - field
```
@Nonnull
public static <T> SupplierInvoiceTaxField<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> SupplierInvoiceTaxField<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<SupplierInvoiceTax>
    
    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<SupplierInvoiceTax>
  - 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<SupplierInvoiceTax>
    
    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<SupplierInvoiceTax>
    
    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
```
public static SupplierInvoiceTax.SupplierInvoiceTaxBuilder 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.
  - getTaxCode
```
@Nullable
public String getTaxCode()
```
    (Key Field) Constraints: Not nullable, Maximum length: 2
    Original property name from the Odata EDM: TaxCode
    
    Returns:
    
    Tax code
  - getSupplierInvoiceTaxCounter
```
@Nullable
public String getSupplierInvoiceTaxCounter()
```
    (Key Field) Constraints: Not nullable, Maximum length: 6
    Original property name from the Odata EDM: SupplierInvoiceTaxCounter
    
    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
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.
  - getTaxAmount
```
@Nullable
public BigDecimal getTaxAmount()
```
    Constraints: Not nullable, Precision: 14, Scale: 3
    Original property name from the Odata EDM: TaxAmount
    
    Returns:
    
    Tax amount with +/- sign that is calculated from the tax code.
  - getTaxBaseAmountInTransCrcy
```
@Nullable
public BigDecimal getTaxBaseAmountInTransCrcy()
```
    Constraints: Not nullable, Precision: 16, Scale: 3
    Original property name from the Odata EDM: TaxBaseAmountInTransCrcy
    
    Returns:
    
    Amount from which the tax amount is calculated by means of the tax rate.
  - getTaxJurisdiction
```
@Nullable
public String getTaxJurisdiction()
```
    Constraints: Not nullable, Maximum length: 15
    Original property name from the Odata EDM: TaxJurisdiction
    
    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.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class VdmObject<SupplierInvoiceTax>
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class VdmObject<SupplierInvoiceTax>
  - canEqual
```
protected boolean canEqual(Object other)
```
    Overrides:
    
    canEqual in class VdmObject<SupplierInvoiceTax>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class VdmObject<SupplierInvoiceTax>

Class SupplierInvoiceTax

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

ALL_FIELDS

SUPPLIER_INVOICE

FISCAL_YEAR

TAX_CODE

SUPPLIER_INVOICE_TAX_COUNTER

DOCUMENT_CURRENCY

TAX_AMOUNT

TAX_BASE_AMOUNT_IN_TRANS_CRCY

TAX_JURISDICTION

Constructor Detail

SupplierInvoiceTax

SupplierInvoiceTax

Method Detail

getType

setSupplierInvoice

setFiscalYear

setTaxCode

setSupplierInvoiceTaxCounter

setDocumentCurrency

setTaxAmount

setTaxBaseAmountInTransCrcy

setTaxJurisdiction

getEntityCollection

getKey

toMapOfFields

fromMap

field

field

getDestinationForFetch

setServicePathForFetch

attachToService

getDefaultServicePath

builder

getSupplierInvoice

getFiscalYear

getTaxCode

getSupplierInvoiceTaxCounter

getDocumentCurrency

getTaxAmount

getTaxBaseAmountInTransCrcy

getTaxJurisdiction

toString

equals

canEqual

hashCode