DefaultSupplierInvoiceIntegrationService (SAP Cloud SDK

java.lang.Object
- com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services.DefaultSupplierInvoiceIntegrationService

All Implemented Interfaces:

BatchService<SupplierInvoiceIntegrationServiceBatch>, SupplierInvoiceIntegrationService
```
@Named(value="com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services.DefaultSupplierInvoiceIntegrationService")
public class DefaultSupplierInvoiceIntegrationService
extends Object
implements SupplierInvoiceIntegrationService
```
This service enables you to create supplier invoices through an API call from a source system outside SAP S/4HANA. Furthermore, the service enables you to read, release, reverse, and delete existing supplier invoices from the SAP S/4HANA system. The service is based on the OData protocol and can be consumed in apps and other user interfaces. This service allows you to create multiple supplier invoices. The service supports a deep create of an invoice only, this means, all nodes can only be created as part of a deep create. Executing multiple deep creates as part of one changeset is not supported..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service: OP_API_SUPPLIERINVOICE_PROCESS_SRV

API Version: 1

Minimum ERP Version: 2020

Authentication Methods: Basic, x509

Business Object: Supplier Invoice

Field Summary
- Fields inherited from interface com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services.SupplierInvoiceIntegrationService
  DEFAULT_SERVICE_PATH

Constructor Summary

Constructors
Constructor and Description

DefaultSupplierInvoiceIntegrationService()
Creates a service using SupplierInvoiceIntegrationService.DEFAULT_SERVICE_PATH to send the requests.

Constructors
Constructor and Description
`DefaultSupplierInvoiceIntegrationService()` Creates a service using `SupplierInvoiceIntegrationService.DEFAULT_SERVICE_PATH` to send the requests.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DefaultSupplierInvoiceIntegrationServiceBatch`	`batch()` Instantiate a new FluentHelper instance for a single OData batch request.
`CancelFluentHelper`	`cancel(String supplierInvoice, String fiscalYear, String reversalReason, LocalDateTime postingDate)` Creates a fluent helper for the Cancel OData function import.
`SupplierInvoiceCreateFluentHelper`	`createSupplierInvoice(SupplierInvoice supplierInvoice)` Create a new `SupplierInvoice` entity and save it to the S/4HANA system.
`SupplierInvoiceDeleteFluentHelper`	`deleteSupplierInvoice(SupplierInvoice supplierInvoice)` Deletes an existing `SupplierInvoice` entity in the S/4HANA system.
`SuplrInvcHeaderWhldgTaxFluentHelper`	`getAllSuplrInvcHeaderWhldgTax()` Fetch multiple `SuplrInvcHeaderWhldgTax` entities.
`SuplrInvcItemAcctAssgmtFluentHelper`	`getAllSuplrInvcItemAcctAssgmt()` Fetch multiple `SuplrInvcItemAcctAssgmt` entities.
`SuplrInvcItemPurOrdRefFluentHelper`	`getAllSuplrInvcItemPurOrdRef()` Fetch multiple `SuplrInvcItemPurOrdRef` entities.
`SupplierInvoiceFluentHelper`	`getAllSupplierInvoice()` Fetch multiple `SupplierInvoice` entities.
`SupplierInvoiceItemGLAcctFluentHelper`	`getAllSupplierInvoiceItemGLAcct()` Fetch multiple `SupplierInvoiceItemGLAcct` entities.
`SupplierInvoiceTaxFluentHelper`	`getAllSupplierInvoiceTax()` Fetch multiple `SupplierInvoiceTax` entities.
`SuplrInvcHeaderWhldgTaxByKeyFluentHelper`	`getSuplrInvcHeaderWhldgTaxByKey(String supplierInvoice, String fiscalYear, String withholdingTaxType)` Fetch a single `SuplrInvcHeaderWhldgTax` entity using key fields.
`SuplrInvcItemAcctAssgmtByKeyFluentHelper`	`getSuplrInvcItemAcctAssgmtByKey(String supplierInvoice, String fiscalYear, String supplierInvoiceItem, String ordinalNumber)` Fetch a single `SuplrInvcItemAcctAssgmt` entity using key fields.
`SuplrInvcItemPurOrdRefByKeyFluentHelper`	`getSuplrInvcItemPurOrdRefByKey(String supplierInvoice, String fiscalYear, String supplierInvoiceItem)` Fetch a single `SuplrInvcItemPurOrdRef` entity using key fields.
`SupplierInvoiceByKeyFluentHelper`	`getSupplierInvoiceByKey(String supplierInvoice, String fiscalYear)` Fetch a single `SupplierInvoice` entity using key fields.
`SupplierInvoiceItemGLAcctByKeyFluentHelper`	`getSupplierInvoiceItemGLAcctByKey(String supplierInvoice, String fiscalYear, String supplierInvoiceItem)` Fetch a single `SupplierInvoiceItemGLAcct` entity using key fields.
`SupplierInvoiceTaxByKeyFluentHelper`	`getSupplierInvoiceTaxByKey(String supplierInvoice, String fiscalYear, String taxCode, String supplierInvoiceTaxCounter)` Fetch a single `SupplierInvoiceTax` entity using key fields.
`ReleaseFluentHelper`	`release(Boolean discountDaysHaveToBeShifted, String fiscalYear, String supplierInvoice)` Creates a fluent helper for the Release OData function import.
`DefaultSupplierInvoiceIntegrationService`	`withServicePath(String servicePath)` Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultSupplierInvoiceIntegrationService
```
public DefaultSupplierInvoiceIntegrationService()
```
    Creates a service using SupplierInvoiceIntegrationService.DEFAULT_SERVICE_PATH to send the requests.
- Method Detail
  - withServicePath
```
@Nonnull
public DefaultSupplierInvoiceIntegrationService withServicePath(@Nonnull
                                                                         String servicePath)
```
    Description copied from interface: SupplierInvoiceIntegrationService
    
    Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.
    
    Specified by:
    
    withServicePath in interface SupplierInvoiceIntegrationService
    
    Parameters:
    
    servicePath - Service path that will override the default.
    
    Returns:
    
    A new service instance with the specified service path.
  - batch
```
@Nonnull
public DefaultSupplierInvoiceIntegrationServiceBatch batch()
```
    Instantiate a new FluentHelper instance for a single OData batch request.
    
    Specified by:
    
    batch in interface BatchService<SupplierInvoiceIntegrationServiceBatch>
    
    Returns:
    
    A new instance of an OData batch request associated with the service object.
  - getAllSuplrInvcHeaderWhldgTax
```
@Nonnull
public SuplrInvcHeaderWhldgTaxFluentHelper getAllSuplrInvcHeaderWhldgTax()
```
    Description copied from interface: SupplierInvoiceIntegrationService
    
    Fetch multiple SuplrInvcHeaderWhldgTax entities.
    
    Specified by:
    
    getAllSuplrInvcHeaderWhldgTax in interface SupplierInvoiceIntegrationService
    
    Returns:
    
    A fluent helper to fetch multiple SuplrInvcHeaderWhldgTax entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - getSuplrInvcHeaderWhldgTaxByKey
```
@Nonnull
public SuplrInvcHeaderWhldgTaxByKeyFluentHelper getSuplrInvcHeaderWhldgTaxByKey(String supplierInvoice,
                                                                                         String fiscalYear,
                                                                                         String withholdingTaxType)
```
    Description copied from interface: SupplierInvoiceIntegrationService
    
    Fetch a single SuplrInvcHeaderWhldgTax entity using key fields.
    
    Specified by:
    
    getSuplrInvcHeaderWhldgTaxByKey in interface SupplierInvoiceIntegrationService
    
    Parameters:
    
    supplierInvoice - Document Number of an Invoice Document
    Constraints: Not nullable, Maximum length: 10
    
    fiscalYear - Fiscal Year
    Constraints: Not nullable, Maximum length: 4
    
    withholdingTaxType - Indicator for Withholding Tax Type
    Constraints: Not nullable, Maximum length: 2
    
    Returns:
    
    A fluent helper to fetch a single SuplrInvcHeaderWhldgTax entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - getAllSuplrInvcItemAcctAssgmt
```
@Nonnull
public SuplrInvcItemAcctAssgmtFluentHelper getAllSuplrInvcItemAcctAssgmt()
```
    Description copied from interface: SupplierInvoiceIntegrationService
    
    Fetch multiple SuplrInvcItemAcctAssgmt entities.
    
    Specified by:
    
    getAllSuplrInvcItemAcctAssgmt in interface SupplierInvoiceIntegrationService
    
    Returns:
    
    A fluent helper to fetch multiple SuplrInvcItemAcctAssgmt entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - getSuplrInvcItemAcctAssgmtByKey
```
@Nonnull
public SuplrInvcItemAcctAssgmtByKeyFluentHelper getSuplrInvcItemAcctAssgmtByKey(String supplierInvoice,
                                                                                         String fiscalYear,
                                                                                         String supplierInvoiceItem,
                                                                                         String ordinalNumber)
```
    Description copied from interface: SupplierInvoiceIntegrationService
    
    Fetch a single SuplrInvcItemAcctAssgmt entity using key fields.
    
    Specified by:
    
    getSuplrInvcItemAcctAssgmtByKey in interface SupplierInvoiceIntegrationService
    
    Parameters:
    
    supplierInvoice - Accounting Document Number
    Constraints: Not nullable, Maximum length: 10
    
    fiscalYear - Fiscal Year
    Constraints: Not nullable, Maximum length: 4
    
    supplierInvoiceItem - Document Item in Invoice Document
    Constraints: Not nullable, Maximum length: 6
    
    ordinalNumber - Four Character Sequential Number for Coding Block
    Constraints: Not nullable, Maximum length: 4
    
    Returns:
    
    A fluent helper to fetch a single SuplrInvcItemAcctAssgmt entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - getAllSuplrInvcItemPurOrdRef
```
@Nonnull
public SuplrInvcItemPurOrdRefFluentHelper getAllSuplrInvcItemPurOrdRef()
```
    Description copied from interface: SupplierInvoiceIntegrationService
    
    Fetch multiple SuplrInvcItemPurOrdRef entities.
    
    Specified by:
    
    getAllSuplrInvcItemPurOrdRef in interface SupplierInvoiceIntegrationService
    
    Returns:
    
    A fluent helper to fetch multiple SuplrInvcItemPurOrdRef entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - getSuplrInvcItemPurOrdRefByKey
```
@Nonnull
public SuplrInvcItemPurOrdRefByKeyFluentHelper getSuplrInvcItemPurOrdRefByKey(String supplierInvoice,
                                                                                       String fiscalYear,
                                                                                       String supplierInvoiceItem)
```
    Description copied from interface: SupplierInvoiceIntegrationService
    
    Fetch a single SuplrInvcItemPurOrdRef entity using key fields.
    
    Specified by:
    
    getSuplrInvcItemPurOrdRefByKey in interface SupplierInvoiceIntegrationService
    
    Parameters:
    
    supplierInvoice - Accounting Document Number
    Constraints: Not nullable, Maximum length: 10
    
    fiscalYear - Fiscal Year
    Constraints: Not nullable, Maximum length: 4
    
    supplierInvoiceItem - Document Item in Invoice Document
    Constraints: Not nullable, Maximum length: 6
    
    Returns:
    
    A fluent helper to fetch a single SuplrInvcItemPurOrdRef entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - getAllSupplierInvoice
```
@Nonnull
public SupplierInvoiceFluentHelper getAllSupplierInvoice()
```
    Description copied from interface: SupplierInvoiceIntegrationService
    
    Fetch multiple SupplierInvoice entities.
    
    Specified by:
    
    getAllSupplierInvoice in interface SupplierInvoiceIntegrationService
    
    Returns:
    
    A fluent helper to fetch multiple SupplierInvoice entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - getSupplierInvoiceByKey
```
@Nonnull
public SupplierInvoiceByKeyFluentHelper getSupplierInvoiceByKey(String supplierInvoice,
                                                                         String fiscalYear)
```
    Description copied from interface: SupplierInvoiceIntegrationService
    
    Fetch a single SupplierInvoice entity using key fields.
    
    Specified by:
    
    getSupplierInvoiceByKey in interface SupplierInvoiceIntegrationService
    
    Parameters:
    
    supplierInvoice - Document Number of an Invoice Document
    Constraints: Not nullable, Maximum length: 10
    
    fiscalYear - Fiscal Year
    Constraints: Not nullable, Maximum length: 4
    
    Returns:
    
    A fluent helper to fetch a single SupplierInvoice entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - createSupplierInvoice
```
@Nonnull
public SupplierInvoiceCreateFluentHelper createSupplierInvoice(@Nonnull
                                                                        SupplierInvoice supplierInvoice)
```
    Description copied from interface: SupplierInvoiceIntegrationService
    
    Create a new SupplierInvoice entity and save it to the S/4HANA system.
    
    Specified by:
    
    createSupplierInvoice in interface SupplierInvoiceIntegrationService
    
    Parameters:
    
    supplierInvoice - SupplierInvoice entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new SupplierInvoice entity. To perform execution, call the execute method on the fluent helper object.
  - deleteSupplierInvoice
```
@Nonnull
public SupplierInvoiceDeleteFluentHelper deleteSupplierInvoice(@Nonnull
                                                                        SupplierInvoice supplierInvoice)
```
    Description copied from interface: SupplierInvoiceIntegrationService
    
    Deletes an existing SupplierInvoice entity in the S/4HANA system.
    
    Specified by:
    
    deleteSupplierInvoice in interface SupplierInvoiceIntegrationService
    
    Parameters:
    
    supplierInvoice - SupplierInvoice entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing SupplierInvoice entity. To perform execution, call the execute method on the fluent helper object.
  - getAllSupplierInvoiceItemGLAcct
```
@Nonnull
public SupplierInvoiceItemGLAcctFluentHelper getAllSupplierInvoiceItemGLAcct()
```
    Description copied from interface: SupplierInvoiceIntegrationService
    
    Fetch multiple SupplierInvoiceItemGLAcct entities.
    
    Specified by:
    
    getAllSupplierInvoiceItemGLAcct in interface SupplierInvoiceIntegrationService
    
    Returns:
    
    A fluent helper to fetch multiple SupplierInvoiceItemGLAcct entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - getSupplierInvoiceItemGLAcctByKey
```
@Nonnull
public SupplierInvoiceItemGLAcctByKeyFluentHelper getSupplierInvoiceItemGLAcctByKey(String supplierInvoice,
                                                                                             String fiscalYear,
                                                                                             String supplierInvoiceItem)
```
    Description copied from interface: SupplierInvoiceIntegrationService
    
    Fetch a single SupplierInvoiceItemGLAcct entity using key fields.
    
    Specified by:
    
    getSupplierInvoiceItemGLAcctByKey in interface SupplierInvoiceIntegrationService
    
    Parameters:
    
    supplierInvoice - Accounting Document Number
    Constraints: Not nullable, Maximum length: 10
    
    fiscalYear - Fiscal Year
    Constraints: Not nullable, Maximum length: 4
    
    supplierInvoiceItem - Four Character Sequential Number for Coding Block
    Constraints: Not nullable, Maximum length: 4
    
    Returns:
    
    A fluent helper to fetch a single SupplierInvoiceItemGLAcct entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - getAllSupplierInvoiceTax
```
@Nonnull
public SupplierInvoiceTaxFluentHelper getAllSupplierInvoiceTax()
```
    Description copied from interface: SupplierInvoiceIntegrationService
    
    Fetch multiple SupplierInvoiceTax entities.
    
    Specified by:
    
    getAllSupplierInvoiceTax in interface SupplierInvoiceIntegrationService
    
    Returns:
    
    A fluent helper to fetch multiple SupplierInvoiceTax entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - getSupplierInvoiceTaxByKey
```
@Nonnull
public SupplierInvoiceTaxByKeyFluentHelper getSupplierInvoiceTaxByKey(String supplierInvoice,
                                                                               String fiscalYear,
                                                                               String taxCode,
                                                                               String supplierInvoiceTaxCounter)
```
    Description copied from interface: SupplierInvoiceIntegrationService
    
    Fetch a single SupplierInvoiceTax entity using key fields.
    
    Specified by:
    
    getSupplierInvoiceTaxByKey in interface SupplierInvoiceIntegrationService
    
    Parameters:
    
    supplierInvoice - Document Number of an Invoice Document
    Constraints: Not nullable, Maximum length: 10
    
    fiscalYear - Fiscal Year
    Constraints: Not nullable, Maximum length: 4
    
    taxCode - Tax code
    Constraints: Not nullable, Maximum length: 2
    
    supplierInvoiceTaxCounter - Document Item in Invoice Document
    Constraints: Not nullable, Maximum length: 6
    
    Returns:
    
    A fluent helper to fetch a single SupplierInvoiceTax entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - release
```
@Nonnull
public ReleaseFluentHelper release(Boolean discountDaysHaveToBeShifted,
                                            String fiscalYear,
                                            String supplierInvoice)
```
    Description copied from interface: SupplierInvoiceIntegrationService
    
    Creates a fluent helper for the Release OData function import.
    
    Specified by:
    
    release in interface SupplierInvoiceIntegrationService
    
    Parameters:
    
    discountDaysHaveToBeShifted - Constraints: none
    Original parameter name from the Odata EDM: DiscountDaysHaveToBeShifted
    
    fiscalYear - Constraints: Not nullable, Maximum length: 4
    Original parameter name from the Odata EDM: FiscalYear
    
    supplierInvoice - Constraints: Not nullable, Maximum length: 10
    Original parameter name from the Odata EDM: SupplierInvoice
    
    Returns:
    
    A fluent helper object that will execute the Release OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.
  - cancel
```
@Nonnull
public CancelFluentHelper cancel(String supplierInvoice,
                                          String fiscalYear,
                                          String reversalReason,
                                          LocalDateTime postingDate)
```
    Description copied from interface: SupplierInvoiceIntegrationService
    
    Creates a fluent helper for the Cancel OData function import.
    
    Specified by:
    
    cancel in interface SupplierInvoiceIntegrationService
    
    Parameters:
    
    supplierInvoice - Constraints: Not nullable, Maximum length: 10
    Original parameter name from the Odata EDM: SupplierInvoice
    
    fiscalYear - Constraints: Not nullable, Maximum length: 4
    Original parameter name from the Odata EDM: FiscalYear
    
    reversalReason - Constraints: Not nullable, Maximum length: 2
    Original parameter name from the Odata EDM: ReversalReason
    
    postingDate - Constraints: Not nullable, Precision: 0
    Original parameter name from the Odata EDM: PostingDate
    
    Returns:
    
    A fluent helper object that will execute the Cancel OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

OData Service:	OP_API_SUPPLIERINVOICE_PROCESS_SRV
API Version:	1
Minimum ERP Version:	2020
Authentication Methods:	Basic, x509
Business Object:	Supplier Invoice

Class DefaultSupplierInvoiceIntegrationService

Details:

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services.SupplierInvoiceIntegrationService

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultSupplierInvoiceIntegrationService

Method Detail

withServicePath

batch

getAllSuplrInvcHeaderWhldgTax

getSuplrInvcHeaderWhldgTaxByKey

getAllSuplrInvcItemAcctAssgmt

getSuplrInvcItemAcctAssgmtByKey

getAllSuplrInvcItemPurOrdRef

getSuplrInvcItemPurOrdRefByKey

getAllSupplierInvoice

getSupplierInvoiceByKey

createSupplierInvoice

deleteSupplierInvoice

getAllSupplierInvoiceItemGLAcct

getSupplierInvoiceItemGLAcctByKey

getAllSupplierInvoiceTax

getSupplierInvoiceTaxByKey

release

cancel