POST api/v1/Contacts
Create a list of Contacts.
Request Information
URI Parameters
None.
Body Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
Type |
Contact Type: Customer, Supplier |
ContactType |
Required |
SalesPersonId |
The User Id |
integer |
None. |
AccountNumber |
Account Number |
string |
Max length: 10 |
BillingId |
Parent company member id |
integer |
None. |
BillingCompany |
Billing Company |
string |
Max length: 50 |
AccountsFirstName |
Accounts contact first name |
string |
Max length: 50 |
AccountsLastName |
Accounts contact last name |
string |
Max length: 50 |
BillingEmail |
Billing Email |
string |
Max length: 50 |
AccountsPhone |
Accounts contact phone |
string |
Max length: 50 |
BillingCostCenter |
Alternative GL account of a Parent company if exists |
string |
None. |
CostCenter |
Alternative GL account |
string |
None. |
PriceColumn |
A price column name. Query ProductOptions to get a list of valid price column names. |
string |
None. |
PercentageOff |
Percentage Off Price Tier. Price discount on top of PriceColumn. |
decimal number |
Range: 0–100 |
PaymentTerms |
Payment terms |
string |
None. |
TaxStatus |
Tax Status |
string |
None. |
TaxNumber |
Taxt Number |
string |
None. |
CreditLimit |
Credit Limit |
decimal number |
None. |
BalanceOwing |
Balance Owing |
decimal number |
None. |
OnHold |
Hold Status |
boolean |
None. |
Group |
Group |
string |
None. |
SubGroup |
Subgroup |
string |
None. |
Stages |
Stages |
string |
None. |
AccountingIntegrationId |
Accounting Integration Ids for Xero, QuickBooks Online and QuickBooks Desktop (readonly) |
AccountingIntegrationId |
None. |
Id |
The unique Cin7 Id. |
integer |
None. |
CreatedDate |
Created Date |
date |
None. |
ModifiedDate |
Modified Date |
date |
None. |
IsActive |
Is Active |
boolean |
None. |
Company |
Company |
string |
Max length: 250 |
FirstName |
First Name |
string |
Max length: 250 |
LastName |
Last Name |
string |
Max length: 250 |
JobTitle |
Job Title |
string |
Max length: 250 |
|
A unique email address |
string |
None. |
|
Website |
Website |
string |
Max length: 50 |
Phone |
Phone |
string |
Max length: 50 |
Fax |
Fax |
string |
Max length: 50 |
Mobile |
Mobile |
string |
Max length: 50 |
Address1 |
Address 1 |
string |
Max length: 50 |
Address2 |
Address 2 |
string |
Max length: 50 |
City |
City |
string |
Max length: 50 |
State |
State |
string |
Max length: 50 |
PostCode |
Post Code |
string |
Max length: 50 |
Country |
Country |
string |
Max length: 50 |
PostalAddress1 |
Billing/Postal Address 1 |
string |
Max length: 50 |
PostalAddress2 |
Billing/Postal Address 2 |
string |
Max length: 50 |
PostalCity |
Billing/Postal City |
string |
Max length: 50 |
PostalPostCode |
Billing/Postal Post Code |
string |
Max length: 50 |
PostalState |
Billing/Postal State |
string |
Max length: 50 |
PostalCountry |
Billing/Postal Country |
string |
Max length: 50 |
Notes |
Notes |
string |
Max length: 250 |
IntegrationRef |
Integration reference. |
string |
None. |
CustomFields |
Custom fields. |
Collection of KeyValuePairOfStringAndObject |
None. |
SecondaryContacts |
Secondary Contacts |
Collection of SubContact |
None. |
Response Information
Resource Description
Collection of BatchResultItem
| Name | Description | Type | Additional information |
|---|---|---|---|
Index |
The index at which the record was positioned in an insert or update. |
integer |
None. |
Success |
True if the record was successfully inserted or updated. |
boolean |
None. |
Id |
The record Id. |
integer |
None. |
Code |
The record code. |
string |
None. |
Errors |
A list of errors if the insert or update fails. |
Collection of String |
None. |
Response Formats
application/json, text/json
[
{
"index": 1,
"success": false,
"id": 1,
"code": "",
"errors": [
""
]
}
]