Interface SupplierInvoiceIntegrationService

All Superinterfaces:
BatchService<SupplierInvoiceIntegrationServiceBatch>
All Known Implementing Classes:
DefaultSupplierInvoiceIntegrationService

@Deprecated public interface SupplierInvoiceIntegrationService extends BatchService<SupplierInvoiceIntegrationServiceBatch>
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

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, reverse and post existing supplier invoices from the SAP S/4HANA Cloud system. The service is based on the OData protocol.

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: API_SUPPLIERINVOICE_PROCESS_SRV
API Version: 1.3.0
Minimum ERP Version: 2302
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), Procurement of Direct Materials(O45), Consumable Purchasing(ONX)
Authentication Methods: x509
Business Object: Supplier Invoice
  • Field Details

  • Method Details

    • withServicePath

      @Nonnull SupplierInvoiceIntegrationService withServicePath(@Nonnull String servicePath)
      Deprecated.
      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()
      Deprecated.
      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)
      Deprecated.
      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()
      Deprecated.
      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)
      Deprecated.
      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 - Document Number of an Accounting Document

      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()
      Deprecated.
      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)
      Deprecated.
      Fetch a single SuplrInvcItemPurOrdRef entity using key fields.
      Parameters:
      supplierInvoiceItem - Document Item in Invoice Document

      Constraints: Not nullable, Maximum length: 6

      supplierInvoice - Document Number of an Accounting Document

      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.
    • getAllSuplrInvcSeldInbDeliveryNote

      @Nonnull SuplrInvcSeldInbDeliveryNoteFluentHelper getAllSuplrInvcSeldInbDeliveryNote()
      Deprecated.
      Fetch multiple SuplrInvcSeldInbDeliveryNote entities.
      Returns:
      A fluent helper to fetch multiple SuplrInvcSeldInbDeliveryNote 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.
    • getSuplrInvcSeldInbDeliveryNoteByKey

      @Nonnull SuplrInvcSeldInbDeliveryNoteByKeyFluentHelper getSuplrInvcSeldInbDeliveryNoteByKey(String supplierInvoice, String fiscalYear, String inboundDeliveryNote)
      Deprecated.
      Fetch a single SuplrInvcSeldInbDeliveryNote entity using key fields.
      Parameters:
      inboundDeliveryNote - Number of External Delivery Note

      Constraints: Not nullable, Maximum length: 16

      supplierInvoice - Document Number of an Accounting Document

      Constraints: Not nullable, Maximum length: 10

      fiscalYear - Fiscal Year

      Constraints: Not nullable, Maximum length: 4

      Returns:
      A fluent helper to fetch a single SuplrInvcSeldInbDeliveryNote 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.
    • getAllSuplrInvcSeldPurgDocument

      @Nonnull SuplrInvcSeldPurgDocumentFluentHelper getAllSuplrInvcSeldPurgDocument()
      Deprecated.
      Fetch multiple SuplrInvcSeldPurgDocument entities.
      Returns:
      A fluent helper to fetch multiple SuplrInvcSeldPurgDocument 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.
    • getSuplrInvcSeldPurgDocumentByKey

      @Nonnull SuplrInvcSeldPurgDocumentByKeyFluentHelper getSuplrInvcSeldPurgDocumentByKey(String supplierInvoice, String fiscalYear, String purchaseOrder, String purchaseOrderItem)
      Deprecated.
      Fetch a single SuplrInvcSeldPurgDocument entity using key fields.
      Parameters:
      purchaseOrder - Purchasing Document Number

      Constraints: Not nullable, Maximum length: 10

      supplierInvoice - Document Number of an Accounting Document

      Constraints: Not nullable, Maximum length: 10

      purchaseOrderItem - Item Number of Purchasing Document

      Constraints: Not nullable, Maximum length: 5

      fiscalYear - Fiscal Year

      Constraints: Not nullable, Maximum length: 4

      Returns:
      A fluent helper to fetch a single SuplrInvcSeldPurgDocument 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.
    • getAllSuplrInvcSeldSrvcEntrShtLean

      @Nonnull SuplrInvcSeldSrvcEntrShtLeanFluentHelper getAllSuplrInvcSeldSrvcEntrShtLean()
      Deprecated.
      Fetch multiple SuplrInvcSeldSrvcEntrShtLean entities.
      Returns:
      A fluent helper to fetch multiple SuplrInvcSeldSrvcEntrShtLean 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.
    • getSuplrInvcSeldSrvcEntrShtLeanByKey

      @Nonnull SuplrInvcSeldSrvcEntrShtLeanByKeyFluentHelper getSuplrInvcSeldSrvcEntrShtLeanByKey(String supplierInvoice, String fiscalYear, String serviceEntrySheet, String serviceEntrySheetItem)
      Deprecated.
      Fetch a single SuplrInvcSeldSrvcEntrShtLean entity using key fields.
      Parameters:
      serviceEntrySheetItem - Item Number of Service Entry Sheet

      Constraints: Not nullable, Maximum length: 5

      serviceEntrySheet - Service Entry Sheet

      Constraints: Not nullable, Maximum length: 10

      supplierInvoice - Document Number of an Accounting Document

      Constraints: Not nullable, Maximum length: 10

      fiscalYear - Fiscal Year

      Constraints: Not nullable, Maximum length: 4

      Returns:
      A fluent helper to fetch a single SuplrInvcSeldSrvcEntrShtLean 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.
    • getAllSuplrInvoiceAdditionalData

      @Nonnull SuplrInvoiceAdditionalDataFluentHelper getAllSuplrInvoiceAdditionalData()
      Deprecated.
      Fetch multiple SuplrInvoiceAdditionalData entities.
      Returns:
      A fluent helper to fetch multiple SuplrInvoiceAdditionalData 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.
    • getSuplrInvoiceAdditionalDataByKey

      @Nonnull SuplrInvoiceAdditionalDataByKeyFluentHelper getSuplrInvoiceAdditionalDataByKey(String supplierInvoice, String fiscalYear)
      Deprecated.
      Fetch a single SuplrInvoiceAdditionalData 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 SuplrInvoiceAdditionalData 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()
      Deprecated.
      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)
      Deprecated.
      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)
      Deprecated.
      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)
      Deprecated.
      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()
      Deprecated.
      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)
      Deprecated.
      Fetch a single SupplierInvoiceItemGLAcct entity using key fields.
      Parameters:
      supplierInvoiceItem - Four Character Sequential Number for Coding Block

      Constraints: Not nullable, Maximum length: 4

      supplierInvoice - Document Number of an Accounting Document

      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()
      Deprecated.
      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)
      Deprecated.
      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.
    • post

      @Nonnull PostFluentHelper post(@Nonnull String supplierInvoice, @Nonnull String fiscalYear)
      Deprecated.

      Creates a fluent helper for the Post OData function import.

      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

      Returns:
      A fluent helper object that will execute the Post OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.
    • release

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

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

      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.