Lead

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.

Properties

PropertyCaptionData TypeRequired
CompanyNameCompanyString (50)False
NameNameString (50)True
ParentSub ofString (50)False
TaxRegistrationNumberTax Reg. No.String (50)False
WebsiteWebsiteString (50)False
NoteNoteString (4000)False
SalesTaxCertificateResell NumberString (15)False
PrimaryContactPrimary ContactPersonFalse
IdIdInt32False
ClassRefClassEntityRefFalse
CurrencyRefCurrencyEntityRefFalse
DiscountRefDiscountEntityRefFalse
FOBRefFOBEntityRefFalse
ItemSalesTaxRefTax ItemEntityRefFalse
LeadStatusRef
Lead StatusEntityRef
False
PriceLevelRefPrice LevelEntityRefFalse
ProxyRefProxyEntityRefFalse
SalesRepRefSales RepEntityRefFalse
SalesTaxCodeRefTax CodeEntityRefFalse
ShipMethodRefShip MethodEntityRefFalse
TermRefTermsEntityRefFalse
TypeRefTypeEntityRefFalse
IsActiveActiveBooleanFalse
BillAddressBill AddressAddressFalse
PrimaryShipAddressPrimary Ship AddressAddressFalse
CustomFieldsCustom FieldsArray of CustomFieldDataFalse

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,
      }
     ]
}