POST api/v2/vendor

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
VendorID	integer	None.
VendorType	integer	None.
CompanyName	string	None.
VendorCode	string	None.
Location	string	None.
PrimaryContactName	string	None.
Phone	string	None.
Mobile	string	None.
Fax	string	None.
Email	string	None.
Website	string	None.
Address1	string	None.
Address2	string	None.
City	string	None.
County	string	None.
State	string	None.
Zip	string	None.
Country	string	None.
RemitAddress1	string	None.
RemitAddress2	string	None.
RemitCity	string	None.
RemitState	string	None.
RemitZip	string	None.
RemitCountry	string	None.
SameAsLocation	boolean	None.
VAcctNumber	string	None.
EIN	string	None.
StateTaxID	string	None.
VAcctTypeID	integer	None.
AcctTermsID	integer	None.
CreditLimit	decimal number	None.
CheckDisplayName	string	None.
PaymentTypesAccepted	integer	None.
Requires1099	boolean	None.
Type1099	integer	None.
BusinessLicense	string	None.
ContractorLicense	string	None.
EDDRequired	boolean	None.
EDDReported	boolean	None.
IsSoleProprietor	boolean	None.
SoleProprietorName	string	None.
SSN	string	None.
IsActive	boolean	None.
DBA	string	None.
CombinePayments	boolean	None.
InsuranceExempt	boolean	None.
ACHBankName	string	None.
ACHAccountNumber	string	None.
ACHRoutingNumber	string	None.
MaintenanceCompany	boolean	None.
Facebook	string	None.
Twitter	string	None.
LinkedIn	string	None.
IsDeleted	boolean	None.
DateCreated	date	None.
LastModified	date	None.
ActivityTypes	Collection of string	None.
MailMatrix	Collection of MailMatrix	None.
Insurance	Collection of Insurance	None.
Links	Collection of Link	None.

Request Formats

application/json, text/json

Sample:

{
  "VendorID": 1,
  "VendorType": 1,
  "CompanyName": "sample string 1",
  "VendorCode": "sample string 2",
  "Location": "sample string 3",
  "PrimaryContactName": "sample string 4",
  "Phone": "sample string 5",
  "Mobile": "sample string 6",
  "Fax": "sample string 7",
  "Email": "sample string 8",
  "Website": "sample string 9",
  "Address1": "sample string 10",
  "Address2": "sample string 11",
  "City": "sample string 12",
  "County": "sample string 13",
  "State": "sample string 14",
  "Zip": "sample string 15",
  "Country": "sample string 16",
  "RemitAddress1": "sample string 17",
  "RemitAddress2": "sample string 18",
  "RemitCity": "sample string 19",
  "RemitState": "sample string 20",
  "RemitZip": "sample string 21",
  "RemitCountry": "sample string 22",
  "SameAsLocation": true,
  "VAcctNumber": "sample string 23",
  "EIN": "sample string 24",
  "StateTaxID": "sample string 25",
  "VAcctTypeID": 1,
  "AcctTermsID": 1,
  "CreditLimit": 1.0,
  "CheckDisplayName": "sample string 26",
  "PaymentTypesAccepted": 1,
  "Requires1099": true,
  "Type1099": 1,
  "BusinessLicense": "sample string 27",
  "ContractorLicense": "sample string 28",
  "EDDRequired": true,
  "EDDReported": true,
  "IsSoleProprietor": true,
  "SoleProprietorName": "sample string 29",
  "SSN": "sample string 30",
  "IsActive": true,
  "DBA": "sample string 31",
  "CombinePayments": true,
  "InsuranceExempt": true,
  "ACHBankName": "sample string 32",
  "ACHAccountNumber": "sample string 33",
  "ACHRoutingNumber": "sample string 34",
  "MaintenanceCompany": true,
  "Facebook": "sample string 35",
  "Twitter": "sample string 36",
  "LinkedIn": "sample string 37",
  "IsDeleted": true,
  "DateCreated": "2025-05-20T10:19:00.1616109-07:00",
  "LastModified": "2025-05-20T10:19:00.1616109-07:00",
  "ActivityTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "MailMatrix": [
    {
      "MailingMatrixID": 1,
      "Correspondence": "sample string 2",
      "EnabledBitMask": 3,
      "DefaultBitMask": 4,
      "Fixed": true,
      "TemplateID": 6,
      "AllowOptOut": true,
      "MakeMailMandatory": true,
      "UserType": 9,
      "IsSet": true,
      "Mail": true,
      "Email": true,
      "RefID": 13
    },
    {
      "MailingMatrixID": 1,
      "Correspondence": "sample string 2",
      "EnabledBitMask": 3,
      "DefaultBitMask": 4,
      "Fixed": true,
      "TemplateID": 6,
      "AllowOptOut": true,
      "MakeMailMandatory": true,
      "UserType": 9,
      "IsSet": true,
      "Mail": true,
      "Email": true,
      "RefID": 13
    }
  ],
  "Insurance": [
    {
      "InsuranceID": 1,
      "Name": "sample string 2",
      "RefType": 0,
      "RefID": 3,
      "InsuranceCompany": "sample string 4",
      "PolicyNumber": "sample string 5",
      "BeginDate": "2025-05-20T10:19:00.1616109-07:00",
      "ExpirationDate": "2025-05-20T10:19:00.1616109-07:00",
      "Amount": 8.0,
      "Deductible": 9.0,
      "HoldPaymentsOnExpiration": true,
      "InsuranceTypeID": 11,
      "InsuranceType": "sample string 12",
      "Notes": "sample string 13",
      "AgentName": "sample string 14",
      "AgentCompanyName": "sample string 15",
      "Address1": "sample string 16",
      "Address2": "sample string 17",
      "City": "sample string 18",
      "State": "sample string 19",
      "ZipCode": "sample string 20",
      "Country": "sample string 21",
      "Phone": "sample string 22",
      "Fax": "sample string 23",
      "Cell": "sample string 24",
      "Email": "sample string 25",
      "MgmtCoAdditionalInsured": true,
      "Resale": true,
      "IsDeleted": true,
      "DateCreated": "2025-05-20T10:19:00.177727-07:00",
      "LastModified": "2025-05-20T10:19:00.177727-07:00"
    },
    {
      "InsuranceID": 1,
      "Name": "sample string 2",
      "RefType": 0,
      "RefID": 3,
      "InsuranceCompany": "sample string 4",
      "PolicyNumber": "sample string 5",
      "BeginDate": "2025-05-20T10:19:00.1616109-07:00",
      "ExpirationDate": "2025-05-20T10:19:00.1616109-07:00",
      "Amount": 8.0,
      "Deductible": 9.0,
      "HoldPaymentsOnExpiration": true,
      "InsuranceTypeID": 11,
      "InsuranceType": "sample string 12",
      "Notes": "sample string 13",
      "AgentName": "sample string 14",
      "AgentCompanyName": "sample string 15",
      "Address1": "sample string 16",
      "Address2": "sample string 17",
      "City": "sample string 18",
      "State": "sample string 19",
      "ZipCode": "sample string 20",
      "Country": "sample string 21",
      "Phone": "sample string 22",
      "Fax": "sample string 23",
      "Cell": "sample string 24",
      "Email": "sample string 25",
      "MgmtCoAdditionalInsured": true,
      "Resale": true,
      "IsDeleted": true,
      "DateCreated": "2025-05-20T10:19:00.177727-07:00",
      "LastModified": "2025-05-20T10:19:00.177727-07:00"
    }
  ],
  "Links": [
    {
      "rel": "sample string 1",
      "href": "sample string 2"
    },
    {
      "rel": "sample string 1",
      "href": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<Vendor xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaliberAPI">
  <ACHAccountNumber>sample string 33</ACHAccountNumber>
  <ACHBankName>sample string 32</ACHBankName>
  <ACHRoutingNumber>sample string 34</ACHRoutingNumber>
  <AcctTermsID>1</AcctTermsID>
  <ActivityTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ActivityTypes>
  <Address1>sample string 10</Address1>
  <Address2>sample string 11</Address2>
  <BusinessLicense>sample string 27</BusinessLicense>
  <CheckDisplayName>sample string 26</CheckDisplayName>
  <City>sample string 12</City>
  <CombinePayments>true</CombinePayments>
  <CompanyName>sample string 1</CompanyName>
  <ContractorLicense>sample string 28</ContractorLicense>
  <Country>sample string 16</Country>
  <County>sample string 13</County>
  <CreditLimit>1</CreditLimit>
  <DBA>sample string 31</DBA>
  <DateCreated>2025-05-20T10:19:00.1616109-07:00</DateCreated>
  <EDDReported>true</EDDReported>
  <EDDRequired>true</EDDRequired>
  <EIN>sample string 24</EIN>
  <Email>sample string 8</Email>
  <Facebook>sample string 35</Facebook>
  <Fax>sample string 7</Fax>
  <Insurance>
    <Insurance>
      <Address1>sample string 16</Address1>
      <Address2>sample string 17</Address2>
      <AgentCompanyName>sample string 15</AgentCompanyName>
      <AgentName>sample string 14</AgentName>
      <Amount>8</Amount>
      <BeginDate>2025-05-20T10:19:00.1616109-07:00</BeginDate>
      <Cell>sample string 24</Cell>
      <City>sample string 18</City>
      <Country>sample string 21</Country>
      <DateCreated>2025-05-20T10:19:00.177727-07:00</DateCreated>
      <Deductible>9</Deductible>
      <Email>sample string 25</Email>
      <ExpirationDate>2025-05-20T10:19:00.1616109-07:00</ExpirationDate>
      <Fax>sample string 23</Fax>
      <HoldPaymentsOnExpiration>true</HoldPaymentsOnExpiration>
      <InsuranceCompany>sample string 4</InsuranceCompany>
      <InsuranceID>1</InsuranceID>
      <InsuranceType>sample string 12</InsuranceType>
      <InsuranceTypeID>11</InsuranceTypeID>
      <IsDeleted>true</IsDeleted>
      <LastModified>2025-05-20T10:19:00.177727-07:00</LastModified>
      <MgmtCoAdditionalInsured>true</MgmtCoAdditionalInsured>
      <Name>sample string 2</Name>
      <Notes>sample string 13</Notes>
      <Phone>sample string 22</Phone>
      <PolicyNumber>sample string 5</PolicyNumber>
      <RefID>3</RefID>
      <RefType>Division</RefType>
      <Resale>true</Resale>
      <State>sample string 19</State>
      <ZipCode>sample string 20</ZipCode>
    </Insurance>
    <Insurance>
      <Address1>sample string 16</Address1>
      <Address2>sample string 17</Address2>
      <AgentCompanyName>sample string 15</AgentCompanyName>
      <AgentName>sample string 14</AgentName>
      <Amount>8</Amount>
      <BeginDate>2025-05-20T10:19:00.1616109-07:00</BeginDate>
      <Cell>sample string 24</Cell>
      <City>sample string 18</City>
      <Country>sample string 21</Country>
      <DateCreated>2025-05-20T10:19:00.177727-07:00</DateCreated>
      <Deductible>9</Deductible>
      <Email>sample string 25</Email>
      <ExpirationDate>2025-05-20T10:19:00.1616109-07:00</ExpirationDate>
      <Fax>sample string 23</Fax>
      <HoldPaymentsOnExpiration>true</HoldPaymentsOnExpiration>
      <InsuranceCompany>sample string 4</InsuranceCompany>
      <InsuranceID>1</InsuranceID>
      <InsuranceType>sample string 12</InsuranceType>
      <InsuranceTypeID>11</InsuranceTypeID>
      <IsDeleted>true</IsDeleted>
      <LastModified>2025-05-20T10:19:00.177727-07:00</LastModified>
      <MgmtCoAdditionalInsured>true</MgmtCoAdditionalInsured>
      <Name>sample string 2</Name>
      <Notes>sample string 13</Notes>
      <Phone>sample string 22</Phone>
      <PolicyNumber>sample string 5</PolicyNumber>
      <RefID>3</RefID>
      <RefType>Division</RefType>
      <Resale>true</Resale>
      <State>sample string 19</State>
      <ZipCode>sample string 20</ZipCode>
    </Insurance>
  </Insurance>
  <InsuranceExempt>true</InsuranceExempt>
  <IsActive>true</IsActive>
  <IsDeleted>true</IsDeleted>
  <IsSoleProprietor>true</IsSoleProprietor>
  <LastModified>2025-05-20T10:19:00.1616109-07:00</LastModified>
  <LinkedIn>sample string 37</LinkedIn>
  <Links>
    <Link>
      <href>sample string 2</href>
      <rel>sample string 1</rel>
    </Link>
    <Link>
      <href>sample string 2</href>
      <rel>sample string 1</rel>
    </Link>
  </Links>
  <Location>sample string 3</Location>
  <MailMatrix>
    <MailMatrix>
      <AllowOptOut>true</AllowOptOut>
      <Correspondence>sample string 2</Correspondence>
      <DefaultBitMask>4</DefaultBitMask>
      <Email>true</Email>
      <EnabledBitMask>3</EnabledBitMask>
      <Fixed>true</Fixed>
      <IsSet>true</IsSet>
      <Mail>true</Mail>
      <MailingMatrixID>1</MailingMatrixID>
      <MakeMailMandatory>true</MakeMailMandatory>
      <RefID>13</RefID>
      <TemplateID>6</TemplateID>
      <UserType>9</UserType>
    </MailMatrix>
    <MailMatrix>
      <AllowOptOut>true</AllowOptOut>
      <Correspondence>sample string 2</Correspondence>
      <DefaultBitMask>4</DefaultBitMask>
      <Email>true</Email>
      <EnabledBitMask>3</EnabledBitMask>
      <Fixed>true</Fixed>
      <IsSet>true</IsSet>
      <Mail>true</Mail>
      <MailingMatrixID>1</MailingMatrixID>
      <MakeMailMandatory>true</MakeMailMandatory>
      <RefID>13</RefID>
      <TemplateID>6</TemplateID>
      <UserType>9</UserType>
    </MailMatrix>
  </MailMatrix>
  <MaintenanceCompany>true</MaintenanceCompany>
  <Mobile>sample string 6</Mobile>
  <PaymentTypesAccepted>1</PaymentTypesAccepted>
  <Phone>sample string 5</Phone>
  <PrimaryContactName>sample string 4</PrimaryContactName>
  <RemitAddress1>sample string 17</RemitAddress1>
  <RemitAddress2>sample string 18</RemitAddress2>
  <RemitCity>sample string 19</RemitCity>
  <RemitCountry>sample string 22</RemitCountry>
  <RemitState>sample string 20</RemitState>
  <RemitZip>sample string 21</RemitZip>
  <Requires1099>true</Requires1099>
  <SSN>sample string 30</SSN>
  <SameAsLocation>true</SameAsLocation>
  <SoleProprietorName>sample string 29</SoleProprietorName>
  <State>sample string 14</State>
  <StateTaxID>sample string 25</StateTaxID>
  <Twitter>sample string 36</Twitter>
  <Type1099>1</Type1099>
  <VAcctNumber>sample string 23</VAcctNumber>
  <VAcctTypeID>1</VAcctTypeID>
  <VendorCode>sample string 2</VendorCode>
  <VendorID>1</VendorID>
  <VendorType>1</VendorType>
  <Website>sample string 9</Website>
  <Zip>sample string 15</Zip>
</Vendor>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Vendor'.

Response Information

Resource Description

Object

None.

Response Formats

application/json, text/json

Sample:

{}

application/xml, text/xml

Sample:

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />