Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_CreditBlockedDeliveryDoc" of service "API_DEL_DOC_WITH_CREDIT_BLOCK". This service is part of the following communication scenarios: Sales Credit Management Integration (SAP_COM_0325). See https://api.sap.com/api/API_DEL_DOC_WITH_CREDIT_BLOCK for more information.

Hierarchy

  • Entity
    • CreditBlockedDeliveryDoc

Implements

Index

Constructors

constructor

Properties

Protected _customFields

_customFields: MapType<any>

A mapper representing custom fields in an entity. Custom fields are represented by their field names and the corresponding values. A custom field can be added or updated using setCustomField method.

Protected _versionIdentifier

_versionIdentifier: string

The current ETag version of the entity in the remote system. The ETag identified the version of the in the remote system. It will be automatically set in the "if-match" header of update requests and can be set as a custom header for delete requests. When no ETag is provided by the remote system the value of this variable defaults to "*".

Optional centralCreditCheckStatus

centralCreditCheckStatus: undefined | string

Status of Credit Check SAP Credit Management. Maximum length: 1.

nullable

Optional centralCreditChkTechErrSts

centralCreditChkTechErrSts: undefined | string

Status of Technical Error SAP Credit Management. The technical error status of the sales document for SAP Credit Management. The technical error status of the sales document indicates whether the sales order was blocked due to a technical error during the sales document creation or changing. Maximum length: 1.

nullable

Optional controllingAreaCurrency

controllingAreaCurrency: undefined | string

Currency key of credit control area. Identifies the currency of the amounts that are being transacted. The currency is the currency of the credit control area. Maximum length: 5.

nullable

Optional createdByUser

createdByUser: undefined | string

Name of Person Who Created Object. Maximum length: 12.

nullable

Optional creationDate

creationDate: Moment

Date on Which Record Was Created.

nullable

Optional creditBlockReleaseDate

creditBlockReleaseDate: Moment

Release date of the document determined by credit management. Specifies the date on which the sales order or delivery was released after being blocked for credit reasons.

nullable

Optional customerCreditAccount

customerCreditAccount: undefined | string

Customer's Account Number with Credit Limit Reference. Customer account that the system uses to monitor the credit limit. You need this field if you want to assign the credit limit for a group of customers, instead of one customer. In this case you assign the credit limit to one of the customers in the group. All other customers in the group use this field to link to reference to this customer. Maximum length: 10.

nullable

deliveryDocument

deliveryDocument: string

Delivery. The number that uniquely identifies the delivery. Maximum length: 10.

Optional finDocCreditCheckStatus

finDocCreditCheckStatus: undefined | string

Status of Credit Check Against Financial Document. Maximum length: 1.

nullable

Optional lastChangeDate

lastChangeDate: Moment

Date of Last Change.

nullable

Optional lastChangedByUser

lastChangedByUser: undefined | string

Name of Person who Changed Object. Maximum length: 12.

nullable

Optional nextShippingDate

nextShippingDate: Moment

Next date. In the sales order header, this field specifies the next planned delivery date. In the delivery header, the field specifies the next planned picking or goods issue date.Using these dates in the headers of sales documents and deliveries, the system is able to recognize those documents for which processing time is critical.

nullable

Optional overallGoodsMovementStatus

overallGoodsMovementStatus: undefined | string

Goods Movement Status (All Items). Indicates if, and to what extent, the delivery has left your premises. The status tells you whether the delivery has already left your warehouse, is still being processed, or whether processing has not yet begun. Maximum length: 1.

nullable

Optional overallSdProcessStatus

overallSdProcessStatus: undefined | string

Overall Processing Status (Header/All Items). The processing status of the entire sales document. The system determines the status of the entire sales document by taking into account the status of all header-related information and the status of all individual items. The status message tells you whether processing of the sales document is open, in progress, or complete. Maximum length: 1.

nullable

Optional releasedCreditAmount

releasedCreditAmount: BigNumber

Released credit value of the document. Specifies the credit value of a sales order or a delivery at the time of release. order: the basis for calculating this value is the cumulated confirmed quantityIf changes are made to the document after release, the system uses the released credit value to determine whether the document requires a further credit check.

nullable

Protected remoteState

remoteState: object

The remote state of the entity. Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. It is stored as map, where the keys are stored in the format of VDM properties.

Type declaration

  • [keys: string]: any

Optional salesOffice

salesOffice: undefined | string

Sales Office. A physical location (for example, a branch office) that has responsibility for the sale of certain products or services within a given geographical area. When you create sales statistics, you can use a sales office as one of the selection criteria. When you print out order confirmations, you can include the address of the sales office.You can assign each customer to a sales office in the customer master record.Within a sales office you can establish sales groups (for example, departments) with specific sales responsibilities. Each person who works in the sales office can be assigned to a sales group in his or her user master record. Each customer can also be assigned to a particular sales group in the customer master record. Maximum length: 4.

nullable

Optional salesOrganization

salesOrganization: undefined | string

Sales Organization. An organizational unit responsible for the sale of certain products or services. The responsibility of a sales organization may include legal liability for products and customer claims. You can assign any number of distribution channels and divisions to a sales organization. A particular combination of sales organization, distribution channel, and division is known as a sales area. Maximum length: 4.

nullable

Optional sdDocumentCategory

sdDocumentCategory: undefined | string

SD Document Category. A classification for the different types of documents that you can process, for example, quotations, sales orders, deliveries, and invoices. The document category determines how the system stores and keeps track of document data. It enables the system to provide you with status information about delivery processing, billing, and documents that are used for reference (for example, inquiries and quotations). Maximum length: 4.

nullable

Optional shippingPoint

shippingPoint: undefined | string

Shipping Point / Receiving Point. The physical location (for example, a warehouse or collection of loading ramps) from which you ship the item. You can predefine shipping/receiving points in the system, based on different combinations ofPlantsShipping conditionsLoading groupsDuring delivery processing, the shipping/receiving point is the most important criterion that you use to select deliveries.A delivery can be shipped from only one shipping point or received at only one receiving point.If you want to provide more detailed information about a shipping point you can specify a loading point (for example, one of a number of different loading ramps).If, for example, you want to ship refrigerated goods to a certain customer by rail, the system proposes a shipping point with a suitable location and equipment for loading refrigerated goods onto rail cars.The system can propose a shipping/receiving point. If valid alternatives are predefined in your system, you can change the shipping/receiving point manually. Maximum length: 4.

nullable

Optional soldToParty

soldToParty: undefined | string

Sold-To Party. The customer who orders the goods or services. The sold-to party is contractually responsible for sales orders. Maximum length: 10.

nullable

Optional totalCreditCheckStatus

totalCreditCheckStatus: undefined | string

Overall Status of Credit Checks. Maximum length: 1.

nullable

Static ALL_FIELDS

ALL_FIELDS: AllFields<CreditBlockedDeliveryDoc> = new AllFields('*', CreditBlockedDeliveryDoc)

All fields selector.

Static CENTRAL_CREDIT_CHECK_STATUS

CENTRAL_CREDIT_CHECK_STATUS: StringField<CreditBlockedDeliveryDoc> = new StringField('CentralCreditCheckStatus', CreditBlockedDeliveryDoc, 'Edm.String')

Static representation of the centralCreditCheckStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CENTRAL_CREDIT_CHK_TECH_ERR_STS

CENTRAL_CREDIT_CHK_TECH_ERR_STS: StringField<CreditBlockedDeliveryDoc> = new StringField('CentralCreditChkTechErrSts', CreditBlockedDeliveryDoc, 'Edm.String')

Static representation of the centralCreditChkTechErrSts property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CONTROLLING_AREA_CURRENCY

CONTROLLING_AREA_CURRENCY: StringField<CreditBlockedDeliveryDoc> = new StringField('ControllingAreaCurrency', CreditBlockedDeliveryDoc, 'Edm.String')

Static representation of the controllingAreaCurrency property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CREATED_BY_USER

CREATED_BY_USER: StringField<CreditBlockedDeliveryDoc> = new StringField('CreatedByUser', CreditBlockedDeliveryDoc, 'Edm.String')

Static representation of the createdByUser property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CREATION_DATE

CREATION_DATE: DateField<CreditBlockedDeliveryDoc> = new DateField('CreationDate', CreditBlockedDeliveryDoc, 'Edm.DateTime')

Static representation of the creationDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CREDIT_BLOCK_RELEASE_DATE

CREDIT_BLOCK_RELEASE_DATE: DateField<CreditBlockedDeliveryDoc> = new DateField('CreditBlockReleaseDate', CreditBlockedDeliveryDoc, 'Edm.DateTime')

Static representation of the creditBlockReleaseDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CUSTOMER_CREDIT_ACCOUNT

CUSTOMER_CREDIT_ACCOUNT: StringField<CreditBlockedDeliveryDoc> = new StringField('CustomerCreditAccount', CreditBlockedDeliveryDoc, 'Edm.String')

Static representation of the customerCreditAccount property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static DELIVERY_DOCUMENT

DELIVERY_DOCUMENT: StringField<CreditBlockedDeliveryDoc> = new StringField('DeliveryDocument', CreditBlockedDeliveryDoc, 'Edm.String')

Static representation of the deliveryDocument property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static FIN_DOC_CREDIT_CHECK_STATUS

FIN_DOC_CREDIT_CHECK_STATUS: StringField<CreditBlockedDeliveryDoc> = new StringField('FinDocCreditCheckStatus', CreditBlockedDeliveryDoc, 'Edm.String')

Static representation of the finDocCreditCheckStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static LAST_CHANGED_BY_USER

LAST_CHANGED_BY_USER: StringField<CreditBlockedDeliveryDoc> = new StringField('LastChangedByUser', CreditBlockedDeliveryDoc, 'Edm.String')

Static representation of the lastChangedByUser property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static LAST_CHANGE_DATE

LAST_CHANGE_DATE: DateField<CreditBlockedDeliveryDoc> = new DateField('LastChangeDate', CreditBlockedDeliveryDoc, 'Edm.DateTime')

Static representation of the lastChangeDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static NEXT_SHIPPING_DATE

NEXT_SHIPPING_DATE: DateField<CreditBlockedDeliveryDoc> = new DateField('NextShippingDate', CreditBlockedDeliveryDoc, 'Edm.DateTime')

Static representation of the nextShippingDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static OVERALL_GOODS_MOVEMENT_STATUS

OVERALL_GOODS_MOVEMENT_STATUS: StringField<CreditBlockedDeliveryDoc> = new StringField('OverallGoodsMovementStatus', CreditBlockedDeliveryDoc, 'Edm.String')

Static representation of the overallGoodsMovementStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static OVERALL_SD_PROCESS_STATUS

OVERALL_SD_PROCESS_STATUS: StringField<CreditBlockedDeliveryDoc> = new StringField('OverallSDProcessStatus', CreditBlockedDeliveryDoc, 'Edm.String')

Static representation of the overallSdProcessStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static RELEASED_CREDIT_AMOUNT

RELEASED_CREDIT_AMOUNT: BigNumberField<CreditBlockedDeliveryDoc> = new BigNumberField('ReleasedCreditAmount', CreditBlockedDeliveryDoc, 'Edm.Decimal')

Static representation of the releasedCreditAmount property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SALES_OFFICE

SALES_OFFICE: StringField<CreditBlockedDeliveryDoc> = new StringField('SalesOffice', CreditBlockedDeliveryDoc, 'Edm.String')

Static representation of the salesOffice property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SALES_ORGANIZATION

SALES_ORGANIZATION: StringField<CreditBlockedDeliveryDoc> = new StringField('SalesOrganization', CreditBlockedDeliveryDoc, 'Edm.String')

Static representation of the salesOrganization property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SD_DOCUMENT_CATEGORY

SD_DOCUMENT_CATEGORY: StringField<CreditBlockedDeliveryDoc> = new StringField('SDDocumentCategory', CreditBlockedDeliveryDoc, 'Edm.String')

Static representation of the sdDocumentCategory property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SHIPPING_POINT

SHIPPING_POINT: StringField<CreditBlockedDeliveryDoc> = new StringField('ShippingPoint', CreditBlockedDeliveryDoc, 'Edm.String')

Static representation of the shippingPoint property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SOLD_TO_PARTY

SOLD_TO_PARTY: StringField<CreditBlockedDeliveryDoc> = new StringField('SoldToParty', CreditBlockedDeliveryDoc, 'Edm.String')

Static representation of the soldToParty property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TOTAL_CREDIT_CHECK_STATUS

TOTAL_CREDIT_CHECK_STATUS: StringField<CreditBlockedDeliveryDoc> = new StringField('TotalCreditCheckStatus', CreditBlockedDeliveryDoc, 'Edm.String')

Static representation of the totalCreditCheckStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static _allFields

_allFields: Array<StringField<CreditBlockedDeliveryDoc> | DateField<CreditBlockedDeliveryDoc> | BigNumberField<CreditBlockedDeliveryDoc>> = [CreditBlockedDeliveryDoc.DELIVERY_DOCUMENT,CreditBlockedDeliveryDoc.SD_DOCUMENT_CATEGORY,CreditBlockedDeliveryDoc.SALES_ORGANIZATION,CreditBlockedDeliveryDoc.SALES_OFFICE,CreditBlockedDeliveryDoc.SHIPPING_POINT,CreditBlockedDeliveryDoc.CREATION_DATE,CreditBlockedDeliveryDoc.CREATED_BY_USER,CreditBlockedDeliveryDoc.LAST_CHANGED_BY_USER,CreditBlockedDeliveryDoc.LAST_CHANGE_DATE,CreditBlockedDeliveryDoc.SOLD_TO_PARTY,CreditBlockedDeliveryDoc.CUSTOMER_CREDIT_ACCOUNT,CreditBlockedDeliveryDoc.CONTROLLING_AREA_CURRENCY,CreditBlockedDeliveryDoc.RELEASED_CREDIT_AMOUNT,CreditBlockedDeliveryDoc.CREDIT_BLOCK_RELEASE_DATE,CreditBlockedDeliveryDoc.NEXT_SHIPPING_DATE,CreditBlockedDeliveryDoc.CENTRAL_CREDIT_CHK_TECH_ERR_STS,CreditBlockedDeliveryDoc.OVERALL_SD_PROCESS_STATUS,CreditBlockedDeliveryDoc.OVERALL_GOODS_MOVEMENT_STATUS,CreditBlockedDeliveryDoc.TOTAL_CREDIT_CHECK_STATUS,CreditBlockedDeliveryDoc.FIN_DOC_CREDIT_CHECK_STATUS,CreditBlockedDeliveryDoc.CENTRAL_CREDIT_CHECK_STATUS]

All fields of the CreditBlockedDeliveryDoc entity.

Static _defaultServicePath

_defaultServicePath: string = "/sap/opu/odata/sap/API_DEL_DOC_WITH_CREDIT_BLOCK"

Default url path for the according service.

Static _entityName

_entityName: string = "A_CreditBlockedDeliveryDoc"

Technical entity name for CreditBlockedDeliveryDoc.

Static _keyFields

_keyFields: Array<Selectable<CreditBlockedDeliveryDoc>> = [CreditBlockedDeliveryDoc.DELIVERY_DOCUMENT]

All key fields of the CreditBlockedDeliveryDoc entity.

Static _keys

_keys: object = CreditBlockedDeliveryDoc._keyFields.reduce((acc: { [keys: string]: Selectable<CreditBlockedDeliveryDoc> }, field: Selectable<CreditBlockedDeliveryDoc>) => {acc[field._fieldName] = field;return acc;}, {})

Mapping of all key field names to the respective static field property CreditBlockedDeliveryDoc.

Type declaration

Static _serviceName

_serviceName: string = "API_DEL_DOC_WITH_CREDIT_BLOCK"
deprecated

Since v1.0.1 Use _defaultServicePath instead. Technical service name for CreditBlockedDeliveryDoc.

Accessors

versionIdentifier

  • get versionIdentifier(): string
  • ETag version identifier accessor.

    Returns string

    The ETag version identifier of the retrieved entity, returns undefined if not retrieved

Methods

Protected getCurrentMapKeys

  • getCurrentMapKeys(): Entity
  • Returns a map of all defined fields in entity to their current values.

    Returns Entity

    Entity with all defined entity fields

getCustomField

  • getCustomField(fieldName: string): any
  • Custom field value getter.

    Parameters

    • fieldName: string

      The name of the custom field

    Returns any

    The value of the corresponding custom field

getCustomFields

  • getCustomFields(): MapType<any>
  • Returns a map that contains all entity custom fields.

    Returns MapType<any>

    A map of all defined custom fields in the entity

getUpdatedCustomFields

  • getUpdatedCustomFields(): MapType<any>
  • Returns all updated custom field properties compared to the last known remote state.

    Returns MapType<any>

    A map containing all updated custom properties, with their new values

getUpdatedProperties

  • getUpdatedProperties(): Entity
  • Returns all changed properties compared to the last known remote state. The returned properties does not include custom fields. Use getUpdatedCustomFields, if updated custom fields are needed.

    Returns Entity

    Entity with all properties that changed

hasCustomField

  • hasCustomField(fieldName: string): boolean
  • Validates whether a custom field exists in the entity.

    Parameters

    • fieldName: string

      The name of the custom field to update

    Returns boolean

    A boolean value, that indicates whether a custom field is defined in entity

initializeCustomFields

  • initializeCustomFields(customFields: MapType<any>): this
  • Sets all retrieved custom fields in entity.

    Parameters

    • customFields: MapType<any>

      Extracted custom fields from a retrieved entity

    Returns this

    A boolean value, that indicates the existence of the field in entity

Protected isConflictingCustomField

  • isConflictingCustomField(customFieldName: string): boolean
  • Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.

    Parameters

    • customFieldName: string

      Field name to check

    Returns boolean

    Boolean value that describes whether a field name can be defined as custom field

setCustomField

  • setCustomField(fieldName: string, value: any): this
  • Sets a new custom field in the entity or updates it. Throws an error, if the provided custom field name is already defined by an original field in entity.

    Parameters

    • fieldName: string

      The name of the custom field to update

    • value: any

      The value of the field

    Returns this

    The entity itself, to facilitate method chaining

setOrInitializeRemoteState

  • setOrInitializeRemoteState(state?: MapType<any>): this
  • Initializes or sets the remoteState of the entity. This function is called on all read, create and update requests. This function should be called after initializeCustomFields, if custom fields are defined.

    deprecated

    Since 1.12.0. Will be removed in version 2.0.

    Parameters

    • Optional state: MapType<any>

      State to be set as remote state

    Returns this

    The entity itself, to facilitate method chaining

setVersionIdentifier

  • setVersionIdentifier(etag: string | undefined): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string | undefined

      The returned ETag version of the entity

    Returns this

    The entity itself, to facilitate method chaining

toJSON

  • toJSON(): object
  • Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.

    Returns object

    An object containing all instance variables + custom fields.

    • [key: string]: any

Static builder

Static customField

  • Returns a selectable object that allows the selection of custom field in a get request for the entity CreditBlockedDeliveryDoc.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<CreditBlockedDeliveryDoc>

    A builder that constructs instances of entity type CreditBlockedDeliveryDoc.

Static Protected customFieldSelector

  • customFieldSelector<EntityT>(fieldName: string, entityConstructor: Constructable<EntityT>): CustomField<EntityT>
  • Type parameters

    • EntityT: Entity

    Parameters

    • fieldName: string
    • entityConstructor: Constructable<EntityT>

    Returns CustomField<EntityT>

Static Protected entityBuilder

  • entityBuilder<EntityT, EntityTypeForceMandatoryT>(entityConstructor: Constructable<EntityT, EntityTypeForceMandatoryT>): EntityBuilderType<EntityT, EntityTypeForceMandatoryT>
  • Type parameters

    • EntityT: Entity

    • EntityTypeForceMandatoryT

    Parameters

    • entityConstructor: Constructable<EntityT, EntityTypeForceMandatoryT>

    Returns EntityBuilderType<EntityT, EntityTypeForceMandatoryT>

Static requestBuilder

  • Returns a request builder to construct requests for operations on the CreditBlockedDeliveryDoc entity type.

    Returns CreditBlockedDeliveryDocRequestBuilder

    A CreditBlockedDeliveryDoc request builder.