POST api/Contractor/SendInvite

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
ContractorId	Required while creating/updating the Contractor	integer	None.
FirstName	Required while creating/updating the Contractor	string	None.
LastName	Required while creating/updating the Contractor	string	None.
PreferredName		string	None.
TIN		string	None.
SSN		string	None.
EmailAddress	Required while creating/updating the Contractor	string	None.
ContractorDwollaId	Should set the value when we need to create a funding source or while updating the details in Dwolla	string	None.
IsDormant	Flag to indicate or set an account as dormant	boolean	None.
ReadyToProcess	Flag to indicate or set a contractor account is ready to process the payments	boolean	None.
AddressLine1	Address Line 1 of the Contractor	string	None.
AddressLine2	Address Line 2 of the Contractor	string	None.
City	City of the contractor	string	None.
ZipCode	ZipCode of the Contractor	string	None.
PhoneNumber	Phone Number of the contractor	string	None.
StateId	StateId of the contractor	integer	None.
StateName	StateName of the contractor	string	None.
CountryId	CountryId of the contractor	integer	None.
LstContractorDocument	Contians the list of documents mapped to the contractor	Collection of ContractorDocument	None.
FundingSourceId	Primary key of the funding Source	integer	None.
AccountName	Required while creating the funding source for a contractor	string	None.
AccountNumber	Required while creating the funding source for a contractor	string	None.
RoutingNumber	Required while creating the funding source for a contractor	string	None.
IsVerifiedUser	Required while creating the funding source for a contractor	boolean	None.
Type	Required while creating the funding source for a contractor	string	None.
FundingDwollaId	Id created in Dwolla for the contractor account details	string	None.
IsDefault	Flag to indicate the account is default	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "contractorId": 1,
  "firstName": "sample string 2",
  "lastName": "sample string 3",
  "preferredName": "sample string 4",
  "tin": "sample string 5",
  "ssn": "sample string 6",
  "emailAddress": "sample string 7",
  "contractorDwollaId": "sample string 8",
  "isDormant": true,
  "readyToProcess": true,
  "addressLine1": "sample string 11",
  "addressLine2": "sample string 12",
  "city": "sample string 13",
  "zipCode": "sample string 14",
  "phoneNumber": "sample string 15",
  "stateId": 1,
  "stateName": "sample string 16",
  "countryId": 1,
  "lstContractorDocument": [
    {
      "contractorDocumentId": 1,
      "contractorId": 2,
      "documentName": "sample string 3",
      "blobDocumentPath": "sample string 4"
    },
    {
      "contractorDocumentId": 1,
      "contractorId": 2,
      "documentName": "sample string 3",
      "blobDocumentPath": "sample string 4"
    }
  ],
  "fundingSourceId": 1,
  "accountName": "sample string 17",
  "accountNumber": "sample string 18",
  "routingNumber": "sample string 19",
  "isVerifiedUser": true,
  "type": "sample string 21",
  "fundingDwollaId": "sample string 22",
  "isDefault": true
}

text/html

Sample:

{"contractorId":1,"firstName":"sample string 2","lastName":"sample string 3","preferredName":"sample string 4","tin":"sample string 5","ssn":"sample string 6","emailAddress":"sample string 7","contractorDwollaId":"sample string 8","isDormant":true,"readyToProcess":true,"addressLine1":"sample string 11","addressLine2":"sample string 12","city":"sample string 13","zipCode":"sample string 14","phoneNumber":"sample string 15","stateId":1,"stateName":"sample string 16","countryId":1,"lstContractorDocument":[{"contractorDocumentId":1,"contractorId":2,"documentName":"sample string 3","blobDocumentPath":"sample string 4"},{"contractorDocumentId":1,"contractorId":2,"documentName":"sample string 3","blobDocumentPath":"sample string 4"}],"fundingSourceId":1,"accountName":"sample string 17","accountNumber":"sample string 18","routingNumber":"sample string 19","isVerifiedUser":true,"type":"sample string 21","fundingDwollaId":"sample string 22","isDefault":true}

application/xml, text/xml

Sample:

<Contractor xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CapApi.Models">
  <AccountName>sample string 17</AccountName>
  <AccountNumber>sample string 18</AccountNumber>
  <FundingDwollaId>sample string 22</FundingDwollaId>
  <FundingSourceId>1</FundingSourceId>
  <IsDefault>true</IsDefault>
  <IsVerifiedUser>true</IsVerifiedUser>
  <RoutingNumber>sample string 19</RoutingNumber>
  <Type>sample string 21</Type>
  <AddressLine1>sample string 11</AddressLine1>
  <AddressLine2>sample string 12</AddressLine2>
  <City>sample string 13</City>
  <ContractorDwollaId>sample string 8</ContractorDwollaId>
  <ContractorId>1</ContractorId>
  <CountryId>1</CountryId>
  <EmailAddress>sample string 7</EmailAddress>
  <FirstName>sample string 2</FirstName>
  <IsDormant>true</IsDormant>
  <LastName>sample string 3</LastName>
  <LstContractorDocument>
    <ContractorDocument>
      <BlobDocumentPath>sample string 4</BlobDocumentPath>
      <ContractorDocumentId>1</ContractorDocumentId>
      <ContractorId>2</ContractorId>
      <DocumentName>sample string 3</DocumentName>
    </ContractorDocument>
    <ContractorDocument>
      <BlobDocumentPath>sample string 4</BlobDocumentPath>
      <ContractorDocumentId>1</ContractorDocumentId>
      <ContractorId>2</ContractorId>
      <DocumentName>sample string 3</DocumentName>
    </ContractorDocument>
  </LstContractorDocument>
  <PhoneNumber>sample string 15</PhoneNumber>
  <PreferredName>sample string 4</PreferredName>
  <ReadyToProcess>true</ReadyToProcess>
  <SSN>sample string 6</SSN>
  <StateId>1</StateId>
  <StateName>sample string 16</StateName>
  <TIN>sample string 5</TIN>
  <ZipCode>sample string 14</ZipCode>
</Contractor>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	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.