DefaultIncomingVATInvoiceChinaService (SAP Cloud SDK

java.lang.Object
- com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultIncomingVATInvoiceChinaService

All Implemented Interfaces:: BatchService<IncomingVATInvoiceChinaServiceBatch>, IncomingVATInvoiceChinaService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultIncomingVATInvoiceChinaService")
public class DefaultIncomingVATInvoiceChinaService
extends Object
implements IncomingVATInvoiceChinaService

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 inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.IncomingVATInvoiceChinaService
  DEFAULT_SERVICE_PATH

Constructor Summary

Constructors
Constructor and Description

DefaultIncomingVATInvoiceChinaService()
Creates a service using IncomingVATInvoiceChinaService.DEFAULT_SERVICE_PATH to send the requests.

Constructors
Constructor and Description
`DefaultIncomingVATInvoiceChinaService()` Creates a service using `IncomingVATInvoiceChinaService.DEFAULT_SERVICE_PATH` to send the requests.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DefaultIncomingVATInvoiceChinaServiceBatch`	`batch()` Instantiate a new FluentHelper instance for a single OData batch request.
`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.
`DefaultIncomingVATInvoiceChinaService`	`withServicePath(String servicePath)` Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultIncomingVATInvoiceChinaService
```
public DefaultIncomingVATInvoiceChinaService()
```
    Creates a service using IncomingVATInvoiceChinaService.DEFAULT_SERVICE_PATH to send the requests.
- Method Detail
  - withServicePath
```
@Nonnull
public DefaultIncomingVATInvoiceChinaService withServicePath(@Nonnull
                                                                      String servicePath)
```
    Description copied from interface: IncomingVATInvoiceChinaService
    
    Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.
    
    Specified by:
    
    withServicePath in interface IncomingVATInvoiceChinaService
    
    Parameters:
    
    servicePath - Service path that will override the default.
    
    Returns:
    
    A new service instance with the specified service path.
  - batch
```
@Nonnull
public DefaultIncomingVATInvoiceChinaServiceBatch batch()
```
    Instantiate a new FluentHelper instance for a single OData batch request.
    
    Specified by:
    
    batch in interface BatchService<IncomingVATInvoiceChinaServiceBatch>
    
    Returns:
    
    A new instance of an OData batch request associated with the service object.
  - getAllCN_TaxInputInvoice
```
@Nonnull
public CN_TaxInputInvoiceFluentHelper getAllCN_TaxInputInvoice()
```
    Description copied from interface: IncomingVATInvoiceChinaService
    
    Fetch multiple CN_TaxInputInvoice entities.
    
    Specified by:
    
    getAllCN_TaxInputInvoice in interface IncomingVATInvoiceChinaService
    
    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
public CN_TaxInputInvoiceByKeyFluentHelper getCN_TaxInputInvoiceByKey(UUID cN_TaxInvcUUID)
```
    Description copied from interface: IncomingVATInvoiceChinaService
    
    Fetch a single CN_TaxInputInvoice entity using key fields.
    
    Specified by:
    
    getCN_TaxInputInvoiceByKey in interface IncomingVATInvoiceChinaService
    
    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
public CN_TaxInputInvoiceCreateFluentHelper createCN_TaxInputInvoice(@Nonnull
                                                                              CN_TaxInputInvoice cN_TaxInputInvoice)
```
    Description copied from interface: IncomingVATInvoiceChinaService
    
    Create a new CN_TaxInputInvoice entity and save it to the S/4HANA system.
    
    Specified by:
    
    createCN_TaxInputInvoice in interface IncomingVATInvoiceChinaService
    
    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
public CN_TaxInputInvoiceItemFluentHelper getAllCN_TaxInputInvoiceItem()
```
    Description copied from interface: IncomingVATInvoiceChinaService
    
    Fetch multiple CN_TaxInputInvoiceItem entities.
    
    Specified by:
    
    getAllCN_TaxInputInvoiceItem in interface IncomingVATInvoiceChinaService
    
    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
public CN_TaxInputInvoiceItemByKeyFluentHelper getCN_TaxInputInvoiceItemByKey(UUID taxInvoiceItemUUID,
                                                                                       UUID cN_TaxInvcUUID)
```
    Description copied from interface: IncomingVATInvoiceChinaService
    
    Fetch a single CN_TaxInputInvoiceItem entity using key fields.
    
    Specified by:
    
    getCN_TaxInputInvoiceItemByKey in interface IncomingVATInvoiceChinaService
    
    Parameters:
    
    taxInvoiceItemUUID - Invoice Item UUID
    Constraints: Not nullable
    
    cN_TaxInvcUUID - China Tax Invoice 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
public CN_TaxInputInvoiceItemCreateFluentHelper createCN_TaxInputInvoiceItem(@Nonnull
                                                                                      CN_TaxInputInvoiceItem cN_TaxInputInvoiceItem)
```
    Description copied from interface: IncomingVATInvoiceChinaService
    
    Create a new CN_TaxInputInvoiceItem entity and save it to the S/4HANA system.
    
    Specified by:
    
    createCN_TaxInputInvoiceItem in interface IncomingVATInvoiceChinaService
    
    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
public CN_TaxInvoiceBindingRecordFluentHelper getAllCN_TaxInvoiceBindingRecord()
```
    Description copied from interface: IncomingVATInvoiceChinaService
    
    Fetch multiple CN_TaxInvoiceBindingRecord entities.
    
    Specified by:
    
    getAllCN_TaxInvoiceBindingRecord in interface IncomingVATInvoiceChinaService
    
    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
public CN_TaxInvoiceBindingRecordByKeyFluentHelper getCN_TaxInvoiceBindingRecordByKey(UUID cN_TaxInvcBindgUUID,
                                                                                               UUID cN_TaxInvcBindgItmUUID)
```
    Description copied from interface: IncomingVATInvoiceChinaService
    
    Fetch a single CN_TaxInvoiceBindingRecord entity using key fields.
    
    Specified by:
    
    getCN_TaxInvoiceBindingRecordByKey in interface IncomingVATInvoiceChinaService
    
    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
public CN_TaxInvoiceBindingRecordCreateFluentHelper createCN_TaxInvoiceBindingRecord(@Nonnull
                                                                                              CN_TaxInvoiceBindingRecord cN_TaxInvoiceBindingRecord)
```
    Description copied from interface: IncomingVATInvoiceChinaService
    
    Create a new CN_TaxInvoiceBindingRecord entity and save it to the S/4HANA system.
    
    Specified by:
    
    createCN_TaxInvoiceBindingRecord in interface IncomingVATInvoiceChinaService
    
    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
public ReceiveInvoiceFluentHelper receiveInvoice(@Nonnull
                                                          UUID cN_TaxInvcUUID)
```
    Description copied from interface: IncomingVATInvoiceChinaService
    
    Creates a fluent helper for the receiveInvoice OData function import.
    
    Specified by:
    
    receiveInvoice in interface IncomingVATInvoiceChinaService
    
    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
public SignoffInvoiceFluentHelper signoffInvoice(@Nonnull
                                                          UUID cN_TaxInvcUUID)
```
    Description copied from interface: IncomingVATInvoiceChinaService
    
    Creates a fluent helper for the signoffInvoice OData function import.
    
    Specified by:
    
    signoffInvoice in interface IncomingVATInvoiceChinaService
    
    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
public DeclareInvoiceFluentHelper declareInvoice(@Nonnull
                                                          UUID cN_TaxInvcUUID,
                                                          @Nonnull
                                                          String declnMonth,
                                                          @Nonnull
                                                          String declnYear)
```
    Description copied from interface: IncomingVATInvoiceChinaService
    
    Creates a fluent helper for the declareInvoice OData function import.
    
    Specified by:
    
    declareInvoice in interface IncomingVATInvoiceChinaService
    
    Parameters:
    
    cN_TaxInvcUUID - UUID
    
    Constraints: none
    
    Original parameter name from the Odata EDM: CN_TaxInvcUUID
    
    declnMonth - Constraints: Not nullable, Maximum length: 2
    Original parameter name from the Odata EDM: DeclnMonth
    
    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.

Class DefaultIncomingVATInvoiceChinaService

Details:

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.IncomingVATInvoiceChinaService

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultIncomingVATInvoiceChinaService

Method Detail

withServicePath

batch

getAllCN_TaxInputInvoice

getCN_TaxInputInvoiceByKey

createCN_TaxInputInvoice

getAllCN_TaxInputInvoiceItem

getCN_TaxInputInvoiceItemByKey

createCN_TaxInputInvoiceItem

getAllCN_TaxInvoiceBindingRecord

getCN_TaxInvoiceBindingRecordByKey

createCN_TaxInvoiceBindingRecord

receiveInvoice

signoffInvoice

declareInvoice