Interface SupplierInvoiceIntegrationService
- All Superinterfaces:
BatchService<SupplierInvoiceIntegrationServiceBatch>
- All Known Implementing Classes:
DefaultSupplierInvoiceIntegrationService
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.
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 Summary
FieldsModifier and TypeFieldDescriptionstatic final StringDeprecated.If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint. -
Method Summary
Modifier and TypeMethodDescriptioncancel(String supplierInvoice, String fiscalYear, String reversalReason, LocalDateTime postingDate) Deprecated.Creates a fluent helper for the Cancel OData function import.createSupplierInvoice(SupplierInvoice supplierInvoice) Deprecated.Create a newSupplierInvoiceentity and save it to the S/4HANA system.deleteSupplierInvoice(SupplierInvoice supplierInvoice) Deprecated.Deletes an existingSupplierInvoiceentity in the S/4HANA system.Deprecated.Fetch multipleSuplrInvcHeaderWhldgTaxentities.Deprecated.Fetch multipleSuplrInvcItemAcctAssgmtentities.Deprecated.Fetch multipleSuplrInvcItemPurOrdRefentities.Deprecated.Fetch multipleSuplrInvcSeldInbDeliveryNoteentities.Deprecated.Fetch multipleSuplrInvcSeldPurgDocumententities.Deprecated.Fetch multipleSuplrInvcSeldSrvcEntrShtLeanentities.Deprecated.Fetch multipleSuplrInvoiceAdditionalDataentities.Deprecated.Fetch multipleSupplierInvoiceentities.Deprecated.Fetch multipleSupplierInvoiceItemGLAcctentities.Deprecated.Fetch multipleSupplierInvoiceTaxentities.getSuplrInvcHeaderWhldgTaxByKey(String supplierInvoice, String fiscalYear, String withholdingTaxType) Deprecated.Fetch a singleSuplrInvcHeaderWhldgTaxentity using key fields.getSuplrInvcItemAcctAssgmtByKey(String supplierInvoice, String fiscalYear, String supplierInvoiceItem, String ordinalNumber) Deprecated.Fetch a singleSuplrInvcItemAcctAssgmtentity using key fields.getSuplrInvcItemPurOrdRefByKey(String supplierInvoice, String fiscalYear, String supplierInvoiceItem) Deprecated.Fetch a singleSuplrInvcItemPurOrdRefentity using key fields.getSuplrInvcSeldInbDeliveryNoteByKey(String supplierInvoice, String fiscalYear, String inboundDeliveryNote) Deprecated.Fetch a singleSuplrInvcSeldInbDeliveryNoteentity using key fields.getSuplrInvcSeldPurgDocumentByKey(String supplierInvoice, String fiscalYear, String purchaseOrder, String purchaseOrderItem) Deprecated.Fetch a singleSuplrInvcSeldPurgDocumententity using key fields.getSuplrInvcSeldSrvcEntrShtLeanByKey(String supplierInvoice, String fiscalYear, String serviceEntrySheet, String serviceEntrySheetItem) Deprecated.Fetch a singleSuplrInvcSeldSrvcEntrShtLeanentity using key fields.getSuplrInvoiceAdditionalDataByKey(String supplierInvoice, String fiscalYear) Deprecated.Fetch a singleSuplrInvoiceAdditionalDataentity using key fields.getSupplierInvoiceByKey(String supplierInvoice, String fiscalYear) Deprecated.Fetch a singleSupplierInvoiceentity using key fields.getSupplierInvoiceItemGLAcctByKey(String supplierInvoice, String fiscalYear, String supplierInvoiceItem) Deprecated.Fetch a singleSupplierInvoiceItemGLAcctentity using key fields.getSupplierInvoiceTaxByKey(String supplierInvoice, String fiscalYear, String taxCode, String supplierInvoiceTaxCounter) Deprecated.Fetch a singleSupplierInvoiceTaxentity using key fields.Deprecated.Creates a fluent helper for the Post OData function import.Deprecated.Creates a fluent helper for the Release OData function import.withServicePath(String servicePath) Deprecated.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 Details
-
DEFAULT_SERVICE_PATH
Deprecated.If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint.- See Also:
-
-
Method Details
-
withServicePath
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
Deprecated.Fetch multipleSuplrInvcHeaderWhldgTaxentities.- Returns:
- A fluent helper to fetch multiple
SuplrInvcHeaderWhldgTaxentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getSuplrInvcHeaderWhldgTaxByKey
@Nonnull SuplrInvcHeaderWhldgTaxByKeyFluentHelper getSuplrInvcHeaderWhldgTaxByKey(String supplierInvoice, String fiscalYear, String withholdingTaxType) Deprecated.Fetch a singleSuplrInvcHeaderWhldgTaxentity using key fields.- Parameters:
withholdingTaxType- Indicator for Withholding Tax TypeConstraints: Not nullable, Maximum length: 2
supplierInvoice- Document Number of an Invoice DocumentConstraints: Not nullable, Maximum length: 10
fiscalYear- Fiscal YearConstraints: Not nullable, Maximum length: 4
- Returns:
- A fluent helper to fetch a single
SuplrInvcHeaderWhldgTaxentity 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 theexecutemethod on the fluent helper object.
-
getAllSuplrInvcItemAcctAssgmt
Deprecated.Fetch multipleSuplrInvcItemAcctAssgmtentities.- Returns:
- A fluent helper to fetch multiple
SuplrInvcItemAcctAssgmtentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getSuplrInvcItemAcctAssgmtByKey
@Nonnull SuplrInvcItemAcctAssgmtByKeyFluentHelper getSuplrInvcItemAcctAssgmtByKey(String supplierInvoice, String fiscalYear, String supplierInvoiceItem, String ordinalNumber) Deprecated.Fetch a singleSuplrInvcItemAcctAssgmtentity using key fields.- Parameters:
ordinalNumber- Four Character Sequential Number for Coding BlockConstraints: Not nullable, Maximum length: 4
supplierInvoiceItem- Document Item in Invoice DocumentConstraints: Not nullable, Maximum length: 6
supplierInvoice- Document Number of an Accounting DocumentConstraints: Not nullable, Maximum length: 10
fiscalYear- Fiscal YearConstraints: Not nullable, Maximum length: 4
- Returns:
- A fluent helper to fetch a single
SuplrInvcItemAcctAssgmtentity 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 theexecutemethod on the fluent helper object.
-
getAllSuplrInvcItemPurOrdRef
Deprecated.Fetch multipleSuplrInvcItemPurOrdRefentities.- Returns:
- A fluent helper to fetch multiple
SuplrInvcItemPurOrdRefentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getSuplrInvcItemPurOrdRefByKey
@Nonnull SuplrInvcItemPurOrdRefByKeyFluentHelper getSuplrInvcItemPurOrdRefByKey(String supplierInvoice, String fiscalYear, String supplierInvoiceItem) Deprecated.Fetch a singleSuplrInvcItemPurOrdRefentity using key fields.- Parameters:
supplierInvoiceItem- Document Item in Invoice DocumentConstraints: Not nullable, Maximum length: 6
supplierInvoice- Document Number of an Accounting DocumentConstraints: Not nullable, Maximum length: 10
fiscalYear- Fiscal YearConstraints: Not nullable, Maximum length: 4
- Returns:
- A fluent helper to fetch a single
SuplrInvcItemPurOrdRefentity 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 theexecutemethod on the fluent helper object.
-
getAllSuplrInvcSeldInbDeliveryNote
Deprecated.Fetch multipleSuplrInvcSeldInbDeliveryNoteentities.- Returns:
- A fluent helper to fetch multiple
SuplrInvcSeldInbDeliveryNoteentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getSuplrInvcSeldInbDeliveryNoteByKey
@Nonnull SuplrInvcSeldInbDeliveryNoteByKeyFluentHelper getSuplrInvcSeldInbDeliveryNoteByKey(String supplierInvoice, String fiscalYear, String inboundDeliveryNote) Deprecated.Fetch a singleSuplrInvcSeldInbDeliveryNoteentity using key fields.- Parameters:
inboundDeliveryNote- Number of External Delivery NoteConstraints: Not nullable, Maximum length: 16
supplierInvoice- Document Number of an Accounting DocumentConstraints: Not nullable, Maximum length: 10
fiscalYear- Fiscal YearConstraints: Not nullable, Maximum length: 4
- Returns:
- A fluent helper to fetch a single
SuplrInvcSeldInbDeliveryNoteentity 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 theexecutemethod on the fluent helper object.
-
getAllSuplrInvcSeldPurgDocument
Deprecated.Fetch multipleSuplrInvcSeldPurgDocumententities.- Returns:
- A fluent helper to fetch multiple
SuplrInvcSeldPurgDocumententities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getSuplrInvcSeldPurgDocumentByKey
@Nonnull SuplrInvcSeldPurgDocumentByKeyFluentHelper getSuplrInvcSeldPurgDocumentByKey(String supplierInvoice, String fiscalYear, String purchaseOrder, String purchaseOrderItem) Deprecated.Fetch a singleSuplrInvcSeldPurgDocumententity using key fields.- Parameters:
purchaseOrder- Purchasing Document NumberConstraints: Not nullable, Maximum length: 10
supplierInvoice- Document Number of an Accounting DocumentConstraints: Not nullable, Maximum length: 10
purchaseOrderItem- Item Number of Purchasing DocumentConstraints: Not nullable, Maximum length: 5
fiscalYear- Fiscal YearConstraints: Not nullable, Maximum length: 4
- Returns:
- A fluent helper to fetch a single
SuplrInvcSeldPurgDocumententity 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 theexecutemethod on the fluent helper object.
-
getAllSuplrInvcSeldSrvcEntrShtLean
Deprecated.Fetch multipleSuplrInvcSeldSrvcEntrShtLeanentities.- Returns:
- A fluent helper to fetch multiple
SuplrInvcSeldSrvcEntrShtLeanentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getSuplrInvcSeldSrvcEntrShtLeanByKey
@Nonnull SuplrInvcSeldSrvcEntrShtLeanByKeyFluentHelper getSuplrInvcSeldSrvcEntrShtLeanByKey(String supplierInvoice, String fiscalYear, String serviceEntrySheet, String serviceEntrySheetItem) Deprecated.Fetch a singleSuplrInvcSeldSrvcEntrShtLeanentity using key fields.- Parameters:
serviceEntrySheetItem- Item Number of Service Entry SheetConstraints: Not nullable, Maximum length: 5
serviceEntrySheet- Service Entry SheetConstraints: Not nullable, Maximum length: 10
supplierInvoice- Document Number of an Accounting DocumentConstraints: Not nullable, Maximum length: 10
fiscalYear- Fiscal YearConstraints: Not nullable, Maximum length: 4
- Returns:
- A fluent helper to fetch a single
SuplrInvcSeldSrvcEntrShtLeanentity 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 theexecutemethod on the fluent helper object.
-
getAllSuplrInvoiceAdditionalData
Deprecated.Fetch multipleSuplrInvoiceAdditionalDataentities.- Returns:
- A fluent helper to fetch multiple
SuplrInvoiceAdditionalDataentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getSuplrInvoiceAdditionalDataByKey
@Nonnull SuplrInvoiceAdditionalDataByKeyFluentHelper getSuplrInvoiceAdditionalDataByKey(String supplierInvoice, String fiscalYear) Deprecated.Fetch a singleSuplrInvoiceAdditionalDataentity using key fields.- Parameters:
supplierInvoice- Document Number of an Invoice DocumentConstraints: Not nullable, Maximum length: 10
fiscalYear- Fiscal YearConstraints: Not nullable, Maximum length: 4
- Returns:
- A fluent helper to fetch a single
SuplrInvoiceAdditionalDataentity 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 theexecutemethod on the fluent helper object.
-
getAllSupplierInvoice
Deprecated.Fetch multipleSupplierInvoiceentities.- Returns:
- A fluent helper to fetch multiple
SupplierInvoiceentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getSupplierInvoiceByKey
@Nonnull SupplierInvoiceByKeyFluentHelper getSupplierInvoiceByKey(String supplierInvoice, String fiscalYear) Deprecated.Fetch a singleSupplierInvoiceentity using key fields.- Parameters:
supplierInvoice- Document Number of an Invoice DocumentConstraints: Not nullable, Maximum length: 10
fiscalYear- Fiscal YearConstraints: Not nullable, Maximum length: 4
- Returns:
- A fluent helper to fetch a single
SupplierInvoiceentity 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 theexecutemethod on the fluent helper object.
-
createSupplierInvoice
@Nonnull SupplierInvoiceCreateFluentHelper createSupplierInvoice(@Nonnull SupplierInvoice supplierInvoice) Deprecated.Create a newSupplierInvoiceentity and save it to the S/4HANA system.- Parameters:
supplierInvoice-SupplierInvoiceentity object that will be created in the S/4HANA system.- Returns:
- A fluent helper to create a new
SupplierInvoiceentity. To perform execution, call theexecutemethod on the fluent helper object.
-
deleteSupplierInvoice
@Nonnull SupplierInvoiceDeleteFluentHelper deleteSupplierInvoice(@Nonnull SupplierInvoice supplierInvoice) Deprecated.Deletes an existingSupplierInvoiceentity in the S/4HANA system.- Parameters:
supplierInvoice-SupplierInvoiceentity object that will be deleted in the S/4HANA system.- Returns:
- A fluent helper to delete an existing
SupplierInvoiceentity. To perform execution, call theexecutemethod on the fluent helper object.
-
getAllSupplierInvoiceItemGLAcct
Deprecated.Fetch multipleSupplierInvoiceItemGLAcctentities.- Returns:
- A fluent helper to fetch multiple
SupplierInvoiceItemGLAcctentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getSupplierInvoiceItemGLAcctByKey
@Nonnull SupplierInvoiceItemGLAcctByKeyFluentHelper getSupplierInvoiceItemGLAcctByKey(String supplierInvoice, String fiscalYear, String supplierInvoiceItem) Deprecated.Fetch a singleSupplierInvoiceItemGLAcctentity using key fields.- Parameters:
supplierInvoiceItem- Four Character Sequential Number for Coding BlockConstraints: Not nullable, Maximum length: 4
supplierInvoice- Document Number of an Accounting DocumentConstraints: Not nullable, Maximum length: 10
fiscalYear- Fiscal YearConstraints: Not nullable, Maximum length: 4
- Returns:
- A fluent helper to fetch a single
SupplierInvoiceItemGLAcctentity 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 theexecutemethod on the fluent helper object.
-
getAllSupplierInvoiceTax
Deprecated.Fetch multipleSupplierInvoiceTaxentities.- Returns:
- A fluent helper to fetch multiple
SupplierInvoiceTaxentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getSupplierInvoiceTaxByKey
@Nonnull SupplierInvoiceTaxByKeyFluentHelper getSupplierInvoiceTaxByKey(String supplierInvoice, String fiscalYear, String taxCode, String supplierInvoiceTaxCounter) Deprecated.Fetch a singleSupplierInvoiceTaxentity using key fields.- Parameters:
supplierInvoice- Document Number of an Invoice DocumentConstraints: Not nullable, Maximum length: 10
taxCode- Tax codeConstraints: Not nullable, Maximum length: 2
fiscalYear- Fiscal YearConstraints: Not nullable, Maximum length: 4
supplierInvoiceTaxCounter- Document Item in Invoice DocumentConstraints: Not nullable, Maximum length: 6
- Returns:
- A fluent helper to fetch a single
SupplierInvoiceTaxentity 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 theexecutemethod on the fluent helper object.
-
post
Deprecated.Creates a fluent helper for the Post OData function import.
- Parameters:
supplierInvoice- Constraints: Not nullable, Maximum length: 10Original parameter name from the Odata EDM: SupplierInvoice
fiscalYear- Constraints: Not nullable, Maximum length: 4Original 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
executemethod 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: 10Original parameter name from the Odata EDM: SupplierInvoice
discountDaysHaveToBeShifted- IndicatorConstraints: none
Original parameter name from the Odata EDM: DiscountDaysHaveToBeShifted
fiscalYear- Constraints: Not nullable, Maximum length: 4Original 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
executemethod 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: 2Original parameter name from the Odata EDM: ReversalReason
supplierInvoice- Constraints: Not nullable, Maximum length: 10Original parameter name from the Odata EDM: SupplierInvoice
postingDate- Time StampConstraints: Not nullable, Precision: 0
Original parameter name from the Odata EDM: PostingDate
fiscalYear- Constraints: Not nullable, Maximum length: 4Original 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
executemethod on the fluent helper object.
-