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

Interface IncomingVATInvoiceChinaService

All Superinterfaces:

BatchService<IncomingVATInvoiceChinaServiceBatch>

All Known Implementing Classes:

DefaultIncomingVATInvoiceChinaService

public interface IncomingVATInvoiceChinaService
extends BatchService<IncomingVATInvoiceChinaServiceBatch>

The service is based on the *OData* protocol, and can be consumed by external systems and user interfaces to integrate with incoming VAT invoice management in SAP S/4HANA Cloud. You can create a complete China VAT invoice record including invoice header, item and binding record in one single call. You can also perform the following operations: declare, receive, and sign off the invoice. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_CN_VAT_INVOICE_SRV
API Version:	1
Communication Scenario:	Incoming China VAT Invoice Integration (SAP_COM_0546)
Scope Items:	Accounting and Financial Close (J58)
Authentication Methods:	Basic, x509
Business Object:	CN_ValueAddedTaxInvoice

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
CN_TaxInputInvoiceCreateFluentHelper	createCN_TaxInputInvoice(CN_TaxInputInvoice cN_TaxInputInvoice) Create a new CN_TaxInputInvoice entity and save it to the S/4HANA system.
CN_TaxInputInvoiceItemCreateFluentHelper	createCN_TaxInputInvoiceItem(CN_TaxInputInvoiceItem cN_TaxInputInvoiceItem) Create a new CN_TaxInputInvoiceItem entity and save it to the S/4HANA system.
CN_TaxInvoiceBindingRecordCreateFluentHelper	createCN_TaxInvoiceBindingRecord(CN_TaxInvoiceBindingRecord cN_TaxInvoiceBindingRecord) Create a new CN_TaxInvoiceBindingRecord entity and save it to the S/4HANA system.
DeclareInvoiceFluentHelper	declareInvoice(UUID cN_TaxInvcUUID, String declnMonth, String declnYear) Creates a fluent helper for the declareInvoice OData function import.
CN_TaxInputInvoiceFluentHelper	getAllCN_TaxInputInvoice() Fetch multiple CN_TaxInputInvoice entities.
CN_TaxInputInvoiceItemFluentHelper	getAllCN_TaxInputInvoiceItem() Fetch multiple CN_TaxInputInvoiceItem entities.
CN_TaxInvoiceBindingRecordFluentHelper	getAllCN_TaxInvoiceBindingRecord() Fetch multiple CN_TaxInvoiceBindingRecord entities.
CN_TaxInputInvoiceByKeyFluentHelper	getCN_TaxInputInvoiceByKey(UUID cN_TaxInvcUUID) Fetch a single CN_TaxInputInvoice entity using key fields.
CN_TaxInputInvoiceItemByKeyFluentHelper	getCN_TaxInputInvoiceItemByKey(UUID taxInvoiceItemUUID, UUID cN_TaxInvcUUID) Fetch a single CN_TaxInputInvoiceItem entity using key fields.
CN_TaxInvoiceBindingRecordByKeyFluentHelper	getCN_TaxInvoiceBindingRecordByKey(UUID cN_TaxInvcBindgUUID, UUID cN_TaxInvcBindgItmUUID) Fetch a single CN_TaxInvoiceBindingRecord entity using key fields.
ReceiveInvoiceFluentHelper	receiveInvoice(UUID cN_TaxInvcUUID) Creates a fluent helper for the receiveInvoice OData function import.
SignoffInvoiceFluentHelper	signoffInvoice(UUID cN_TaxInvcUUID) Creates a fluent helper for the signoffInvoice OData function import.
IncomingVATInvoiceChinaService	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
IncomingVATInvoiceChinaService 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.

getAllCN_TaxInputInvoice

@Nonnull
CN_TaxInputInvoiceFluentHelper getAllCN_TaxInputInvoice()

Fetch multiple CN_TaxInputInvoice entities.

Returns:

A fluent helper to fetch multiple CN_TaxInputInvoice 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.

getCN_TaxInputInvoiceByKey

@Nonnull
CN_TaxInputInvoiceByKeyFluentHelper getCN_TaxInputInvoiceByKey(UUID cN_TaxInvcUUID)

Fetch a single CN_TaxInputInvoice entity using key fields.

Parameters:

cN_TaxInvcUUID - China Tax Invoice UUID

Constraints: Not nullable

Returns:

A fluent helper to fetch a single CN_TaxInputInvoice 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.

createCN_TaxInputInvoice

@Nonnull
CN_TaxInputInvoiceCreateFluentHelper createCN_TaxInputInvoice(@Nonnull
                                                                       CN_TaxInputInvoice cN_TaxInputInvoice)

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

Parameters:

cN_TaxInputInvoice - CN_TaxInputInvoice entity object that will be created in the S/4HANA system.

Returns:

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

getAllCN_TaxInputInvoiceItem

@Nonnull
CN_TaxInputInvoiceItemFluentHelper getAllCN_TaxInputInvoiceItem()

Fetch multiple CN_TaxInputInvoiceItem entities.

Returns:

A fluent helper to fetch multiple CN_TaxInputInvoiceItem 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.

getCN_TaxInputInvoiceItemByKey

@Nonnull
CN_TaxInputInvoiceItemByKeyFluentHelper getCN_TaxInputInvoiceItemByKey(UUID taxInvoiceItemUUID,
                                                                                UUID cN_TaxInvcUUID)

Fetch a single CN_TaxInputInvoiceItem entity using key fields.

Parameters:

cN_TaxInvcUUID - China Tax Invoice UUID

Constraints: Not nullable

taxInvoiceItemUUID - Invoice Item UUID

Constraints: Not nullable

Returns:

A fluent helper to fetch a single CN_TaxInputInvoiceItem 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.

createCN_TaxInputInvoiceItem

@Nonnull
CN_TaxInputInvoiceItemCreateFluentHelper createCN_TaxInputInvoiceItem(@Nonnull
                                                                               CN_TaxInputInvoiceItem cN_TaxInputInvoiceItem)

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

Parameters:

cN_TaxInputInvoiceItem - CN_TaxInputInvoiceItem entity object that will be created in the S/4HANA system.

Returns:

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

getAllCN_TaxInvoiceBindingRecord

@Nonnull
CN_TaxInvoiceBindingRecordFluentHelper getAllCN_TaxInvoiceBindingRecord()

Fetch multiple CN_TaxInvoiceBindingRecord entities.

Returns:

A fluent helper to fetch multiple CN_TaxInvoiceBindingRecord 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.

getCN_TaxInvoiceBindingRecordByKey

@Nonnull
CN_TaxInvoiceBindingRecordByKeyFluentHelper getCN_TaxInvoiceBindingRecordByKey(UUID cN_TaxInvcBindgUUID,
                                                                                        UUID cN_TaxInvcBindgItmUUID)

Fetch a single CN_TaxInvoiceBindingRecord entity using key fields.

Parameters:

cN_TaxInvcBindgUUID - China Tax Invoice Binding UUID

Constraints: Not nullable

cN_TaxInvcBindgItmUUID - China Tax Invoice Binding Item UUID

Constraints: Not nullable

Returns:

A fluent helper to fetch a single CN_TaxInvoiceBindingRecord 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.

createCN_TaxInvoiceBindingRecord

@Nonnull
CN_TaxInvoiceBindingRecordCreateFluentHelper createCN_TaxInvoiceBindingRecord(@Nonnull
                                                                                       CN_TaxInvoiceBindingRecord cN_TaxInvoiceBindingRecord)

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

Parameters:

cN_TaxInvoiceBindingRecord - CN_TaxInvoiceBindingRecord entity object that will be created in the S/4HANA system.

Returns:

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

receiveInvoice

@Nonnull
ReceiveInvoiceFluentHelper receiveInvoice(@Nonnull
                                                   UUID cN_TaxInvcUUID)

Creates a fluent helper for the receiveInvoice OData function import.

Parameters:

cN_TaxInvcUUID - UUID

Constraints: none

Original parameter name from the Odata EDM: CN_TaxInvcUUID

Returns:

A fluent helper object that will execute the receiveInvoice OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

signoffInvoice

@Nonnull
SignoffInvoiceFluentHelper signoffInvoice(@Nonnull
                                                   UUID cN_TaxInvcUUID)

Creates a fluent helper for the signoffInvoice OData function import.

Parameters:

cN_TaxInvcUUID - UUID

Constraints: none

Original parameter name from the Odata EDM: CN_TaxInvcUUID

Returns:

A fluent helper object that will execute the signoffInvoice OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

declareInvoice

@Nonnull
DeclareInvoiceFluentHelper declareInvoice(@Nonnull
                                                   UUID cN_TaxInvcUUID,
                                                   @Nonnull
                                                   String declnMonth,
                                                   @Nonnull
                                                   String declnYear)

Creates a fluent helper for the declareInvoice OData function import.

Parameters:

declnMonth - Constraints: Not nullable, Maximum length: 2

Original parameter name from the Odata EDM: DeclnMonth

cN_TaxInvcUUID - UUID

Constraints: none

Original parameter name from the Odata EDM: CN_TaxInvcUUID

declnYear - Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: DeclnYear

Returns:

A fluent helper object that will execute the declareInvoice OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.