0057928: Business Partner API Improvements

Description

Current Swagger information for the Business Partner API is lacking in some fields. Their descriptions / informations must be updated so the clients can easily work with the API.

Steps To Reproduce

Check the livebuilds discount API and update the missing fields as seen on the PDF.

Proposed Solution

Update required fields:

Name: greeting/name
Description: An identifier (that does need to be unique) that is used as a default search option along with the search key.
Example: Mr / Mss

Name: greeting/title
Description: The Greeting indicates what will print on letters sent to a Business Partner.
Example: Mr / Mss

Name: Currency
Description: Currency to be used by this Business Partner.
Example: EUR

Name: Payment Terms
Description: Payment Terms Search Key. Payment terms identify the method and timing of payment for this transaction.

Name: Price List
Description: Price List name

Name: Invoice Terms
Description: Defines how a Business Partner is invoiced and the frequency of invoicing. Only available if the customer is not a vendor
O = Invoice for every order
D = Invoice per Delivery
S = Invoice per Customer Invoice Schedule
I = Immediate Invoice
N = Order should not be invoiced trough Process Invoice

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

Name: Organization
Description: Search Key of the Organization

Name:Currency
Description: Currency used by the Business Partner
Example: EUR

Name: PaymentMethod
Description: Search Key of the method by which payment is expected to be made or received.

Name: paymentTerms
Description: The setup and timing defined to complete a specified payment.

Name: priceList
Description: Search Key of the price list

Name: customerConsent
Description: Checked when the Customer consents to process their information

Name: creditlinelimit
Description: Total outstanding invoice amounts allowed

Name: invoiceTerms
Description:Defines how a Business Partner is invoiced and the frequency of invoicing. Only available if the customer is not a vendor.
O = After Order Delivered
D = After Delivered
S = Customer Schedule After Delivery
I = Immediate
N = Do Not Invoice

Name: isCustomer
Description: Indicates a business partner that is your customer, ie. that will be making purchases from you.

Name: isVendor
Description:A business partner who sells products or services.

Name: purchasePricelist
Description: Search key of the pricelist used.

Name: poMaturityDate1
Description: The day of the month that invoices are due. 3 maturity dates can be defined.

Name: poMaturityDate2
Description: The day of the month that invoices are due. 3 maturity dates can be defined.

Name: poMaturityDate3
Description: The day of the month that invoices are due. 3 maturity dates can be defined.

Name: poPaymentMethod
Comments: Could not find any info relevant about this field.

Issue History
Date Modified	Username	Field	Change
2025-02-10 15:46	XABIER_AGUADO	New Issue
2025-02-10 15:46	XABIER_AGUADO	Assigned To	=> Retail
2025-02-10 15:46	XABIER_AGUADO	File Added: BP-API - Business partner.pdf
2025-02-10 15:46	XABIER_AGUADO	Triggers an Emergency Pack	=> No
2025-02-10 15:46	XABIER_AGUADO	Tag Attached: FASH
2025-02-11 11:52	XABIER_AGUADO	Proposed Solution updated
2025-02-11 15:05	XABIER_AGUADO	Proposed Solution updated
2025-02-13 12:58	XABIER_AGUADO	Proposed Solution updated

Relationships [ Relation Graph ] [ Dependency Graph ]

Notes
There are no notes attached to this issue.