Short Description
Chapter Contents:
Long Description
Supported methods
GET /BusinessPartner
Get a slit of BusinessPartner objects. Filter to avoid huge amounts of data (see Filtering for search parameters).
GET /BusinessPartner/{key}
Get a single BusinessPartner object
POST /BusinessPartner
Insert a new BusinessPartner object.
- Required fields: businessPartner: businessPartnerCode, businessPartnerType, businessPartnerSort
- Unique fields: businessPartner: businessPartnerCode, businessPartnerSort
- Linking bank accounts: Can be achieved in a single call (see below), or in separate calls. Use unlink call to unlink bank accounts.
Link bank accounts in the same call
{
...,
...,
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 need not be updated. Any field that takes a code can take an ID instead.
- Code fields: businessPartner: businessUnit, baselineTerm, payee, paymentTerms, bankAccountNo, businessPartnerType
- ID fields: businessPartner
- Boolean fields: businessPartner: isInterCompany, isTotalCommissionPayable
- Non-ID fields without quotes are numeric values.
- Non-code fields with quotes are alphanumeric strings.
POST /BusinessPartner/{key}/BankAccount/{bankAccountKey}/link (New for API version 2.0.0 )
Links existing bank account to given business partner.
POST /BusinessPartner/{key}/BankAccount/{bankAccountKey}/unlink (New for API version 2.0.0 )
Unlinks bank account from 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 Accounts Payable | |||
businessPartnerName | String | 80 | Yes | Business Partner Name 1 | |
businessPartnerCode | String | 12 | Yes | Business PartnerCode | |
businessPartnerName2 | String | 80 | Business PartnerName 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 PartnerType | |||
companyBankAccount | /BankAccount | Default Bank Accounts 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 |
New BusinessPartner Example
Example how to create a new BusinessPartner object:
POST /BusinessPartner
Request Body:
{
"businessUnit": null,
"baselineTerm": "LOAD",
"payee": "P200240",
"paymentTerms": "IMD",
"bankAccount": null,
"businessPartnerName": "Spliethoff''s Bevrachtingskantoor B.V.",
"businessPartnerCode": "123456789-1",
"businessPartnerName2": "Spliethoff''s Bevrachtingskantoor B.V.",
"businessPartnerSort": "Spliethoff NL",
"companyRegistrationNo": "123456789",
"isInterCompany": false,
"isTotalCommissionPayable": true,
"maxAdvancePaymentPercent": 100,
"vatNumber": "123456879",
"businessPartnerType": "BB",
"companyBankAccount": null,
"individuals": [
{
"individualName": "Test Person"
},
{
"individualName": "Test Person2"
}
],
"remarks": [
{
"remarkTitle": "A Remark title",
"remark": "This is a remark on a Various"
},
{
"remarkTitle": "Another remark title",
"remark": "This is another remark on a Various.\n\nThis is the line after the blank line."
}
],
"addresses": [
{
"country": "NL",
"address1": "Street Name 54",
"address2": "5th floor",
"address3": "",
"city": "Amsterdam",
"postalCode": "1000 AA"
}
],
"contactInfo": [
{
"email": "test@test.com",
"faxNo": "55555555",
"mobileNo": "66666666",
"phoneNo": "77777777",
"telexNo": "88888888"
}
]
}