This method lets you add companies to the system, either client or supplier
URL
(PUT) Companies
PARAMETERS
token | The token obtained on connection | Required |
data | A json containing the company information (see below) | Required |
JSON format of "data" parameter
| CompanyName | The name of the company | Required |
| Code | An optional company code. | Optional |
| IsClient | Indicates which type of company you want to create. If true, it creates a client. If false, a supplier. | Required |
| CompanyTypeId | The id representing the type of company that you want to create. For example, '0' is a "Corporation", '1' is a "Freelance translator". See Company types to get the list of existing profiles. If not set, "Corporation" is the default type. | Optional |
| Comments | Internal comments included with the new company | Optional |
| City | The city where the company is based. | Optional |
| AddressLine1 | The first line of the address of the company. | Optional |
| AddressLine2 | The second line of the address of the company. | Optional |
| AddressLine3 | The third line of the address of the company. | Optional |
| Zip | The address zip code. | Optional |
| CountryCode | The 3 letter ISO country code such as 'USA', 'GRB',… See http://unstats.un.org/unsd/tradekb/Knowledgebase/Country-Code for a complete list of codes. | Required |
| TimeZone | The company time zone code. See chapter Time zones to get the list of supported codes. | Required |
| ContactName | The contact person. | Optional |
| Contact | EmailThe contact email. | Required |
| Contact | PhoneThe contact phone. | Optional |
| ContactPhoneMobile | The contact mobile phone. | Optional |
| ContactFax | The contact fax. | Optional |
| ContactLocale | The preferred language of communication. | Optional |
| ContactTitle | The title of the contact such 'Mr.', 'Mrs.',... | Optional |
| DebtorNo | The debtor number. Applies to clients only. | Optional |
| CreditorNo | The creditor number. Applies to suppliers only. | Optional |
| InvIsSame | True or false. Indicates if the billing address is the same than the company address. If not set, the default value is true. The properties below are only processed if value is true. | Optional |
| InvName | The billing company name. | Optional |
| InvEmail | If specified, then invoices are distributed by email to this address. Otherwise, emails are sent to the regular company contact email. | Optional |
| InvCity | Billing details: The city. | Optional |
| InvAddressLine1 | Billing details: The first address details line. | Optional |
| InvAddressLine2 | Billing details: The second address details line. | Optional |
| InvAddressLine3 | Billing details: The third address details line. | Optional |
| InvZip | Billing details: The zip code. | Optional |
| InvCountryCode | Billing details: The 3 letter ISO country code. | Optional |
| VAT | Applicable VAT rate. If empty then the default platform VAT rate applies when calculating costs. | Optional |
| PaymentTerms | Payment terms applicable to supplier/client. If not provided, the platform default terms apply. | Optional |
| VATNo | The company VAT /Tax number. | Optional |
| AccountingCode | Optional code used for accounting purposes. | Optional |
| CustomFields | A json array containing a list of custom field ids and values. See below for details.
Example:
CustomFields: [ { "Id": "CustomStr1", "Value": "My field" }, { "Id": "CustomStr5", "Value": "A-2233" } ] | Optional |
| Labels | Set a label: "labels": [ { "id": 10, "value": 1 }, … ] Clear a label: "labels": [ { "id": 10, "value": null }, … ] See chapter REF _Ref362347538 \r \h 12.5 to get the list of labels. | Optional |
| InvoiceTemplateId | The id of the template to use when printing invoices / quotes. See REF _Ref373232901 \r \h 12.11 to get the list.Set null to reset value. | Optional |
JSON format of field "CustomFields"
| Id | The custom string id such as 'CustomStr1', 'CustomStr2', etc. Use method settings/customfields to obtain all available ids. Note that custom fields may apply to clients only, suppliers only or both (check out the configuration of custom fields in your Wordbee platform). | Required |
| Value | The value (string) of the custom field | Required |