Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_CreditBlockedSalesDocument" of service "API_SLS_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_SLS_DOC_WITH_CREDIT_BLOCK for more information.

Hierarchy

  • any
    • CreditBlockedSalesDocument

Implements

Index

Properties

centralCreditCheckStatus

centralCreditCheckStatus: string

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

nullable

centralCreditChkTechErrSts

centralCreditChkTechErrSts: 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

controllingAreaCurrency

controllingAreaCurrency: 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

createdByUser

createdByUser: string

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

nullable

creationDate

creationDate: Moment

Date on Which Record Was Created.

nullable

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

customerCreditAccount

customerCreditAccount: 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

distributionChannel

distributionChannel: string

Distribution Channel. The way in which products or services reach the customer. Typical examples of distribution channels are wholesale, retail, or direct sales. You can maintain information about customers and materials by sales organization and distribution channel. Within a sales organization you can deliver goods to a given customer through more than one distribution channel.You can assign a distribution channel to one or more sales organizations. If, for example, you have numerous sales organizations, each sales organization may use the "Wholesale" distribution channel.For each combination of sales organization and distribution channel, you can further assign one or more of the divisions that are defined for the sales organization. You can, for example, assign "Food" and "Non-food" divisions to the "Wholesale" distribution channel. A particular combination of sales organization, distribution channel, and division is known as a sales area. Maximum length: 2.

nullable

finDocCreditCheckStatus

finDocCreditCheckStatus: string

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

nullable

lastChangeDate

lastChangeDate: Moment

Date of Last Change.

nullable

lastChangedByUser

lastChangedByUser: string

User Who Last Changed the Business Document. Maximum length: 12.

nullable

nextCreditCheckDate

nextCreditCheckDate: Moment

Date of Next Credit Check of Document. Specifies the date of the next credit check required for the document. The system stores this date if, during a dynamic credit check, some items or schedule lines in the document lie outside the credit horizon.

nullable

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

organizationDivision

organizationDivision: string

Division. A way of grouping materials, products, or services. The system uses divisions to determine the sales areas and the business areas for a material, product, or service. A product or service is always assigned to just one division. From the point of view of sales and distribution, the use of divisions lets you organize your sales structure around groups of similar products or product lines. This allows the people in a division who process orders and service customers to specialize within a manageable area of expertise.If a sales organization sells food and non-food products through both retail and wholesaledistribution channels each distribution channel could then be further split into food and non-food divisions. Maximum length: 2.

nullable

overallSdProcessStatus

overallSdProcessStatus: string

Overall Processing Status of Document. 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

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

salesDocument

salesDocument: string

Sales Document. The number that uniquely identifies the sales document. Maximum length: 10.

salesDocumentType

salesDocumentType: string

Sales Document Type. A classification that distinguishes between different types of sales document. The sales document type determines how the system processes the sales document. For example, depending on the sales document type, the system determines which screens to present and which data to ask you for. Maximum length: 4.

nullable

salesGroup

salesGroup: string

Sales Group. A group of sales people who are responsible for processing sales of certain products or services. By using sales groups you can designate different areas of responsibility within a sales office. When you generate sales statistics, you can use the sales group as one of the selection criteria.If sales office personnel service both retail and wholesale markets, you can assign a sales group to each market.You assign each salesperson to a sales group in his or her user master record. You assign each customer to a particular sales group in the customer's master record. Maximum length: 3.

nullable

salesOffice

salesOffice: 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

salesOrganization

salesOrganization: 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

sdDocumentCategory

sdDocumentCategory: string

SD Document Category. A classification for the different types of documents that you can process in the sales and distribution system (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

soldToParty

soldToParty: 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

totalCreditCheckStatus

totalCreditCheckStatus: string

Overall Status of Credit Checks. Maximum length: 1.

nullable

totalNetAmount

totalNetAmount: BigNumber

Net Value of the Sales Order in Document Currency. The total value of all items in the sales document, after any discounts and surcharges are taken into account. The value is expressed in the document currency.

nullable

transactionCurrency

transactionCurrency: string

SD document currency. The currency that applies to the document (for example, to a sales order or an invoice). The system proposes the document currency from the customer master record of the sold-to party. You can change the currency manually in the document. If you change the currency, the system recalculates prices for the entire document. Maximum length: 5.

nullable

Static ALL_FIELDS

ALL_FIELDS: any = new AllFields('*', CreditBlockedSalesDocument)

All fields selector.

Static CENTRAL_CREDIT_CHECK_STATUS

CENTRAL_CREDIT_CHECK_STATUS: StringField<CreditBlockedSalesDocument> = new StringField('CentralCreditCheckStatus', CreditBlockedSalesDocument, '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<CreditBlockedSalesDocument> = new StringField('CentralCreditChkTechErrSts', CreditBlockedSalesDocument, '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<CreditBlockedSalesDocument> = new StringField('ControllingAreaCurrency', CreditBlockedSalesDocument, '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<CreditBlockedSalesDocument> = new StringField('CreatedByUser', CreditBlockedSalesDocument, '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<CreditBlockedSalesDocument> = new DateField('CreationDate', CreditBlockedSalesDocument, '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<CreditBlockedSalesDocument> = new DateField('CreditBlockReleaseDate', CreditBlockedSalesDocument, '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<CreditBlockedSalesDocument> = new StringField('CustomerCreditAccount', CreditBlockedSalesDocument, '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 DISTRIBUTION_CHANNEL

DISTRIBUTION_CHANNEL: StringField<CreditBlockedSalesDocument> = new StringField('DistributionChannel', CreditBlockedSalesDocument, 'Edm.String')

Static representation of the distributionChannel 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<CreditBlockedSalesDocument> = new StringField('FinDocCreditCheckStatus', CreditBlockedSalesDocument, '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<CreditBlockedSalesDocument> = new StringField('LastChangedByUser', CreditBlockedSalesDocument, '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<CreditBlockedSalesDocument> = new DateField('LastChangeDate', CreditBlockedSalesDocument, '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_CREDIT_CHECK_DATE

NEXT_CREDIT_CHECK_DATE: DateField<CreditBlockedSalesDocument> = new DateField('NextCreditCheckDate', CreditBlockedSalesDocument, 'Edm.DateTime')

Static representation of the nextCreditCheckDate 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<CreditBlockedSalesDocument> = new DateField('NextShippingDate', CreditBlockedSalesDocument, '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 ORGANIZATION_DIVISION

ORGANIZATION_DIVISION: StringField<CreditBlockedSalesDocument> = new StringField('OrganizationDivision', CreditBlockedSalesDocument, 'Edm.String')

Static representation of the organizationDivision 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<CreditBlockedSalesDocument> = new StringField('OverallSDProcessStatus', CreditBlockedSalesDocument, '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<CreditBlockedSalesDocument> = new BigNumberField('ReleasedCreditAmount', CreditBlockedSalesDocument, '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_DOCUMENT

SALES_DOCUMENT: StringField<CreditBlockedSalesDocument> = new StringField('SalesDocument', CreditBlockedSalesDocument, 'Edm.String')

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

Static SALES_DOCUMENT_TYPE

SALES_DOCUMENT_TYPE: StringField<CreditBlockedSalesDocument> = new StringField('SalesDocumentType', CreditBlockedSalesDocument, 'Edm.String')

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

Static SALES_GROUP

SALES_GROUP: StringField<CreditBlockedSalesDocument> = new StringField('SalesGroup', CreditBlockedSalesDocument, 'Edm.String')

Static representation of the salesGroup 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<CreditBlockedSalesDocument> = new StringField('SalesOffice', CreditBlockedSalesDocument, '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<CreditBlockedSalesDocument> = new StringField('SalesOrganization', CreditBlockedSalesDocument, '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<CreditBlockedSalesDocument> = new StringField('SDDocumentCategory', CreditBlockedSalesDocument, '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 SOLD_TO_PARTY

SOLD_TO_PARTY: StringField<CreditBlockedSalesDocument> = new StringField('SoldToParty', CreditBlockedSalesDocument, '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<CreditBlockedSalesDocument> = new StringField('TotalCreditCheckStatus', CreditBlockedSalesDocument, '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 TOTAL_NET_AMOUNT

TOTAL_NET_AMOUNT: BigNumberField<CreditBlockedSalesDocument> = new BigNumberField('TotalNetAmount', CreditBlockedSalesDocument, 'Edm.Decimal')

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

Static TRANSACTION_CURRENCY

TRANSACTION_CURRENCY: StringField<CreditBlockedSalesDocument> = new StringField('TransactionCurrency', CreditBlockedSalesDocument, 'Edm.String')

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

Static _allFields

_allFields: any[] = [CreditBlockedSalesDocument.SALES_DOCUMENT,CreditBlockedSalesDocument.SD_DOCUMENT_CATEGORY,CreditBlockedSalesDocument.SALES_DOCUMENT_TYPE,CreditBlockedSalesDocument.SALES_ORGANIZATION,CreditBlockedSalesDocument.DISTRIBUTION_CHANNEL,CreditBlockedSalesDocument.ORGANIZATION_DIVISION,CreditBlockedSalesDocument.SALES_OFFICE,CreditBlockedSalesDocument.SALES_GROUP,CreditBlockedSalesDocument.CREATED_BY_USER,CreditBlockedSalesDocument.CREATION_DATE,CreditBlockedSalesDocument.LAST_CHANGED_BY_USER,CreditBlockedSalesDocument.LAST_CHANGE_DATE,CreditBlockedSalesDocument.SOLD_TO_PARTY,CreditBlockedSalesDocument.TOTAL_NET_AMOUNT,CreditBlockedSalesDocument.TRANSACTION_CURRENCY,CreditBlockedSalesDocument.CUSTOMER_CREDIT_ACCOUNT,CreditBlockedSalesDocument.CONTROLLING_AREA_CURRENCY,CreditBlockedSalesDocument.RELEASED_CREDIT_AMOUNT,CreditBlockedSalesDocument.CREDIT_BLOCK_RELEASE_DATE,CreditBlockedSalesDocument.NEXT_SHIPPING_DATE,CreditBlockedSalesDocument.NEXT_CREDIT_CHECK_DATE,CreditBlockedSalesDocument.FIN_DOC_CREDIT_CHECK_STATUS,CreditBlockedSalesDocument.TOTAL_CREDIT_CHECK_STATUS,CreditBlockedSalesDocument.OVERALL_SD_PROCESS_STATUS,CreditBlockedSalesDocument.CENTRAL_CREDIT_CHECK_STATUS,CreditBlockedSalesDocument.CENTRAL_CREDIT_CHK_TECH_ERR_STS]

All fields of the CreditBlockedSalesDocument entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_CreditBlockedSalesDocument"

Technical entity name for CreditBlockedSalesDocument.

Static _keyFields

_keyFields: Array<Selectable<CreditBlockedSalesDocument>> = [CreditBlockedSalesDocument.SALES_DOCUMENT]

All key fields of the CreditBlockedSalesDocument entity.

Static _keys

_keys: any = CreditBlockedSalesDocument._keyFields.reduce((acc: any, field) => {acc[field.fieldName] = field;return acc;}, {})

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

Static _serviceName

_serviceName: string = "API_SLS_DOC_WITH_CREDIT_BLOCK"

Technical service name for CreditBlockedSalesDocument.

Methods

Static builder

Static customField

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<CreditBlockedSalesDocument>

    A builder that constructs instances of entity type CreditBlockedSalesDocument.

Static requestBuilder

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

    Returns CreditBlockedSalesDocumentRequestBuilder

    A CreditBlockedSalesDocument request builder.