POST api/Lead/CreateLead
D365 API: Create Lead
Request Information
URI Parameters
None.
Body Parameters
LeadInformationName | Description | Type | Additional information |
---|---|---|---|
workItOut | WorkItOut |
None. |
|
pickAPlan | PickAPlan |
None. |
|
contactDetails | Contacts |
None. |
|
companyDetails | Company |
None. |
|
payrollInformation | PayrollInformation |
None. |
|
summary | Summary |
None. |
|
requestId | string |
None. |
|
isPartiallySubmitted | boolean |
None. |
|
isCharity | boolean |
None. |
|
converticsId | string |
None. |
|
convertics | Convertics |
None. |
Request Formats
application/json, text/json
Sample:
{ "workItOut": { "payruns": [ { "payCycle": 1, "employeeCount": 1 }, { "payCycle": 1, "employeeCount": 1 } ], "managePayCycles": 1, "otherProduct": { "name": "sample string 1", "id": "88880241-9a69-4ccf-a1dc-e118e88f36df" }, "manageHR": 1, "bankChoice": { "name": "sample string 1", "id": "88880241-9a69-4ccf-a1dc-e118e88f36df" }, "bankOther": "sample string 1", "payrollPlan": 1 }, "pickAPlan": { "chosenPlan": { "name": "sample string 1", "id": "88880241-9a69-4ccf-a1dc-e118e88f36df" }, "addSmartHr": true, "addPeopleManager": true }, "contactDetails": { "isAccountant": true, "isAdditionalPrimaryContact": true, "contact": { "firstName": "sample string 1", "lastName": "sample string 2", "jobTitle": 1, "jobOther": "sample string 3", "email": "sample string 4", "contactNumber": "sample string 5" }, "additionalContact": { "firstName": "sample string 1", "lastName": "sample string 2", "jobTitle": 1, "jobOther": "sample string 3", "email": "sample string 4", "contactNumber": "sample string 5" } }, "companyDetails": { "companyName": "sample string 1", "tradingName": "sample string 2", "irdNumber": "sample string 3", "industryType": { "name": "sample string 1", "id": "88880241-9a69-4ccf-a1dc-e118e88f36df" }, "businessAddress": { "isManual": true, "addressLine1": "sample string 2", "addressLine2": "sample string 3", "addressLine3": "sample string 4", "city": { "name": "sample string 1", "id": "88880241-9a69-4ccf-a1dc-e118e88f36df" }, "region": { "name": "sample string 1", "id": "88880241-9a69-4ccf-a1dc-e118e88f36df" }, "postCode": "sample string 5", "country": "sample string 6" }, "postalAddress": { "isManual": true, "addressLine1": "sample string 2", "addressLine2": "sample string 3", "addressLine3": "sample string 4", "city": { "name": "sample string 1", "id": "88880241-9a69-4ccf-a1dc-e118e88f36df" }, "region": { "name": "sample string 1", "id": "88880241-9a69-4ccf-a1dc-e118e88f36df" }, "postCode": "sample string 5", "country": "sample string 6" }, "postalSameAsBusiness": true, "charityNumber": "sample string 5", "accountant": { "name": "sample string 1", "id": "88880241-9a69-4ccf-a1dc-e118e88f36df" }, "accountantNotListed": true, "accountantBusinessName": "sample string 7", "accountantBusinessPhone": "sample string 8", "accountantHasAccessTo": 1, "accountantName": "sample string 9", "accountantWillPaySmartPayrollFees": true, "shouldAddToAccountantsUmbrellaPage": true, "umbrellaPageName": "sample string 12" }, "payrollInformation": { "bankAccountName": "sample string 1", "bankAccountNumber": "sample string 2", "authoriseDirectDebitMonthlyFees": true, "notAuthorisedButRequestDirectDebitAuthority": true, "processingPayroll": 1, "processingPayrollOther": "sample string 5", "payePaymentsToIRD": 1, "employeeAnnualLeaveRollover": 1, "averageGrossAmountPerPayRun": 6.1, "payrollProcessingStart": "sample string 7" }, "summary": { "additionalComments": "sample string 1", "howDidYouHearAboutUs": { "name": "sample string 1", "id": "88880241-9a69-4ccf-a1dc-e118e88f36df" }, "howDidYouHearAboutUsOther": "sample string 2", "promoCode": { "name": "sample string 1", "id": "88880241-9a69-4ccf-a1dc-e118e88f36df" }, "referralCode": "sample string 3", "sendMeInfomation": true }, "requestId": "sample string 1", "isPartiallySubmitted": true, "isCharity": true, "converticsId": "sample string 4", "convertics": { "ConverticsId": "sample string 1", "ConverticsFirstSeen": "2025-06-07T14:37:22.9192865+00:00", "ConverticsUserCountry": "sample string 2", "ConverticsOriginalSource": "sample string 3", "ConverticsOriginalMedium": "sample string 4", "ConverticsOriginalCampaign": "sample string 5", "ConverticsOriginalLandingURL": "sample string 6", "ConverticsLastSource": "sample string 7", "ConverticsLastMedium": "sample string 8", "ConverticsLastCampaign": "sample string 9", "ConverticsLastLandingURL": "sample string 10" } }
application/xml, text/xml
Sample:
<LeadInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartPayroll.Crm.WebApi.Models.ResponseClasses"> <companyDetails> <accountant> <id>88880241-9a69-4ccf-a1dc-e118e88f36df</id> <name>sample string 1</name> </accountant> <accountantBusinessName>sample string 7</accountantBusinessName> <accountantBusinessPhone>sample string 8</accountantBusinessPhone> <accountantHasAccessTo>1</accountantHasAccessTo> <accountantName>sample string 9</accountantName> <accountantNotListed>true</accountantNotListed> <accountantWillPaySmartPayrollFees>true</accountantWillPaySmartPayrollFees> <businessAddress> <addressLine1>sample string 2</addressLine1> <addressLine2>sample string 3</addressLine2> <addressLine3>sample string 4</addressLine3> <city> <id>88880241-9a69-4ccf-a1dc-e118e88f36df</id> <name>sample string 1</name> </city> <country>sample string 6</country> <isManual>true</isManual> <postCode>sample string 5</postCode> <region> <id>88880241-9a69-4ccf-a1dc-e118e88f36df</id> <name>sample string 1</name> </region> </businessAddress> <charityNumber>sample string 5</charityNumber> <companyName>sample string 1</companyName> <industryType> <id>88880241-9a69-4ccf-a1dc-e118e88f36df</id> <name>sample string 1</name> </industryType> <irdNumber>sample string 3</irdNumber> <postalAddress> <addressLine1>sample string 2</addressLine1> <addressLine2>sample string 3</addressLine2> <addressLine3>sample string 4</addressLine3> <city> <id>88880241-9a69-4ccf-a1dc-e118e88f36df</id> <name>sample string 1</name> </city> <country>sample string 6</country> <isManual>true</isManual> <postCode>sample string 5</postCode> <region> <id>88880241-9a69-4ccf-a1dc-e118e88f36df</id> <name>sample string 1</name> </region> </postalAddress> <postalSameAsBusiness>true</postalSameAsBusiness> <shouldAddToAccountantsUmbrellaPage>true</shouldAddToAccountantsUmbrellaPage> <tradingName>sample string 2</tradingName> <umbrellaPageName>sample string 12</umbrellaPageName> </companyDetails> <contactDetails> <additionalContact> <contactNumber>sample string 5</contactNumber> <email>sample string 4</email> <firstName>sample string 1</firstName> <jobOther>sample string 3</jobOther> <jobTitle>1</jobTitle> <lastName>sample string 2</lastName> </additionalContact> <contact> <contactNumber>sample string 5</contactNumber> <email>sample string 4</email> <firstName>sample string 1</firstName> <jobOther>sample string 3</jobOther> <jobTitle>1</jobTitle> <lastName>sample string 2</lastName> </contact> <isAccountant>true</isAccountant> <isAdditionalPrimaryContact>true</isAdditionalPrimaryContact> </contactDetails> <convertics> <ConverticsFirstSeen>2025-06-07T14:37:22.9192865+00:00</ConverticsFirstSeen> <ConverticsId>sample string 1</ConverticsId> <ConverticsLastCampaign>sample string 9</ConverticsLastCampaign> <ConverticsLastLandingURL>sample string 10</ConverticsLastLandingURL> <ConverticsLastMedium>sample string 8</ConverticsLastMedium> <ConverticsLastSource>sample string 7</ConverticsLastSource> <ConverticsOriginalCampaign>sample string 5</ConverticsOriginalCampaign> <ConverticsOriginalLandingURL>sample string 6</ConverticsOriginalLandingURL> <ConverticsOriginalMedium>sample string 4</ConverticsOriginalMedium> <ConverticsOriginalSource>sample string 3</ConverticsOriginalSource> <ConverticsUserCountry>sample string 2</ConverticsUserCountry> </convertics> <converticsId>sample string 4</converticsId> <isCharity>true</isCharity> <isPartiallySubmitted>true</isPartiallySubmitted> <payrollInformation> <authoriseDirectDebitMonthlyFees>true</authoriseDirectDebitMonthlyFees> <averageGrossAmountPerPayRun>6.1</averageGrossAmountPerPayRun> <bankAccountName>sample string 1</bankAccountName> <bankAccountNumber>sample string 2</bankAccountNumber> <employeeAnnualLeaveRollover>1</employeeAnnualLeaveRollover> <notAuthorisedButRequestDirectDebitAuthority>true</notAuthorisedButRequestDirectDebitAuthority> <payePaymentsToIRD>1</payePaymentsToIRD> <payrollProcessingStart>sample string 7</payrollProcessingStart> <processingPayroll>1</processingPayroll> <processingPayrollOther>sample string 5</processingPayrollOther> </payrollInformation> <pickAPlan> <addPeopleManager>true</addPeopleManager> <addSmartHr>true</addSmartHr> <chosenPlan> <id>88880241-9a69-4ccf-a1dc-e118e88f36df</id> <name>sample string 1</name> </chosenPlan> </pickAPlan> <requestId>sample string 1</requestId> <summary> <additionalComments>sample string 1</additionalComments> <howDidYouHearAboutUs> <id>88880241-9a69-4ccf-a1dc-e118e88f36df</id> <name>sample string 1</name> </howDidYouHearAboutUs> <howDidYouHearAboutUsOther>sample string 2</howDidYouHearAboutUsOther> <promoCode> <id>88880241-9a69-4ccf-a1dc-e118e88f36df</id> <name>sample string 1</name> </promoCode> <referralCode>sample string 3</referralCode> <sendMeInfomation>true</sendMeInfomation> </summary> <workItOut> <bankChoice> <id>88880241-9a69-4ccf-a1dc-e118e88f36df</id> <name>sample string 1</name> </bankChoice> <bankOther>sample string 1</bankOther> <manageHR>1</manageHR> <managePayCycles>1</managePayCycles> <otherProduct> <id>88880241-9a69-4ccf-a1dc-e118e88f36df</id> <name>sample string 1</name> </otherProduct> <payrollPlan>1</payrollPlan> <payruns> <PayRun> <employeeCount>1</employeeCount> <payCycle>1</payCycle> </PayRun> <PayRun> <employeeCount>1</employeeCount> <payCycle>1</payCycle> </PayRun> </payruns> </workItOut> </LeadInformation>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |