0058115: Improve descriptions for the Order API

Description

Current Swagger information for the Order API is lacking in some fields. Their descriptions / informations must be updated so the clients can easily work with the API.
The descriptions proposed need to be added to EXPORT entities.

Steps To Reproduce

Check the API EXPORT: /org.openbravo.api.ExportService/Order

The following fields need to be updated:

Name: Client
Description: Search Key of the client

Name: Organization
Description: Organization Search Key

Name: Terminal
Description: POS Terminal Search Key

Name:documentType
Description: The Document Type determines document sequence and processing rules.

Name: priceList
Description: Price List Name

Name:businessPartner
Description: Name of the Business Partner

Name: businessPartnerType
Description: A classification of business partners based on its type.
FC = Final consumer
CO = Company
PR = Professional
PS = Public Sector

Name: salesRepresentative
Description: Indicates the sales representative responsible for the transaction that the document specifies . A valid sales representative is a business partner marked as an employee and a sales representative.

Name: warehouse
Description: Warehouse Search Key

Name: isCancelled
Description: The Sales Order has been canceled or cancelled and replaced.

Name: isLayaway
Description: This field indicates if the receipt is a Layaway created from Web POS

Name: isSale
Description: This field indicates if the receipt is s sale created from Web POS

Name: priceIncludesTax
Description: The Tax Included checkbox indicates if the prices include tax. This is also known as the gross price.

Name: currency
Description: Currency used
Example: EUR

Name: invoiceTerms
Description: The Invoice Rule defines how a Business Partner is invoiced and the frequency of invoicing.
O = After Order Delivered
D = After Delivery
S = Customer Schedule After Delivery
I = Immediate
N = Do Not Invoice

Name: grossAmount
Description: The final monetary amount (including taxes) charge listed in a document.

Name:netAmount
Description: The final sum of all line totals made to a specified document or transaction (not including taxes).

Name: lines - lineNo
Description: A line stating the position of this request in the document.

Name: lines - orderedQuantity
Description: The number of an item involved in a transaction, given in standard units. It is used to determine price per unit.

Name: lines - shippedQuantity
Description: The Shipped Quantity indicates the quantity of a product that has been shipped.

Name: lines - invoicedQuantity
Description: The Invoiced Quantity indicates the quantity of a product that has been invoiced.

Name:lines - grossAmount
Description: The final monetary amount (including taxes) charge listed in a document.

Name: lines - deliveryMode
Description: Selected way of delivering the products.
PickAndCarry = Pick And Carry
PickupInStore = Pick Up in Store
PickupInStoreDate = Pick Up in Store with date
OBPOS2_PickupInStoreWithDateRange = Pick Up in Store with date range
HomeDelivery = Home Delivery
HomeDeliveryDate = Home Delivery with date

Name: lines - netAmount
Description: The final sum of all line totals made to a specified document or transaction (not including taxes).

Name: lines - UOM
Description: A non monetary unit of measure.

Name: lines - grossUnitPrice
Description: This is the price that is provided when the price is inclusive of taxes.

Name: lines - netUnitPrice
Description: The actual price indicates the price for a product in source currency.

Name: lines - grossListPrice
Description: The Gross List Price is the official price stated by the selected tax included pricelist and the currency of the document.

Name: lines - netListPrice
Description: The Net List Price is the official price stated by the selected pricelist and the currency of the document.

Name: lines - Product
Description: Identifies item an by Search Key which is either purchased or sold in this organization.

Name: lines - product_info - productType
Description: An important classification used to determine the accounting and management of a product.
I = ITEM
S = SERVICE
R = RESOURCE
E = EXPENSE TYPE
O = ONLINE
C = CONTRIBUTION

Name: lines - product_info - productType - productCategory
Description: Category Search Key. A classification of items based on similar characteristics or attributes.

Name: lines - product_info - productType - productCategoryname
Description: Product Category Name

Name: lines - warehouse
Description: The search key of the warehouse used for this line

Name: lines - taxCategory
Description: The search key of the tax Category used for this line

Name: lines - Sales representative
Description: Indicates the sales representative responsible for the transaction that the document specifies . A valid sales representative is a business partner marked as an employee and a sales representative.

Name: lines - promotions - discountType
Description: Discounts and Promotions functionality allows to apply different rules to order/invoice lines to adjust pricing. A type is each of these kinds of rules.

Name: lines - taxes- tax
Description: Search Key of the tax rate used. It indicates the type of tax for this document line.

Name: lines - taxes- rate
Description:rate The percentage to be multiplied by the source to arrive at the tax or exchange amount.

Name: lines - relatedProducts - orderlineId
Description: A unique and often automatically generated identifier for a sales order line.

Name: lines - commercialOperation - name
Description: A non-unique identifier for a commercial operation.

Name: lines - deliveredQuantity
Description: The Delivered Quantity indicates the quantity of a product that has already been delivered.

Name: lines - obposCanbedelivered
Description: This field defines if the line can be delivered or not

Name: lines - crossStoreSalesOrganization
Description: When the sale is cross store (the line warehouse is from another organization), this field contains the organization of the warehouse (the store where the product should be picked up).

Name: lines - groupingDescription
Description: Store the information for categorizing order lines based on merged orders.

Name: lines - kit
Description: A reference to the order line of the kit to which the kit item belongs.

Name: lines - entryMode
Description: How the product was added to the order:
    - Barcode Scanned: Product was scanned.
    - Code Keyed Manually: Seller entered the code manually.
    - Browse / Keymap: Product was selected from the keymap
    - Product Search: Seller was doing a search to find the product, then selected it in the browse
    - Pre-Existing: the product was added by selecting it from a previous ticket (for instance, a verified return), or by adding an external order or the order was created via external order loader (e-commerce order…)
If there’s X products for a line, we only refer to the first action registered.

Name: lines - entryValue
Description: Value for the entry mode, depending on the entry method type.
If the “entry method “is:
    - "Barcode Scanned" this field will contain the scanned barcode in the POS.
    - "Code Keyed Manually" will set up the UPC or Product Code of the product, depending on how it was searched.
    - "Browse / Keymap": In this case the value will be empty so the field should not be displayed in the BO UI.
    - "Product Search" the name, UPC or searchkey of the product used to find it.
    - "Pre-Existing" the source of the product (External Order API, Verified Return).

Name: payments - name
Description: Name of the method by which payment is expected to be made or received.

Name: payments - rate
Description: Exchange rate used to convert payment to financial account currency

Name: payments - currency
Description: An accepted medium of monetary exchange that may vary across countries.

Name: payments - paidAmount
Description: Received amount

Name: payments - giftCardInstance - client
Description: Client for this installation.

Name: payments - giftCardInstance - active
Description: A flag indicating whether this record is available for use or de-activated.

Name: taxes- tax
Description: Search Key of the tax rate used. It indicates the type of tax for this document line.

Name: taxes- rate
Description: The percentage to be multiplied by the source to arrive at the tax or exchange amount.

Name: returnReason
Description: Search Key of the return reason used.

Name: externalBusinessPartnerReference
Description: This field stores the business partner reference to an external CRM system

Name: inputsAndApprovals - userAction
Description: Represents an action that can be executed by a user

Name: inputsAndApprovals - approvedBy
Description: The user that approved a user action

Name: inputsAndApprovals - approvalReasonDate
Description: The date which the approval/reason was given

Name: marketingSurveyResult - marketingSurvey
Description: Marketing Surveys to be displayed to the customer in the POS

Name: touchpoint_info - touchpoint
Description: TouchPoint´s search key

Name: touchpoint_info - touchpointtype
Description: TouchPoint type´s name

Name: orderMergedIn
Description: Links to the merged order

Name: isDelivered
Description: Indicates if the order has been delivered or not.

Name:documentStatus
Description: The Document Status indicates the status of a document at this time.
??= Unknown
AE Automatic Evaluation
AP Accepted
CA Closed - Order Created
CH Modified
CJ Closed - Rejected
CL Closed
CO Booked
DR Draft
IN Inactive
IP Under Way
ME Manual Evaluation
NA Not Accepted
NC Not Confirmed
PA Pending Approval
PE Accounting Error
PO Posted
PR Printed
RE Re-Opened
RJ Rejected
TE Transfer Error
TMP Temporal
TR Transferred
UE Under Evaluation
VO Voided
WP Not Paid
XX Procesando

Issue History
Date Modified	Username	Field	Change
2025-02-28 15:19	XABIER_AGUADO	New Issue
2025-02-28 15:19	XABIER_AGUADO	Assigned To	=> Retail
2025-02-28 15:19	XABIER_AGUADO	Triggers an Emergency Pack	=> No

Relationships [ Relation Graph ] [ Dependency Graph ]

Notes
There are no notes attached to this issue.