vdm/sales-doc-with-credit-block-service | SAP Cloud SDK for JavaScript / TypeScript

Index

Namespaces

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

ReadSalesDocWithCreditBlockServiceRequestBuilder

ReadSalesDocWithCreditBlockServiceRequestBuilder: GetAllRequestBuilderV2<CreditBlockedSalesDocument> | GetAllRequestBuilderV2<SalesDocumentRjcnReason> | GetByKeyRequestBuilderV2<CreditBlockedSalesDocument> | GetByKeyRequestBuilderV2<SalesDocumentRjcnReason>

WriteSalesDocWithCreditBlockServiceRequestBuilder

WriteSalesDocWithCreditBlockServiceRequestBuilder: CreateRequestBuilderV2<CreditBlockedSalesDocument> | UpdateRequestBuilderV2<CreditBlockedSalesDocument> | DeleteRequestBuilderV2<CreditBlockedSalesDocument> | CreateRequestBuilderV2<SalesDocumentRjcnReason> | UpdateRequestBuilderV2<SalesDocumentRjcnReason> | DeleteRequestBuilderV2<SalesDocumentRjcnReason>

Variables

Const defaultSalesDocWithCreditBlockServicePath

defaultSalesDocWithCreditBlockServicePath: "/sap/opu/odata/sap/API_SLS_DOC_WITH_CREDIT_BLOCK" = '/sap/opu/odata/sap/API_SLS_DOC_WITH_CREDIT_BLOCK'

Const functionImports

functionImports: { checkCreditBlock: (parameters: CheckCreditBlockParameters) => FunctionImportRequestBuilderV2<CheckCreditBlockParameters, ReturnMessage>; rejectCreditBlock: (parameters: RejectCreditBlockParameters) => FunctionImportRequestBuilderV2<RejectCreditBlockParameters, ReturnMessage>; releaseCreditBlock: (parameters: ReleaseCreditBlockParameters) => FunctionImportRequestBuilderV2<ReleaseCreditBlockParameters, ReturnMessage> } = ...

Type declaration

checkCreditBlock: (parameters: CheckCreditBlockParameters) => FunctionImportRequestBuilderV2<CheckCreditBlockParameters, ReturnMessage>
- - (parameters: CheckCreditBlockParameters): FunctionImportRequestBuilderV2<CheckCreditBlockParameters, ReturnMessage>
  - Checks the credit status of a specific sales document.
    
    Parameters
    - parameters: CheckCreditBlockParameters
      
      Object containing all parameters for the function import.
    Returns FunctionImportRequestBuilderV2<CheckCreditBlockParameters, ReturnMessage>
    
    A request builder that allows to overwrite some of the values and execute the resulting request.
rejectCreditBlock: (parameters: RejectCreditBlockParameters) => FunctionImportRequestBuilderV2<RejectCreditBlockParameters, ReturnMessage>
- - (parameters: RejectCreditBlockParameters): FunctionImportRequestBuilderV2<RejectCreditBlockParameters, ReturnMessage>
  - Rejects a specific credit blocked sales document.
    
    Parameters
    - parameters: RejectCreditBlockParameters
      
      Object containing all parameters for the function import.
    Returns FunctionImportRequestBuilderV2<RejectCreditBlockParameters, ReturnMessage>
    
    A request builder that allows to overwrite some of the values and execute the resulting request.
releaseCreditBlock: (parameters: ReleaseCreditBlockParameters) => FunctionImportRequestBuilderV2<ReleaseCreditBlockParameters, ReturnMessage>
- - (parameters: ReleaseCreditBlockParameters): FunctionImportRequestBuilderV2<ReleaseCreditBlockParameters, ReturnMessage>
  - Releases a specific sales document from the credit block.
    
    Parameters
    - parameters: ReleaseCreditBlockParameters
      
      Object containing all parameters for the function import.
    Returns FunctionImportRequestBuilderV2<ReleaseCreditBlockParameters, ReturnMessage>
    
    A request builder that allows to overwrite some of the values and execute the resulting request.

Functions

batch

batch(...requests: (ReadSalesDocWithCreditBlockServiceRequestBuilder | ODataBatchChangeSetV2<WriteSalesDocWithCreditBlockServiceRequestBuilder>)[]): ODataBatchRequestBuilderV2
batch(requests: (ReadSalesDocWithCreditBlockServiceRequestBuilder | ODataBatchChangeSetV2<WriteSalesDocWithCreditBlockServiceRequestBuilder>)[]): ODataBatchRequestBuilderV2

- Defined in packages/vdm/sales-doc-with-credit-block-service/BatchRequest.ts:15
Batch builder for operations supported on the Sales Doc With Credit Block Service.

Parameters
- Rest ...requests: (ReadSalesDocWithCreditBlockServiceRequestBuilder | ODataBatchChangeSetV2<WriteSalesDocWithCreditBlockServiceRequestBuilder>)[]
  
  The requests of the batch
Returns ODataBatchRequestBuilderV2

A request builder for batch.
- Defined in packages/vdm/sales-doc-with-credit-block-service/BatchRequest.ts:16
Parameters
- requests: (ReadSalesDocWithCreditBlockServiceRequestBuilder | ODataBatchChangeSetV2<WriteSalesDocWithCreditBlockServiceRequestBuilder>)[]
Returns ODataBatchRequestBuilderV2

changeset

changeset(...requests: WriteSalesDocWithCreditBlockServiceRequestBuilder[]): ODataBatchChangeSetV2<WriteSalesDocWithCreditBlockServiceRequestBuilder>
changeset(requests: WriteSalesDocWithCreditBlockServiceRequestBuilder[]): ODataBatchChangeSetV2<WriteSalesDocWithCreditBlockServiceRequestBuilder>

- Defined in packages/vdm/sales-doc-with-credit-block-service/BatchRequest.ts:26
Change set constructor consists of write operations supported on the Sales Doc With Credit Block Service.

Parameters
- Rest ...requests: WriteSalesDocWithCreditBlockServiceRequestBuilder[]
  
  The requests of the change set
Returns ODataBatchChangeSetV2<WriteSalesDocWithCreditBlockServiceRequestBuilder>

A change set for batch.
- Defined in packages/vdm/sales-doc-with-credit-block-service/BatchRequest.ts:27
Parameters
- requests: WriteSalesDocWithCreditBlockServiceRequestBuilder[]
Returns ODataBatchChangeSetV2<WriteSalesDocWithCreditBlockServiceRequestBuilder>

checkCreditBlock

checkCreditBlock(parameters: CheckCreditBlockParameters): FunctionImportRequestBuilderV2<CheckCreditBlockParameters, ReturnMessage>

- Defined in packages/vdm/sales-doc-with-credit-block-service/function-imports.ts:29
Checks the credit status of a specific sales document.

Parameters
- parameters: CheckCreditBlockParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilderV2<CheckCreditBlockParameters, ReturnMessage>

A request builder that allows to overwrite some of the values and execute the resulting request.

createReturnMessage

createReturnMessage(json: any): ReturnMessage

- Defined in packages/vdm/sales-doc-with-credit-block-service/ReturnMessage.ts:25
deprecated

Since v1.6.0. Use ReturnMessage.build instead.

Parameters
- json: any
Returns ReturnMessage

rejectCreditBlock

rejectCreditBlock(parameters: RejectCreditBlockParameters): FunctionImportRequestBuilderV2<RejectCreditBlockParameters, ReturnMessage>

- Defined in packages/vdm/sales-doc-with-credit-block-service/function-imports.ts:62
Rejects a specific credit blocked sales document.

Parameters
- parameters: RejectCreditBlockParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilderV2<RejectCreditBlockParameters, ReturnMessage>

A request builder that allows to overwrite some of the values and execute the resulting request.

releaseCreditBlock

releaseCreditBlock(parameters: ReleaseCreditBlockParameters): FunctionImportRequestBuilderV2<ReleaseCreditBlockParameters, ReturnMessage>

- Defined in packages/vdm/sales-doc-with-credit-block-service/function-imports.ts:92
Releases a specific sales document from the credit block.

Parameters
- parameters: ReleaseCreditBlockParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilderV2<ReleaseCreditBlockParameters, ReturnMessage>

A request builder that allows to overwrite some of the values and execute the resulting request.

Index

Namespaces

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

ReadSalesDocWithCreditBlockServiceRequestBuilder

WriteSalesDocWithCreditBlockServiceRequestBuilder

Variables

Const defaultSalesDocWithCreditBlockServicePath

Const functionImports

Type declaration

checkCreditBlock: (parameters: CheckCreditBlockParameters) => FunctionImportRequestBuilderV2<CheckCreditBlockParameters, ReturnMessage>

Parameters

parameters: CheckCreditBlockParameters

Returns FunctionImportRequestBuilderV2<CheckCreditBlockParameters, ReturnMessage>

rejectCreditBlock: (parameters: RejectCreditBlockParameters) => FunctionImportRequestBuilderV2<RejectCreditBlockParameters, ReturnMessage>

Parameters

parameters: RejectCreditBlockParameters

Returns FunctionImportRequestBuilderV2<RejectCreditBlockParameters, ReturnMessage>

releaseCreditBlock: (parameters: ReleaseCreditBlockParameters) => FunctionImportRequestBuilderV2<ReleaseCreditBlockParameters, ReturnMessage>

Parameters

parameters: ReleaseCreditBlockParameters

Returns FunctionImportRequestBuilderV2<ReleaseCreditBlockParameters, ReturnMessage>

Functions

batch

Parameters

Rest ...requests: (ReadSalesDocWithCreditBlockServiceRequestBuilder | ODataBatchChangeSetV2<WriteSalesDocWithCreditBlockServiceRequestBuilder>)[]

Returns ODataBatchRequestBuilderV2

Parameters

requests: (ReadSalesDocWithCreditBlockServiceRequestBuilder | ODataBatchChangeSetV2<WriteSalesDocWithCreditBlockServiceRequestBuilder>)[]

Returns ODataBatchRequestBuilderV2

changeset

Parameters

Rest ...requests: WriteSalesDocWithCreditBlockServiceRequestBuilder[]

Returns ODataBatchChangeSetV2<WriteSalesDocWithCreditBlockServiceRequestBuilder>

Parameters

requests: WriteSalesDocWithCreditBlockServiceRequestBuilder[]

Returns ODataBatchChangeSetV2<WriteSalesDocWithCreditBlockServiceRequestBuilder>

checkCreditBlock

Parameters

parameters: CheckCreditBlockParameters

Returns FunctionImportRequestBuilderV2<CheckCreditBlockParameters, ReturnMessage>

createReturnMessage

Parameters

json: any

Returns ReturnMessage

rejectCreditBlock

Parameters

parameters: RejectCreditBlockParameters

Returns FunctionImportRequestBuilderV2<RejectCreditBlockParameters, ReturnMessage>

releaseCreditBlock

Parameters

parameters: ReleaseCreditBlockParameters

Returns FunctionImportRequestBuilderV2<ReleaseCreditBlockParameters, ReturnMessage>