POST api/v1/portals/{portalUid}/companies/{companyUid}/customer/import/requirements

Request Information

URI Parameters

Name	Description	Type	Additional information
portalUid		globally unique identifier	Required
companyUid		globally unique identifier	Required

Body Parameters

Requirement

Name	Description	Type	Additional information
RefNo	Vacnacy or placement reference number, if any	string	None.
Client	The client name or reference	string	None.
ClientGuid	The client guid	globally unique identifier	None.
ClientContact	The client contact name or reference number	string	None.
ClientContactGuid	The client contact guid	globally unique identifier	None.
ClientSite	The client site name or reference number	string	None.
ClientSiteGuid	The client site guid	globally unique identifier	None.
Candidate	The candidate name or reference number	string	None.
CandidateGuid	The candidate guid	globally unique identifier	None.
JobTitle	The vacnacy job title	string	None.
Industry	The industry name or reference number	string	None.
IndustryGuid	The industry guid	globally unique identifier	None.
Discipline	The discipline name	string	None.
DisciplineGuid	The discipline guid	globally unique identifier	None.
Consultant1	The first consultant name	string	None.
Consultant1Guid	The first consultant guid	globally unique identifier	None.
Consultant1Split	The first consultant split	decimal number	None.
Consultant2	The second consultant name	string	None.
Consultant2Guid	The second consultant guid	globally unique identifier	None.
Consultant2Split	The second consultant split	decimal number	None.
Consultant3	The third consultant name	string	None.
Consultant3Guid	The third consultant guid	globally unique identifier	None.
Consultant3Split	The third consultant split	decimal number	None.
Division	The default division	string	None.
PONumber	The po number to use	string	None.
StartDate	The start date of the rquirements	date	None.
EndDate	The end date of the requirements	date	None.
StartTime	The start time of the requirement	date	None.
EndTime	The end time of the requirement	date	None.
RateTemplate	The rate template to use	string	None.
RateName	The rate to use	string	None.
Pay	The pay value to use	decimal number	None.
Invoice	The invoice value to use	decimal number	None.
Units	The total number of units per requirement	decimal number	None.
IsPAYE	Is the the rate for PAYE	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "RefNo": "sample string 1",
  "Client": "sample string 2",
  "ClientGuid": "340b9d9a-3617-4e89-bb8e-df207f317383",
  "ClientContact": "sample string 3",
  "ClientContactGuid": "98cbd346-bcf2-4dd1-883f-af9a7242dab6",
  "ClientSite": "sample string 4",
  "ClientSiteGuid": "22dd7040-81aa-41b0-95cc-4714e8ceaaeb",
  "Candidate": "sample string 5",
  "CandidateGuid": "a99d35fd-3344-4a6f-adae-3c3414050b68",
  "JobTitle": "sample string 6",
  "Industry": "sample string 7",
  "IndustryGuid": "802ac669-e3c9-47f6-b03f-c221921fdcaa",
  "Discipline": "sample string 8",
  "DisciplineGuid": "83582d86-5fbb-4551-85d8-a17b534a53fe",
  "Consultant1": "sample string 9",
  "Consultant1Guid": "f2f9b38a-eb1b-463a-adf3-ab5538b87a2c",
  "Consultant1Split": 1.1,
  "Consultant2": "sample string 10",
  "Consultant2Guid": "36a1c0e8-7e84-4ca7-82c8-751b412e22b1",
  "Consultant2Split": 1.1,
  "Consultant3": "sample string 11",
  "Consultant3Guid": "9b4d2f98-75b2-4e5e-b827-dfd7b6585e51",
  "Consultant3Split": 1.1,
  "Division": "sample string 12",
  "PONumber": "sample string 13",
  "StartDate": "2025-12-21T17:58:24.1710231+00:00",
  "EndDate": "2025-12-21T17:58:24.1710231+00:00",
  "StartTime": "2025-12-21T17:58:24.1710231+00:00",
  "EndTime": "2025-12-21T17:58:24.1710231+00:00",
  "RateTemplate": "sample string 14",
  "RateName": "sample string 15",
  "Pay": 1.1,
  "Invoice": 1.1,
  "Units": 1.1,
  "IsPAYE": true
}

application/xml, text/xml

Sample:

<Requirement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
  <Candidate>sample string 5</Candidate>
  <CandidateGuid>a99d35fd-3344-4a6f-adae-3c3414050b68</CandidateGuid>
  <Client>sample string 2</Client>
  <ClientContact>sample string 3</ClientContact>
  <ClientContactGuid>98cbd346-bcf2-4dd1-883f-af9a7242dab6</ClientContactGuid>
  <ClientGuid>340b9d9a-3617-4e89-bb8e-df207f317383</ClientGuid>
  <ClientSite>sample string 4</ClientSite>
  <ClientSiteGuid>22dd7040-81aa-41b0-95cc-4714e8ceaaeb</ClientSiteGuid>
  <Consultant1>sample string 9</Consultant1>
  <Consultant1Guid>f2f9b38a-eb1b-463a-adf3-ab5538b87a2c</Consultant1Guid>
  <Consultant1Split>1.1</Consultant1Split>
  <Consultant2>sample string 10</Consultant2>
  <Consultant2Guid>36a1c0e8-7e84-4ca7-82c8-751b412e22b1</Consultant2Guid>
  <Consultant2Split>1.1</Consultant2Split>
  <Consultant3>sample string 11</Consultant3>
  <Consultant3Guid>9b4d2f98-75b2-4e5e-b827-dfd7b6585e51</Consultant3Guid>
  <Consultant3Split>1.1</Consultant3Split>
  <Discipline>sample string 8</Discipline>
  <DisciplineGuid>83582d86-5fbb-4551-85d8-a17b534a53fe</DisciplineGuid>
  <Division>sample string 12</Division>
  <EndDate>2025-12-21T17:58:24.1710231+00:00</EndDate>
  <EndTime>2025-12-21T17:58:24.1710231+00:00</EndTime>
  <Industry>sample string 7</Industry>
  <IndustryGuid>802ac669-e3c9-47f6-b03f-c221921fdcaa</IndustryGuid>
  <Invoice>1.1</Invoice>
  <IsPAYE>true</IsPAYE>
  <JobTitle>sample string 6</JobTitle>
  <PONumber>sample string 13</PONumber>
  <Pay>1.1</Pay>
  <RateName>sample string 15</RateName>
  <RateTemplate>sample string 14</RateTemplate>
  <RefNo>sample string 1</RefNo>
  <StartDate>2025-12-21T17:58:24.1710231+00:00</StartDate>
  <StartTime>2025-12-21T17:58:24.1710231+00:00</StartTime>
  <Units>1.1</Units>
</Requirement>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RequirementImportViewModel

Name	Description	Type	Additional information
Guid	Static generated guid	globally unique identifier	None.
RefNo	Vacnacy or placement reference number, if any	string	None.
VacancyOriginalId	The found vacancy id	integer	None.
PlacementOriginalId	The found placement id	integer	None.
Client	The client name or reference	string	None.
ClientGuid	The client guid	globally unique identifier	None.
ClientOriginalId	The clients original id	integer	None.
ClientContact	The client contact name or reference number	string	None.
ClientContactGuid	The client contact guid	globally unique identifier	None.
ClientContactOriginalId	The client contact original id	integer	None.
ClientSite	The client site name or reference number	string	None.
ClientSiteGuid	The client site guid	globally unique identifier	None.
ClientSiteOriginalId	The client sites original id	integer	None.
Candidate	The candidate name or reference number	string	None.
CandidateGuid	The candidate guid	globally unique identifier	None.
CandidateOriginalId	The candidates original id	integer	None.
JobTitle	The vacnacy job title	string	None.
Industry	The industry name or reference number	string	None.
IndustryGuid	The industry guid	globally unique identifier	None.
IndustryOriginalId	The original industry id	integer	None.
Discipline	The discipline name	string	None.
DisciplineGuid	The discipline guid	globally unique identifier	None.
DisciplineOriginalId	The discipline original id	integer	None.
Consultant1	The first consultant name	string	None.
Consultant1Guid	The first consultant guid	globally unique identifier	None.
Consultant1OriginalId	The first consultant original id	integer	None.
Consultant1Split	The first consultant split	decimal number	None.
Consultant2	The second consultant name	string	None.
Consultant2Guid	The second consultant guid	globally unique identifier	None.
Consultant2OriginalId	The second consultant original id	integer	None.
Consultant2Split	The second consultant split	decimal number	None.
Consultant3	The third consultant name	string	None.
Consultant3Guid	The third consultant guid	globally unique identifier	None.
Consultant3OriginalId	The third consultant original id	integer	None.
Consultant3Split	The third consultant split	decimal number	None.
Division	The default division	string	None.
PONumber	The po number to use	string	None.
StartDate	The start date of the rquirements	date	None.
EndDate	The end date of the requirements	date	None.
StartTime	The start time of the requirement	date	None.
EndTime	The end time of the requirement	date	None.
RateTemplate	The rate template to use	string	None.
RateName	The rate to use	string	None.
Pay	The pay value to use	decimal number	None.
Invoice	The invoice value to use	decimal number	None.
Units	The total number of units per requirement	decimal number	None.
IsPAYE	Is the the rate for PAYE	boolean	None.
IsRateUpdate	Should we perform a rate update	boolean	None.
CompanyGuid	Company to create the requirements in	globally unique identifier	None.
CompanyOriginalId	The original company id	integer	None.
UploadedBy	Who uploaded the request	string	None.
UploadedByGuid	Guid of the uploader	globally unique identifier	None.
UploadedByOriginalId	The id of the original uploader	integer	None.
UploadedDate	Date the request was uploaded	date	None.
IsProcessed	Has the request been processed	boolean	None.
ProcessedDate	Date the request was processed	date	None.
IsError	Did the processing result in an error	boolean	None.
ErrorReason	If is error, this is the error description	string	None.
GeneratedVacancyRefNo	If a vacancy was processed this is the reference number	string	None.
GeneratedVacancyOriginalId	The original id of the generated vacancy	integer	None.
GeneratedPlacementRefNo	If a placement was generated this is the reference number	string	None.
GeneratedPlacementOriginalId	The original id of the generated placement	integer	None.
Uid	The GUID.	globally unique identifier	None.
Links	The links.	Collection of Link	None.
DateUpdated	Last time the record was updated	date	None.
UpdatedBy	Who updated the record last	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Guid": "e049ec7f-9c45-4612-ad29-81ae6f1bb5d0",
  "RefNo": "sample string 2",
  "VacancyOriginalId": 1,
  "PlacementOriginalId": 1,
  "Client": "sample string 3",
  "ClientGuid": "eb44b662-4ee3-4cdf-b85e-c3c63dbe451e",
  "ClientOriginalId": 1,
  "ClientContact": "sample string 4",
  "ClientContactGuid": "47ab2d4e-6228-4af6-8ca3-331e395ab7dd",
  "ClientContactOriginalId": 1,
  "ClientSite": "sample string 5",
  "ClientSiteGuid": "0c926881-af23-4752-babc-a292a78c135e",
  "ClientSiteOriginalId": 1,
  "Candidate": "sample string 6",
  "CandidateGuid": "367ca1a6-b087-4808-a85e-d0b9c3095310",
  "CandidateOriginalId": 1,
  "JobTitle": "sample string 7",
  "Industry": "sample string 8",
  "IndustryGuid": "9739cf7c-dd13-4b75-ac2c-c1b40c3899f0",
  "IndustryOriginalId": 1,
  "Discipline": "sample string 9",
  "DisciplineGuid": "f583d1b4-ccc0-49ed-9343-eece9fe1b067",
  "DisciplineOriginalId": 1,
  "Consultant1": "sample string 10",
  "Consultant1Guid": "a09b6156-d787-4fbb-933d-94db0ea00569",
  "Consultant1OriginalId": 1,
  "Consultant1Split": 1.1,
  "Consultant2": "sample string 11",
  "Consultant2Guid": "b70aa0f5-b817-44af-b636-e29d7cab2814",
  "Consultant2OriginalId": 1,
  "Consultant2Split": 1.1,
  "Consultant3": "sample string 12",
  "Consultant3Guid": "e6f7cd58-3dfb-441b-8fd3-898df84910b6",
  "Consultant3OriginalId": 1,
  "Consultant3Split": 1.1,
  "Division": "sample string 13",
  "PONumber": "sample string 14",
  "StartDate": "2025-12-21T17:58:24.2022492+00:00",
  "EndDate": "2025-12-21T17:58:24.2022492+00:00",
  "StartTime": "2025-12-21T17:58:24.2022492+00:00",
  "EndTime": "2025-12-21T17:58:24.2022492+00:00",
  "RateTemplate": "sample string 15",
  "RateName": "sample string 16",
  "Pay": 1.1,
  "Invoice": 1.1,
  "Units": 1.1,
  "IsPAYE": true,
  "IsRateUpdate": true,
  "CompanyGuid": "e6507d9b-f29f-4713-811e-28780934c545",
  "CompanyOriginalId": 1,
  "UploadedBy": "sample string 20",
  "UploadedByGuid": "287acce1-800d-4f26-a63f-174f1c0f725e",
  "UploadedByOriginalId": 1,
  "UploadedDate": "2025-12-21T17:58:24.2022492+00:00",
  "IsProcessed": true,
  "ProcessedDate": "2025-12-21T17:58:24.2022492+00:00",
  "IsError": true,
  "ErrorReason": "sample string 24",
  "GeneratedVacancyRefNo": "sample string 25",
  "GeneratedVacancyOriginalId": 1,
  "GeneratedPlacementRefNo": "sample string 26",
  "GeneratedPlacementOriginalId": 1,
  "Uid": "9ae9a643-4e52-4d81-add7-d83986e6db22",
  "Links": [
    {
      "Href": "http://webapihelppage1.com",
      "Method": "sample string 2",
      "Rel": "sample string 3",
      "Title": "sample string 4",
      "Type": "sample string 5"
    },
    {
      "Href": "http://webapihelppage1.com",
      "Method": "sample string 2",
      "Rel": "sample string 3",
      "Title": "sample string 4",
      "Type": "sample string 5"
    }
  ],
  "DateUpdated": "2025-12-21T17:58:24.2022492+00:00",
  "UpdatedBy": "sample string 28"
}

application/xml, text/xml

Sample:

<RequirementImportViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
  <DateUpdated>2025-12-21T17:58:24.2022492+00:00</DateUpdated>
  <Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
    <d2p1:Link>
      <d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
      <d2p1:Method>sample string 2</d2p1:Method>
      <d2p1:Rel>sample string 3</d2p1:Rel>
      <d2p1:Title>sample string 4</d2p1:Title>
      <d2p1:Type>sample string 5</d2p1:Type>
    </d2p1:Link>
    <d2p1:Link>
      <d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
      <d2p1:Method>sample string 2</d2p1:Method>
      <d2p1:Rel>sample string 3</d2p1:Rel>
      <d2p1:Title>sample string 4</d2p1:Title>
      <d2p1:Type>sample string 5</d2p1:Type>
    </d2p1:Link>
  </Links>
  <Uid>9ae9a643-4e52-4d81-add7-d83986e6db22</Uid>
  <UpdatedBy>sample string 28</UpdatedBy>
  <Candidate>sample string 6</Candidate>
  <CandidateGuid>367ca1a6-b087-4808-a85e-d0b9c3095310</CandidateGuid>
  <CandidateOriginalId>1</CandidateOriginalId>
  <Client>sample string 3</Client>
  <ClientContact>sample string 4</ClientContact>
  <ClientContactGuid>47ab2d4e-6228-4af6-8ca3-331e395ab7dd</ClientContactGuid>
  <ClientContactOriginalId>1</ClientContactOriginalId>
  <ClientGuid>eb44b662-4ee3-4cdf-b85e-c3c63dbe451e</ClientGuid>
  <ClientOriginalId>1</ClientOriginalId>
  <ClientSite>sample string 5</ClientSite>
  <ClientSiteGuid>0c926881-af23-4752-babc-a292a78c135e</ClientSiteGuid>
  <ClientSiteOriginalId>1</ClientSiteOriginalId>
  <CompanyGuid>e6507d9b-f29f-4713-811e-28780934c545</CompanyGuid>
  <CompanyOriginalId>1</CompanyOriginalId>
  <Consultant1>sample string 10</Consultant1>
  <Consultant1Guid>a09b6156-d787-4fbb-933d-94db0ea00569</Consultant1Guid>
  <Consultant1OriginalId>1</Consultant1OriginalId>
  <Consultant1Split>1.1</Consultant1Split>
  <Consultant2>sample string 11</Consultant2>
  <Consultant2Guid>b70aa0f5-b817-44af-b636-e29d7cab2814</Consultant2Guid>
  <Consultant2OriginalId>1</Consultant2OriginalId>
  <Consultant2Split>1.1</Consultant2Split>
  <Consultant3>sample string 12</Consultant3>
  <Consultant3Guid>e6f7cd58-3dfb-441b-8fd3-898df84910b6</Consultant3Guid>
  <Consultant3OriginalId>1</Consultant3OriginalId>
  <Consultant3Split>1.1</Consultant3Split>
  <Discipline>sample string 9</Discipline>
  <DisciplineGuid>f583d1b4-ccc0-49ed-9343-eece9fe1b067</DisciplineGuid>
  <DisciplineOriginalId>1</DisciplineOriginalId>
  <Division>sample string 13</Division>
  <EndDate>2025-12-21T17:58:24.2022492+00:00</EndDate>
  <EndTime>2025-12-21T17:58:24.2022492+00:00</EndTime>
  <ErrorReason>sample string 24</ErrorReason>
  <GeneratedPlacementOriginalId>1</GeneratedPlacementOriginalId>
  <GeneratedPlacementRefNo>sample string 26</GeneratedPlacementRefNo>
  <GeneratedVacancyOriginalId>1</GeneratedVacancyOriginalId>
  <GeneratedVacancyRefNo>sample string 25</GeneratedVacancyRefNo>
  <Guid>e049ec7f-9c45-4612-ad29-81ae6f1bb5d0</Guid>
  <Industry>sample string 8</Industry>
  <IndustryGuid>9739cf7c-dd13-4b75-ac2c-c1b40c3899f0</IndustryGuid>
  <IndustryOriginalId>1</IndustryOriginalId>
  <Invoice>1.1</Invoice>
  <IsError>true</IsError>
  <IsPAYE>true</IsPAYE>
  <IsProcessed>true</IsProcessed>
  <IsRateUpdate>true</IsRateUpdate>
  <JobTitle>sample string 7</JobTitle>
  <PONumber>sample string 14</PONumber>
  <Pay>1.1</Pay>
  <PlacementOriginalId>1</PlacementOriginalId>
  <ProcessedDate>2025-12-21T17:58:24.2022492+00:00</ProcessedDate>
  <RateName>sample string 16</RateName>
  <RateTemplate>sample string 15</RateTemplate>
  <RefNo>sample string 2</RefNo>
  <StartDate>2025-12-21T17:58:24.2022492+00:00</StartDate>
  <StartTime>2025-12-21T17:58:24.2022492+00:00</StartTime>
  <Units>1.1</Units>
  <UploadedBy>sample string 20</UploadedBy>
  <UploadedByGuid>287acce1-800d-4f26-a63f-174f1c0f725e</UploadedByGuid>
  <UploadedByOriginalId>1</UploadedByOriginalId>
  <UploadedDate>2025-12-21T17:58:24.2022492+00:00</UploadedDate>
  <VacancyOriginalId>1</VacancyOriginalId>
</RequirementImportViewModel>