Lead Object
The Lead is a primary record type in Order Time.
End Point
/lead
GET, POST, PUT, DELETE
GET and DELETE requests expect parameter id of type Int32.
Converting a Lead to a Customer via API
If you pass the Lead ID by itself with a PUT, it will convert the Lead to a Customer.
Properties
Property | Caption | Data Type | Required |
CompanyName | Company | String (50) | False |
Name | Name | String (50) | True |
Parent | Sub of | String (50) | False |
TaxRegistrationNumber | Tax Reg. No. | String (50) | False |
Website | Website | String (50) | False |
Note | Note | String (4000) | False |
SalesTaxCertificate | Resell Number | String (15) | False |
PrimaryContact | Primary Contact | Person | False |
Id | Id | Int32 | False |
ClassRef | Class | EntityRef | False |
CurrencyRef | Currency | EntityRef | False |
DiscountRef | Discount | EntityRef | False |
FOBRef | FOB | EntityRef | False |
ItemSalesTaxRef | Tax Item | EntityRef | False |
LeadStatusRef | Lead Status | EntityRef | False |
PriceLevelRef | Price Level | EntityRef | False |
ProxyRef | Proxy | EntityRef | False |
SalesRepRef | Sales Rep | EntityRef | False |
SalesTaxCodeRef | Tax Code | EntityRef | False |
ShipMethodRef | Ship Method | EntityRef | False |
TermRef | Terms | EntityRef | False |
TypeRef | Type | EntityRef | False |
IsActive | Active | Boolean | False |
BillAddress | Bill Address | Address | False |
PrimaryShipAddress | Primary Ship Address | Address | False |
CustomFields | Custom Fields | Array of CustomFieldData | False |
Json Sample
{ Id: 1947, Name: "Peter Pan LLC", IsActive: true, CompanyName: "Peter Pan LLC", PrimaryContact: { Salutation:"Mr." , FirstName: "Aaron", MiddleName:"H" , LastName: "Rogers" }, BillAddress: { Name: "Default", Addr1: "Peter Pan LLC", Addr2: "45 Hart St", Addr3: "Suite 5", Addr4:"" , City: "NY", State: "NY", Zip: "00250", Email: "aaron@greenbay.com", }, PrimaryShipAddress: { Name: "Default", Addr1: "Peter Pan LLC", Addr2: "45 Hart St", Addr3: "Suite 5", City: "NY", State: "NY", Zip: "00250", Email: "aaron@greenbay.com" }, SalesTaxCodeRef: { Id: 3, Name: "Non" }, CustomFields: [ { Name: "CustomerCust1", Value: 8798, }, { Name: "CustomerCust2", Value: true, } ] }