...
POST /BusinessPartner
Insert a new BusinesspPartner BusinessPartner object
Required fields: businessPartner: businessPartnerCode, businessPartnerType, businessPartnerSort
Unique fields: businessPartner: businessPartnerCode, businessPartnerSort
Linking bank accounts: This can be achieved in a single call, or in separate calls.
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
...,
...,
bankAccounts: [
12345,
{ bankAccountNo: 1234567890 }],
}
Links bank account with key 12345 (already existing) to the business partner. And also creates and links a new bank account with account number 1234567890 to the business partner. |
PUT /BusinessPartner/{key}
Update an existing BusinessPartner. Unchanged properties can be skipped.
...
Fields with quotes, that are not code fields, are alphanumeric strings.
POST /BusinessPartner/{key}/BankAccount/{bankAccountKey}/link (new in version 1.0.0-alpha10)Anchor link link
Links the existing bank account to the given business partner.
POST /BusinessPartner/{key}/BankAccount/{bankAccountKey}/unlink (new in version 1.0.0-alpha10)
Unlinks the bank account from the given business partner.
Properties
| Property | Type | Length | Mandatory | Description | Comments |
|---|---|---|---|---|---|
businessUnit | /BusinessUnit | Business Unit | |||
baselineTerm | /BaselineTerm | Default Baseline Term | |||
payee | /BusinessPartner | Default Invoice Party | |||
paymentTerms | /PaymentTerms | Default Payment Terms | |||
bankAccount | /BankAccount | Default Bank Account Payable | |||
businessPartnerName | String | 80 | yes | Business Partner Name 1 | |
businessPartnerCode | String | 12 | yes | Business Partner Code | |
businessPartnerName2 | String | 80 | Business Partner Name 2 | ||
businessPartnerSort | String | 20 | yes | Sort Name. (Short version of Business Partner name). | |
| businessPartnerLink | /BusinessPartner | Linked Business Partner | new | ||
companyRegistrationNo | String | 24 | Company Registration Number | ||
isInterCompany | Boolean | Inter Company | |||
isTotalCommissionPayable | Boolean | Deduct 100% Commission on Balance Freight Calculation | |||
maxAdvancePaymentPercent | Integer | Max Advance Payment Percent. (Defaults to 100% if not set) | |||
vatNumber | String | 24 | VAT Registration Number | ||
businessPartnerType | /BusinessPartnerType | Business Partner Type | |||
companyBankAccount | /BankAccount | Default Bank Account Receivable | |||
individuals | Array of /Individual | List of Individuals for Business Partner | |||
addresses | Array of /Address | List of Addresses for Business Partner | |||
| contactInfo | Array of /ContactInfo | List of Contact Infos for Business Partner | |||
| codeProperty | String | new | |||
| bankAccounts | Array of /BankAccount | List of Bank Accounts for Business Partner | new |
...