POST /api/v1/customers
Creates a new customerServers
- https://app.billbee.io
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
RestoredAt |
String | No |
If set, the customer was restored from the archive at the given date. |
Number |
Integer | No | |
Name |
String | No | |
LanguageId |
Integer | No | |
Type |
Integer | No |
Customer Type |
Tel2 |
String | No | |
Tel1 |
String | No | |
Email |
String | No | |
Id |
Integer | No |
The Billbee Id of the customer |
VatId |
String | No |
The vat-id, that should be saved at the customer. Only used if CustomerVatId is not set on the order. |
DefaultFax |
Object | No | |
DefaultFax.Id |
Integer | No | |
DefaultFax.SubType |
String | No | |
DefaultFax.TypeName |
String | No | |
DefaultFax.TypeId |
Integer | No | |
DefaultFax.Value |
String | No | |
DefaultStatusUpdatesMailAddress |
Object | No | |
DefaultStatusUpdatesMailAddress.Id |
Integer | No | |
DefaultStatusUpdatesMailAddress.SubType |
String | No | |
DefaultStatusUpdatesMailAddress.TypeName |
String | No | |
DefaultStatusUpdatesMailAddress.TypeId |
Integer | No | |
DefaultStatusUpdatesMailAddress.Value |
String | No | |
DefaultMailAddress |
Object | No | |
DefaultMailAddress.Id |
Integer | No | |
DefaultMailAddress.SubType |
String | No | |
DefaultMailAddress.TypeName |
String | No | |
DefaultMailAddress.TypeId |
Integer | No | |
DefaultMailAddress.Value |
String | No | |
DefaultCommercialMailAddress |
Object | No | |
DefaultCommercialMailAddress.Id |
Integer | No | |
DefaultCommercialMailAddress.SubType |
String | No | |
DefaultCommercialMailAddress.TypeName |
String | No | |
DefaultCommercialMailAddress.TypeId |
Integer | No | |
DefaultCommercialMailAddress.Value |
String | No | |
PriceGroupId |
Integer | No | |
Address |
Object | No |
Container for passing address data |
Address.City |
String | No | |
Address.RestoredAt |
String | No |
If set, the customeraddress was restored from the archive at the given date. |
Address.State |
String | No | |
Address.Street |
String | No | |
Address.Name2 |
String | No |
Optionally an additional name field |
Address.CountryCode |
String | No |
The ISO2 code of the country |
Address.Tel2 |
String | No | |
Address.LastName |
String | No | |
Address.Tel1 |
String | No | |
Address.Company |
String | No |
The name of the company |
Address.FirstName |
String | No | |
Address.Email |
String | No | |
Address.Id |
Integer | No |
The internal Billbee ID of the address record. Can be null if a new address is created |
Address.AddressType |
Integer | No |
The type of the address Valid values:
|
Address.AddressAddition |
String | No | |
Address.Fax |
String | No | |
Address.Zip |
String | No | |
Address.Housenumber |
String | No | |
Address.ArchivedAt |
String | No |
If set, the customeraddress was already archived at the given date. Further modification is disabled. |
Address.CustomerId |
Integer | No |
The internal Billbee id of the customer the address belongs to |
DefaultPhone1 |
Object | No | |
DefaultPhone1.Id |
Integer | No | |
DefaultPhone1.SubType |
String | No | |
DefaultPhone1.TypeName |
String | No | |
DefaultPhone1.TypeId |
Integer | No | |
DefaultPhone1.Value |
String | No | |
DefaultPhone2 |
Object | No | |
DefaultPhone2.Id |
Integer | No | |
DefaultPhone2.SubType |
String | No | |
DefaultPhone2.TypeName |
String | No | |
DefaultPhone2.TypeId |
Integer | No | |
DefaultPhone2.Value |
String | No | |
ArchivedAt |
String | No |
If set, the customer was already archived at the given date. Further modification is disabled. |
MetaData[] |
Array | No | |
MetaData[].Id |
Integer | No | |
MetaData[].SubType |
String | No | |
MetaData[].TypeName |
String | No | |
MetaData[].TypeId |
Integer | No | |
MetaData[].Value |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.