com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services

Interface SupplierInvoiceIntegrationService

All Superinterfaces:

BatchService<SupplierInvoiceIntegrationServiceBatch>

All Known Implementing Classes:

DefaultSupplierInvoiceIntegrationService

public interface SupplierInvoiceIntegrationService
extends BatchService<SupplierInvoiceIntegrationServiceBatch>

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

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_PATH If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

Method Summary

Modifier and Type	Method and Description
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.
SupplierInvoiceIntegrationService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService

batch

Field Detail

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

See Also:

Constant Field Values

Method Detail

withServicePath

@Nonnull
SupplierInvoiceIntegrationService withServicePath(@Nonnull
                                                           String servicePath)

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

getAllSuplrInvcHeaderWhldgTax

@Nonnull
SuplrInvcHeaderWhldgTaxFluentHelper getAllSuplrInvcHeaderWhldgTax()

Fetch multiple SuplrInvcHeaderWhldgTax entities.

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
SuplrInvcHeaderWhldgTaxByKeyFluentHelper getSuplrInvcHeaderWhldgTaxByKey(String supplierInvoice,
                                                                                  String fiscalYear,
                                                                                  String withholdingTaxType)

Fetch a single SuplrInvcHeaderWhldgTax entity using key fields.

Parameters:

withholdingTaxType - Indicator for Withholding Tax Type

Constraints: Not nullable, Maximum length: 2

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 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
SuplrInvcItemAcctAssgmtFluentHelper getAllSuplrInvcItemAcctAssgmt()

Fetch multiple SuplrInvcItemAcctAssgmt entities.

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
SuplrInvcItemAcctAssgmtByKeyFluentHelper getSuplrInvcItemAcctAssgmtByKey(String supplierInvoice,
                                                                                  String fiscalYear,
                                                                                  String supplierInvoiceItem,
                                                                                  String ordinalNumber)

Fetch a single SuplrInvcItemAcctAssgmt entity using key fields.

Parameters:

ordinalNumber - Four Character Sequential Number for Coding Block

Constraints: Not nullable, Maximum length: 4

supplierInvoiceItem - Document Item in Invoice Document

Constraints: Not nullable, Maximum length: 6

supplierInvoice - Accounting Document Number

Constraints: Not nullable, Maximum length: 10

fiscalYear - Fiscal Year

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
SuplrInvcItemPurOrdRefFluentHelper getAllSuplrInvcItemPurOrdRef()

Fetch multiple SuplrInvcItemPurOrdRef entities.

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
SuplrInvcItemPurOrdRefByKeyFluentHelper getSuplrInvcItemPurOrdRefByKey(String supplierInvoice,
                                                                                String fiscalYear,
                                                                                String supplierInvoiceItem)

Fetch a single SuplrInvcItemPurOrdRef entity using key fields.

Parameters:

supplierInvoiceItem - Document Item in Invoice Document

Constraints: Not nullable, Maximum length: 6

supplierInvoice - Accounting Document Number

Constraints: Not nullable, Maximum length: 10

fiscalYear - Fiscal Year

Constraints: Not nullable, Maximum length: 4

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
SupplierInvoiceFluentHelper getAllSupplierInvoice()

Fetch multiple SupplierInvoice entities.

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
SupplierInvoiceByKeyFluentHelper getSupplierInvoiceByKey(String supplierInvoice,
                                                                  String fiscalYear)

Fetch a single SupplierInvoice entity using key fields.

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
SupplierInvoiceCreateFluentHelper createSupplierInvoice(@Nonnull
                                                                 SupplierInvoice supplierInvoice)

Create a new SupplierInvoice entity and save it to the S/4HANA system.

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
SupplierInvoiceDeleteFluentHelper deleteSupplierInvoice(@Nonnull
                                                                 SupplierInvoice supplierInvoice)

Deletes an existing SupplierInvoice entity in the S/4HANA system.

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
SupplierInvoiceItemGLAcctFluentHelper getAllSupplierInvoiceItemGLAcct()

Fetch multiple SupplierInvoiceItemGLAcct entities.

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
SupplierInvoiceItemGLAcctByKeyFluentHelper getSupplierInvoiceItemGLAcctByKey(String supplierInvoice,
                                                                                      String fiscalYear,
                                                                                      String supplierInvoiceItem)

Fetch a single SupplierInvoiceItemGLAcct entity using key fields.

Parameters:

supplierInvoiceItem - Four Character Sequential Number for Coding Block

Constraints: Not nullable, Maximum length: 4

supplierInvoice - Accounting Document Number

Constraints: Not nullable, Maximum length: 10

fiscalYear - Fiscal Year

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
SupplierInvoiceTaxFluentHelper getAllSupplierInvoiceTax()

Fetch multiple SupplierInvoiceTax entities.

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
SupplierInvoiceTaxByKeyFluentHelper getSupplierInvoiceTaxByKey(String supplierInvoice,
                                                                        String fiscalYear,
                                                                        String taxCode,
                                                                        String supplierInvoiceTaxCounter)

Fetch a single SupplierInvoiceTax entity using key fields.

Parameters:

supplierInvoice - Document Number of an Invoice Document

Constraints: Not nullable, Maximum length: 10

taxCode - Tax code

Constraints: Not nullable, Maximum length: 2

fiscalYear - Fiscal Year

Constraints: Not nullable, Maximum length: 4

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
ReleaseFluentHelper release(Boolean discountDaysHaveToBeShifted,
                                     String fiscalYear,
                                     String supplierInvoice)

Creates a fluent helper for the Release OData function import.

Parameters:

supplierInvoice - Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: SupplierInvoice

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

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
CancelFluentHelper cancel(String supplierInvoice,
                                   String fiscalYear,
                                   String reversalReason,
                                   LocalDateTime postingDate)

Creates a fluent helper for the Cancel OData function import.

Parameters:

reversalReason - Constraints: Not nullable, Maximum length: 2

Original parameter name from the Odata EDM: ReversalReason

supplierInvoice - Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: SupplierInvoice

postingDate - Constraints: Not nullable, Precision: 0

Original parameter name from the Odata EDM: PostingDate

fiscalYear - Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: FiscalYear

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.