ClooudERP IDL Business Partners
Contents |
Introduction
Business Partner is a generic term used for several object types like customer, vendor, employee, etc. All these object types have several properties in common, such as a name, address and contact.
Input file definition
| Field name | Type | Nullable | Description | Accepted values | Comment |
|---|---|---|---|---|---|
| Organization | String(40) | No | Indicates the organization to be used when processing documents. | [Organization search key] | |
| SearchKey | String(40) | No | Allows for a fast method of finding a particular business partner. | Duplicates in this field will create a new Location, Contact or Bank Account (for the referenced Business Partner) if the fields affecting this child entities have changes. | |
| Name | String(60) | No | Business Partner name. | ||
| Description | String(255) | Yes | More information about the Business Partner. | ||
| TaxID | String(20) | Yes | Identifies the legal Identification number of this Entity. | ||
| Tax Exempt | Boolean | No | If a business partner is exempt from tax, the exempt tax rate is used. For this, you need to set up a tax rate with a 0% rate and indicate that this is your tax exempt rate. This is required for tax reporting, so that you can track tax exempt transactions. | {TRUE, FALSE} | |
| ReferenceNo | String(40) | Yes | The reference number can be printed on orders and invoices to allow your business partner to faster identify your records. | ||
| Category | String(60) | No | A way of grouping business partners together for classification and reporting purposes. Provides a method of defining certain defaults to be used when opening new business partners. | [Business Partner category name] | If it does not exists any category with this name, a new Business Partner Category will be created with this name. |
| Language | String(6) | Yes | Identifies the language to use for display. | [ISO code] | |
| Location1stLine | String(60) | Yes | Identifies the address for a location. | ||
| Location2ndLine | String(60) | Yes | Provides additional address information for an entity. It can be used for building location, apartment number or similar information. | ||
| LocationPostalCode | String(10) | Yes | Identifies the postal code for this Business Partner address. | ||
| LocationCity | String(60) | Yes | Identifies a unique City for this Country or Region. | ||
| LocationRegion | String(60) | Yes | Identifies a unique Region for this Country. | [Region name] | At least Region and Country fields must be filled to create a Business Partner Location. In other case, the location will not be created. |
| LocationCountry | String(60) | Yes | Defines a Country. Each Country must be defined before it can be used in any document. | [Country name] | At least Country field must be filled to create a Business Partner Location. In other case, the location will not be created. |
| LocationPhone | String(40) | Yes | Identifies a telephone number | ||
| LocationAlternativePhone | String(40) | Yes | Identifies an alternate telephone number. | ||
| LocationFax | String(40) | Yes | Identifies a facsimile number for this Business Partner or Location. | ||
| LocationShipToAddress | Boolean | Yes | Indicates if this location is the address to use when shipping orders to this Business Partner. | ||
| LocationPayFroAddress | Boolean | Yes | Identifies if this location is the address the Business Partner pays from. | ||
| LocationInvoiceToAddress | Boolean | Yes | Indicates if this location is the Invoice to Address for this Business Partner | ||
| LocationRemitToAddress | Boolean | Yes | Indicates if this location is the address to which we should send payments to this Business Partner. | ||
| ConsumptionDays | Integer | Yes | This field is used Copy Lines From in Order tab to specify the consumptions made in the last n days. | ||
| Bank AccountShowGeneric | Boolean | Yes | Generic bank account. | {TRUE, FALSE} | If true the 'Bank Account - Number' must be filled. |
| BankAccountShowIBAN | Boolean | Yes | IBAN bank account. | {TRUE, FALSE} | If true the 'Bank Account - IBAN' must be filled. |
| BankAccountNumber | String(20) | Yes | Bank account generic number. | ||
| BankAccountIBAN | String(34) | Yes | Bank Account IBAN. | ||
| ContactName | String(60) | Yes | Contact name | This field must be not null to enter contact data. | |
| ContactFirstName | String(60) | Yes | First Name of the contact. | ||
| ContactLastName | String(60) | Yes | Last name of the contact. | ||
| ContactDescription | String(255) | Yes | More information about the contact. | ||
| ContactEmail | String(40) | Yes | The Email Address is the Electronic Mail ID for this User and should be fully qualified (e.g. joe.smith@company.com). | ||
| ContactPosition | String(40) | Yes | The Title indicates the name that an entity is referred to as. | ||
| ContactPhone | String(40) | Yes | Identifies a telephone number. | ||
| ContactAlternativePhone | String(40) | Yes | Identifies an alternate telephone number. | ||
| ContactFax | String(40) | Yes | Identifies a facsimile number for this Business Partner or Location. | ||
| Vendor | Boolean | No | Indicates if this Business Partner is a Vendor. If it is selected, additional fields will display which further identify this vendor. | {'TRUE', 'FALSE'} | |
| VendorPaymentMethod | String(60) | Yes | Indicates the method of purchase payment. | NAME column from the FIN_PAYMENT_METHOD table. | If it does not exists any payment method with this name, a new payment method will be created with this name. Note: the payment method must be associated (before or after import process) to any financial account. |
| VendorPaymentTerms | String(40) | Yes | Indicates the payment term that will be used when this purchase order becomes an invoice. | [Payment term search key] | |
| VendorPurchasePriceList | String(40) | Yes | Default purchase price list for vendor. | ||
| VendorTaxCategory | String(40) | Yes | Defined for apply default taxes for procurement transactions. | [Tax Category name] | |
| VendorFinancialAccount | String(60) | Yes | Vendor default financial account. | NAME column from the FIN_FINANCIAL_ACCOUNT table. | |
| Customer | Boolean | No | Indicates a business partner that is your customer, ie. that will be making purchases from you. If selected, additional fields will display further details that need to be entered for a customer. | {'TRUE', 'FALSE'} | |
| CustomerPaymentMethod | String(60) | Yes | Indicates the method of payment used for this transaction (eg. cash, wire transfer, etc.). | NAME column from the FIN_PAYMENT_METHOD table. | If it does not exists any payment method with this name, a new payment method will be created with this name. Note: the payment method must be associated (before or after import process) to any financial account. |
| CustomerPaymentTerms | String(32) | Yes | Identifies the method and timing of payment for this transaction. | [Payment term search key] | |
| CustomerPriceList | String(32) | Yes | Customer price list. | [Price List name] | |
| CustomerTaxCategory | String(32) | Yes | Defined for apply default taxes for procurement transactions. | [Tax Category name] | |
| CustomerFinancialAccount | String(60) | Yes | Customer default financial account. | NAME column from the FIN_FINANCIAL_ACCOUNT table. | |
| CustomerInvoiceSchedule | String(60) | Yes | Identifies the frequency used when generating invoices. | [Invoice Schedule name] | |
| CustomerInvoiceTerms | String(60) | Yes | Defines how a Business Partner is invoiced and the frequency of invoicing. | [C_Order InvoiceRule reference list] | English: {After Delivery, Immediate, Do not invoice, After Order delivered, Customer Schedule after Delivery} |
| Employee | Boolean | No | Indicates if this Business Partner is an Employee. If it is selected, additional fields will display which further identify this employee. | {'TRUE', 'FALSE'} | |
| EmployeeSalesRepresentative | Boolean | Yes | Indicates if this employee is also a sales representative. | {'TRUE', 'FALSE'} |
Default Value definition
| Field name | Type | Accepted values | Examples |
|---|---|---|---|
| Organization | String(40) | [search_key] column from [AD_Org] table. | |
| Language | String(6) | [ad_language] column from [ad_language] table. | es_ES, eu_ES, en_GB, ... |
| TaxID | String(20) | 1111, 54321, 789789, ... | |
| Category | String(60) | [name] column from [c_bpartner] table. | Standard Category, VIP, ... |
| PaymentTerm | String(60) | [name] column from [c_paymentterm] table. | Immediate, One month, Fifteen days ... |
| SalePriceList | String(60) | [name] column from [m_pricelist] table. | General Sales, Mafalda Sales, Standard Sales... |
| Country | String(60) | [name] column from [c_country] table. | Spain, United States, United Kingdom, France, ... |
| POPaymentTerm | String(40) | [po_payment_term] column from [c_bpartner] table. | Fifteen Days, Immidiate, One Month, ... |
| PurchasePriceList | String(40) | [purchase_pricelist] column from [c_bpartner] table. | Purchase |
| IsSalesRepresentative | Boolean | TRUE / True / true / FALSE / False / false | |
| Vendor | Boolean | TRUE / True / true / FALSE / False / false | |
| Customer | Boolean | TRUE / True / true / FALSE / False / false | |
| Employee | Boolean | TRUE / True / true / FALSE / False / false | |
| POFinancialAccount | String | NAME column from FIN_FINANCIAL_ACCOUNT table. |
|
| SOFinancialAccount | String | NAME column from FIN_FINANCIAL_ACCOUNT table. |
|
| InvoiceSchedule | String | [name] column from [c_invoiceschedule] table. |
|
| InvoiceTerm | String | {After Delivery, Immediate, Do not invoice, After Order delivered, Customer Schedule after Delivery}. |
Input file definition (Version 1.X.X)
| Field name | Type | Nullable | Description | Accepted values | Comment |
|---|---|---|---|---|---|
| Organization | String(40) | No | Indicates the organization to be used when processing documents. | [Organization search key] | |
| SearchKey | String(40) | No | Allows for a fast method of finding a particular business partner. | Duplicates in this field will create a new Location, Contact or Bank Account (for the referenced Business Partner) if the fields affecting this child entities have changes. | |
| Name | String(60) | No | Business Partner name. | ||
| Description | String(255) | Yes | More information about the Business Partner. | ||
| TaxID | String(20) | Yes | Identifies the legal Identification number of this Entity. | ||
| Tax Exempt | Boolean | No | If a business partner is exempt from tax, the exempt tax rate is used. For this, you need to set up a tax rate with a 0% rate and indicate that this is your tax exempt rate. This is required for tax reporting, so that you can track tax exempt transactions. | {TRUE, FALSE} | |
| ReferenceNo | String(40) | Yes | The reference number can be printed on orders and invoices to allow your business partner to faster identify your records. | ||
| Category | String(60) | No | A way of grouping business partners together for classification and reporting purposes. Provides a method of defining certain defaults to be used when opening new business partners. | [Business Partner category name] | If it does not exists any category with this name, a new Business Partner Category will be created with this name. |
| Language | String(6) | Yes | Identifies the language to use for display. | [ISO code] | |
| Location1stLine | String(60) | Yes | Identifies the address for a location. | ||
| Location2ndLine | String(60) | Yes | Provides additional address information for an entity. It can be used for building location, apartment number or similar information. | ||
| LocationPostalCode | String(10) | Yes | Identifies the postal code for this Business Partner address. | ||
| LocationCity | String(60) | Yes | Identifies a unique City for this Country or Region. | ||
| LocationRegion | String(60) | Yes | Identifies a unique Region for this Country. | [Region name] | At least Region and Country fields must be filled to create a Business Partner Location. In other case, the location will not be created. |
| LocationCountry | String(60) | Yes | Defines a Country. Each Country must be defined before it can be used in any document. | [Country name] | At least Country field must be filled to create a Business Partner Location. In other case, the location will not be created. |
| LocationPhone | String(40) | Yes | Identifies a telephone number | ||
| LocationAlternativePhone | String(40) | Yes | Identifies an alternate telephone number. | ||
| LocationFax | String(40) | Yes | Identifies a facsimile number for this Business Partner or Location. | ||
| LocationShipToAddress | Boolean | Yes | Indicates if this location is the address to use when shipping orders to this Business Partner. | ||
| LocationPayFroAddress | Boolean | Yes | Identifies if this location is the address the Business Partner pays from. | ||
| LocationInvoiceToAddress | Boolean | Yes | Indicates if this location is the Invoice to Address for this Business Partner | ||
| LocationRemitToAddress | Boolean | Yes | Indicates if this location is the address to which we should send payments to this Business Partner. | ||
| ConsumptionDays | Integer | Yes | This field is used Copy Lines From in Order tab to specify the consumptions made in the last n days. | ||
| Bank AccountShowGeneric | Boolean | Yes | Generic bank account. | {TRUE, FALSE} | If true the 'Bank Account - Number' must be filled. |
| BankAccountShowIBAN | Boolean | Yes | IBAN bank account. | {TRUE, FALSE} | If true the 'Bank Account - IBAN' must be filled. |
| BankAccountNumber | String(20) | Yes | Bank account generic number. | ||
| BankAccountIBAN | String(34) | Yes | Bank Account IBAN. | ||
| ContactName | String(60) | Yes | Contact name | This field must be not null to enter contact data. | |
| ContactFirstName | String(60) | Yes | First Name of the contact. | ||
| ContactLastName | String(60) | Yes | Last name of the contact. | ||
| ContactDescription | String(255) | Yes | More information about the contact. | ||
| ContactEmail | String(40) | Yes | The Email Address is the Electronic Mail ID for this User and should be fully qualified (e.g. joe.smith@company.com). | ||
| ContactPosition | String(40) | Yes | The Title indicates the name that an entity is referred to as. | ||
| ContactPhone | String(40) | Yes | Identifies a telephone number. | ||
| ContactAlternativePhone | String(40) | Yes | Identifies an alternate telephone number. | ||
| ContactFax | String(40) | Yes | Identifies a facsimile number for this Business Partner or Location. | ||
| Vendor | Boolean | No | Indicates if this Business Partner is a Vendor. If it is selected, additional fields will display which further identify this vendor. | {'TRUE', 'FALSE'} | |
| VendorFormOfPayment | String(32) | Yes | Indicates the method of purchase payment. | [All_Payment Rule reference list] | English: {Wire Transfer, Check, Promissory Note, Money Order, Bank Deposit, Cash, Cash on Delivery, Credit Card, On Credit, Bank Remittance, Withholding} |
| VendorPaymentTerms | String(40) | Yes | Indicates the payment term that will be used when this purchase order becomes an invoice. | [Payment term search key] | |
| VendorPurchasePriceList | String(40) | Yes | Default purchase price list for vendor. | ||
| VendorTaxCategory | String(40) | Yes | Defined for apply default taxes for procurement transactions. | [Tax Category name] | |
| VendorBankAccount | String(50) | Yes | Vendor default bank account. | [Displayed account] | |
| Customer | Boolean | No | Indicates a business partner that is your customer, ie. that will be making purchases from you. If selected, additional fields will display further details that need to be entered for a customer. | {'TRUE', 'FALSE'} | |
| CustomerFormOfPayment | String(60) | Yes | Indicates the method of payment used for this transaction (eg. cash, wire transfer, etc.) | [All_Payment Rule reference list] | English: {Wire Transfer, Check, Promissory Note, Money Order, Bank Deposit, Cash, Cash on Delivery, Credit Card, On Credit, Bank Remittance, Withholding} |
| CustomerPaymentTerms | String(32) | Yes | Identifies the method and timing of payment for this transaction. | [Payment term search key] | |
| CustomerPriceList | String(32) | Yes | Customer price list. | [Price List name] | |
| CustomerTaxCategory | String(32) | Yes | Defined for apply default taxes for procurement transactions. | [Tax Category name] | |
| CustomerBankAccount | String(50) | Yes | Customer default bank account. | [Displayed account] | |
| CustomerInvoiceSchedule | String(60) | Yes | Identifies the frequency used when generating invoices. | [Invoice Schedule name] | |
| CustomerInvoiceTerms | String(60) | Yes | Defines how a Business Partner is invoiced and the frequency of invoicing. | [C_Order InvoiceRule reference list] | English: {After Delivery, Immediate, Do not invoice, After Order delivered, Customer Schedule after Delivery} |
| Employee | Boolean | No | Indicates if this Business Partner is an Employee. If it is selected, additional fields will display which further identify this employee. | {'TRUE', 'FALSE'} | |
| EmployeeSalesRepresentative | Boolean | Yes | Indicates if this employee is also a sales representative. | {'TRUE', 'FALSE'} |
Default Value definition (Version 1.X.X)
| Field name | Type | Accepted values | Examples |
|---|---|---|---|
| Organization | String(40) | [search_key] column from [AD_Org] table | |
| Language | String(6) | [ad_language] column from [ad_language] table | es_ES, eu_ES, en_GB, ... |
| TaxID | String(20) | 1111, 54321, 789789, ... | |
| Category | String(60) | [name] column from [c_bpartner] table | Standard Category, VIP, ... |
| PaymentTerm | String(60) | [name] column from [c_paymentterm] table | Immediate, One month, Fifteen days ... |
| SalePriceList | String(60) | [name] column from [m_pricelist] table | General Sales, Mafalda Sales, Standard Sales... |
| Country | String(60) | [name] column from [c_country] table | Spain, United States, United Kingdom, France, ... |
| POPaymentTerm | String(40) | [po_payment_term] column from [c_bpartner] table | Fifteen Days, Immidiate, One Month, ... |
| PurchasePriceList | String(40) | [purchase_pricelist] column from [c_bpartner] table | Purchase |
| IsSalesRepresentative | Boolean | TRUE / True / true / FALSE / False / false | |
| Vendor | Boolean | TRUE / True / true / FALSE / False / false | |
| Customer | Boolean | TRUE / True / true / FALSE / False / false | |
| Employee | Boolean | TRUE / True / true / FALSE / False / false | |
| POBankAccount | String | [displayed_Account] column from [c_bankaccount] table |
|
| SOBankAccount | String | [displayed_Account] column from [c_bankaccount] table |
|
| InvoiceSchedule | String | [name] column from [c_invoiceschedule] table |
|
| InvoiceTerm | String | {After Delivery, Immediate, Do not invoice, After Order delivered, Customer Schedule after Delivery} |