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

Interface SupplierInvoiceIntegrationService

All Known Implementing Classes:

DefaultSupplierInvoiceIntegrationService

public interface SupplierInvoiceIntegrationService

This service enables you to create supplier invoices through an API call from a source system outside SAP S/4HANA Cloud. Furthermore the service enables you to read, release and reverse existing supplier invoices from the SAP S/4HANA Cloud system.

https://help.sap.com/viewer/b2405fab3b314f4ab5021b57231d553f/latest/en-US/7bc52558ef790a02e10000000a44147b.html

Reference: SAP API Business Hub

Details:

OData Service:	API_SUPPLIERINVOICE_PROCESS_SRV
API Version:	1
Communication Scenario:	Supplier Invoice Integration (SAP_COM_0057)
Scope Items:	Consumable Purchasing (BNX), Service and Material Procurement - Project-Based Services (J13), Procurement of Direct Materials (J45)
Authentication Methods:	Basic, x509

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(LocalDateTime postingDate, String reversalReason, String fiscalYear, String supplierInvoice) Creates a fluent helper for the Cancel OData function import.
SuplrInvcHeaderWhldgTaxCreateFluentHelper	createSuplrInvcHeaderWhldgTax(SuplrInvcHeaderWhldgTax suplrInvcHeaderWhldgTax) Create a new SuplrInvcHeaderWhldgTax entity and save it to the S/4HANA system.
SuplrInvcItemPurOrdRefCreateFluentHelper	createSuplrInvcItemPurOrdRef(SuplrInvcItemPurOrdRef suplrInvcItemPurOrdRef) Create a new SuplrInvcItemPurOrdRef entity and save it to the S/4HANA system.
SupplierInvoiceCreateFluentHelper	createSupplierInvoice(SupplierInvoice supplierInvoice) Create a new SupplierInvoice entity and save it to the S/4HANA system.
SupplierInvoiceItemGLAcctCreateFluentHelper	createSupplierInvoiceItemGLAcct(SupplierInvoiceItemGLAcct supplierInvoiceItemGLAcct) Create a new SupplierInvoiceItemGLAcct entity and save it to the S/4HANA system.
SupplierInvoiceTaxCreateFluentHelper	createSupplierInvoiceTax(SupplierInvoiceTax supplierInvoiceTax) Create a new SupplierInvoiceTax entity and save it to the S/4HANA system.
SuplrInvcHeaderWhldgTaxFluentHelper	getAllSuplrInvcHeaderWhldgTax() Fetch multiple SuplrInvcHeaderWhldgTax 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.
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(String supplierInvoice, String fiscalYear, Boolean discountDaysHaveToBeShifted) 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.

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 - This indicator is used to classify the different types of withholding tax.

Constraints: Not nullable, Maximum length: 2

supplierInvoice - Number which uniquely identifies an invoice document.

Constraints: Not nullable, Maximum length: 10

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.

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.

createSuplrInvcHeaderWhldgTax

@Nonnull
SuplrInvcHeaderWhldgTaxCreateFluentHelper createSuplrInvcHeaderWhldgTax(@Nonnull
                                                                                  SuplrInvcHeaderWhldgTax suplrInvcHeaderWhldgTax)

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

Parameters:

suplrInvcHeaderWhldgTax - SuplrInvcHeaderWhldgTax entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new SuplrInvcHeaderWhldgTax entity. 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 - By entering the number of an item in an invoice document, you can go straight to the line that you want to process.

Constraints: Not nullable, Maximum length: 6

supplierInvoice - The document number is the key the system uses to access the accounting document.

Constraints: Not nullable, Maximum length: 10

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.

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.

createSuplrInvcItemPurOrdRef

@Nonnull
SuplrInvcItemPurOrdRefCreateFluentHelper createSuplrInvcItemPurOrdRef(@Nonnull
                                                                                SuplrInvcItemPurOrdRef suplrInvcItemPurOrdRef)

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

Parameters:

suplrInvcItemPurOrdRef - SuplrInvcItemPurOrdRef entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new SuplrInvcItemPurOrdRef entity. 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 - Number which uniquely identifies an invoice document.

Constraints: Not nullable, Maximum length: 10

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.

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.

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 - The document number is the key the system uses to access the accounting document.

Constraints: Not nullable, Maximum length: 10

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.

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.

createSupplierInvoiceItemGLAcct

@Nonnull
SupplierInvoiceItemGLAcctCreateFluentHelper createSupplierInvoiceItemGLAcct(@Nonnull
                                                                                      SupplierInvoiceItemGLAcct supplierInvoiceItemGLAcct)

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

Parameters:

supplierInvoiceItemGLAcct - SupplierInvoiceItemGLAcct entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new SupplierInvoiceItemGLAcct entity. 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 - Number which uniquely identifies an invoice document.

Constraints: Not nullable, Maximum length: 10

taxCode - Tax code

Constraints: Not nullable, Maximum length: 2

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.

Constraints: Not nullable, Maximum length: 4

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

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.

createSupplierInvoiceTax

@Nonnull
SupplierInvoiceTaxCreateFluentHelper createSupplierInvoiceTax(@Nonnull
                                                                        SupplierInvoiceTax supplierInvoiceTax)

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

Parameters:

supplierInvoiceTax - SupplierInvoiceTax entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new SupplierInvoiceTax entity. To perform execution, call the execute method on the fluent helper object.

release

@Nonnull
ReleaseFluentHelper release(String supplierInvoice,
                                      String fiscalYear,
                                      Boolean discountDaysHaveToBeShifted)

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 - Indicator

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

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 - Time Stamp

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.