GET v1/vendors/{id}

Gets vendor details by id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Provide vendor id to get details for

integer

Required

Body Parameters

None.

Response Information

Resource Description

Vendor
NameDescriptionTypeAdditional information
Id

integer

None.

Name

string

Required

Number

string

None.

IsCustomer

boolean

None.

IsConsumerAccount

boolean

None.

IsSubContractor

boolean

None.

EligibleFor1099

boolean

None.

EIN

string

None.

Status

IdNamePair

Required

Categories

This is required based on CRM Settings setup in the application

Collection of IdNamePair

None.

ReferralSource

This is required based on CRM Settings setup in the application

IdNamePair

None.

Industry

IdNamePair

None.

WebSite

string

Matching regular expression pattern: ^http(s?)\:\/\/[0-9a-zA-Z]([-.\w]*[0-9a-zA-Z])*(:(0-9)*)*(\/?)([a-zA-Z0-9\-\.\?\,\'\/\\\+&%\$#_!]*)?$

PaymentTerm

IdNamePair

None.

BillToLocation

IdNamePair

None.

ShipToLocation

IdNamePair

None.

Phones

Collection of Phone

None.

PrimaryAddress

Address

None.

CostList

Cost List

IdNamePair

None.

CustomFields

Collection of CustomField

None.

DateCreated

The date and time (in company time zone) when the vendor was created.

date

None.

CreatedBy

IdNamePair

None.

LastUpdatedDate

The date and time (in company time zone) when the vendor was last updated.

date

None.

LastUpdatedBy

IdNamePair

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "name": "sample string 2",
  "number": "sample string 3",
  "isCustomer": true,
  "isConsumerAccount": true,
  "isSubContractor": true,
  "eligibleFor1099": true,
  "ein": "sample string 8",
  "status": {
    "id": 1,
    "name": "sample string 2"
  },
  "categories": [
    {
      "id": 1,
      "name": "sample string 2"
    },
    {
      "id": 1,
      "name": "sample string 2"
    }
  ],
  "referralSource": {
    "id": 1,
    "name": "sample string 2"
  },
  "industry": {
    "id": 1,
    "name": "sample string 2"
  },
  "webSite": "sample string 9",
  "paymentTerm": {
    "id": 1,
    "name": "sample string 2"
  },
  "billToLocation": {
    "id": 1,
    "name": "sample string 2"
  },
  "shipToLocation": {
    "id": 1,
    "name": "sample string 2"
  },
  "phones": [
    {
      "id": 1,
      "phoneType": {
        "id": 1,
        "name": "sample string 2"
      },
      "countryDialCode": 2,
      "number": "sample string 3",
      "extension": "sample string 4",
      "isPreferred": true,
      "active": true
    },
    {
      "id": 1,
      "phoneType": {
        "id": 1,
        "name": "sample string 2"
      },
      "countryDialCode": 2,
      "number": "sample string 3",
      "extension": "sample string 4",
      "isPreferred": true,
      "active": true
    }
  ],
  "primaryAddress": {
    "address1": "sample string 1",
    "address2": "sample string 2",
    "address3": "sample string 3",
    "city": "sample string 4",
    "state": "sample string 5",
    "postalCode": "sample string 6",
    "country": "sample string 7",
    "latitude": 8.0,
    "longitude": 9.0,
    "fullAddress": "sample string 10"
  },
  "costList": {
    "id": 1,
    "name": "sample string 2"
  },
  "customFields": [
    {
      "id": 1,
      "name": "sample string 2",
      "fieldType": {
        "id": 1,
        "name": "sample string 2"
      },
      "sourceId": 3,
      "value": "sample string 4",
      "valueText": "sample string 5",
      "isRequired": true
    },
    {
      "id": 1,
      "name": "sample string 2",
      "fieldType": {
        "id": 1,
        "name": "sample string 2"
      },
      "sourceId": 3,
      "value": "sample string 4",
      "valueText": "sample string 5",
      "isRequired": true
    }
  ],
  "dateCreated": "2022-07-06T12:19:15.2002926-04:00",
  "createdBy": {
    "id": 1,
    "name": "sample string 2"
  },
  "lastUpdatedDate": "2022-07-06T12:19:15.2002926-04:00",
  "lastUpdatedBy": {
    "id": 1,
    "name": "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/BAPI.Models.CRM">
  <BillToLocation xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </BillToLocation>
  <Categories xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:IdNamePair>
      <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
      <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
    </d2p1:IdNamePair>
    <d2p1:IdNamePair>
      <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
      <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
    </d2p1:IdNamePair>
  </Categories>
  <CostList xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </CostList>
  <CreatedBy xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </CreatedBy>
  <CustomFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
    <d2p1:CustomField>
      <d2p1:FieldType xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:FieldType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsRequired>true</d2p1:IsRequired>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:SourceId>3</d2p1:SourceId>
      <d2p1:Value>sample string 4</d2p1:Value>
      <d2p1:ValueText>sample string 5</d2p1:ValueText>
    </d2p1:CustomField>
    <d2p1:CustomField>
      <d2p1:FieldType xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:FieldType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsRequired>true</d2p1:IsRequired>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:SourceId>3</d2p1:SourceId>
      <d2p1:Value>sample string 4</d2p1:Value>
      <d2p1:ValueText>sample string 5</d2p1:ValueText>
    </d2p1:CustomField>
  </CustomFields>
  <DateCreated>2022-07-06T12:19:15.2002926-04:00</DateCreated>
  <EIN>sample string 8</EIN>
  <EligibleFor1099>true</EligibleFor1099>
  <Id>1</Id>
  <Industry xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </Industry>
  <IsConsumerAccount>true</IsConsumerAccount>
  <IsCustomer>true</IsCustomer>
  <IsSubContractor>true</IsSubContractor>
  <LastUpdatedBy xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </LastUpdatedBy>
  <LastUpdatedDate>2022-07-06T12:19:15.2002926-04:00</LastUpdatedDate>
  <Name>sample string 2</Name>
  <Number>sample string 3</Number>
  <PaymentTerm xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </PaymentTerm>
  <Phones xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
    <d2p1:Phone>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:CountryDialCode>2</d2p1:CountryDialCode>
      <d2p1:Extension>sample string 4</d2p1:Extension>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsPreferred>true</d2p1:IsPreferred>
      <d2p1:Number>sample string 3</d2p1:Number>
      <d2p1:PhoneType xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:PhoneType>
    </d2p1:Phone>
    <d2p1:Phone>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:CountryDialCode>2</d2p1:CountryDialCode>
      <d2p1:Extension>sample string 4</d2p1:Extension>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsPreferred>true</d2p1:IsPreferred>
      <d2p1:Number>sample string 3</d2p1:Number>
      <d2p1:PhoneType xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:PhoneType>
    </d2p1:Phone>
  </Phones>
  <PrimaryAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
    <d2p1:Address1>sample string 1</d2p1:Address1>
    <d2p1:Address2>sample string 2</d2p1:Address2>
    <d2p1:Address3>sample string 3</d2p1:Address3>
    <d2p1:City>sample string 4</d2p1:City>
    <d2p1:Country>sample string 7</d2p1:Country>
    <d2p1:FullAddress>sample string 10</d2p1:FullAddress>
    <d2p1:Latitude>8</d2p1:Latitude>
    <d2p1:Longitude>9</d2p1:Longitude>
    <d2p1:PostalCode>sample string 6</d2p1:PostalCode>
    <d2p1:State>sample string 5</d2p1:State>
  </PrimaryAddress>
  <ReferralSource xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </ReferralSource>
  <ShipToLocation xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </ShipToLocation>
  <Status xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </Status>
  <WebSite>sample string 9</WebSite>
</Vendor>