Lead

Lead Object

The Lead  is a primary record type in Order Time.  

• End Point
• Properties
• Json Sample

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

PUT:    E.g  /lead/ConvertToCustomer?id=3.  The paramater id is the Id of the Lead (Int32). 

Properties

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