GET api/supplier/{id}

Gets a supplier by id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters

None.

Remarks

None.

Example

None.

Response Information

Resource Description

SupplierResponse
NameDescriptionTypeAdditional information
Id

Id of the supplier

 globally unique identifier

None.
CreatedBy

User that has created the supplier

 string

None.
CreatedDate

Date and time when the supplier was created

 date

None.
ChangedBy

User that has updated the supplier

 string

None.
ChangedDate

Date and time when the supplier was updated

 date

None.
IsActive

If supplier is active or not

 boolean

None.
Name

Name of the supplier

 string

Max length: 50
CSID

Compilator supplier id

 integer

None.
SupplierNumber

Supplier number

 integer

None.
SupplierCategoryId1

Category 1 for supplier

 globally unique identifier

None.
SupplierCategoryId2

Category 2 for supplier

 globally unique identifier

None.
Phone

Phone number to the supplier

 string

Max length: 50
Mobile

Mobile number to the supplier

 string

Max length: 50
OrganisationNumber

Organisation number to the supplier

 string

Max length: 30
Town

Town

 string

Max length: 50
SearchCode

Search code for supplier

 string

Max length: 10
Email

Email to supplier

 string

Max length: 50
Fax

Fax number to the supplier

 string

Max length: 50
Address1

Address

 string

Max length: 100
Address2

Additional address line

 string

Max length: 100
Address3

Additional address line

 string

Max length: 100
PostalCode

Postal code

 string

Max length: 10
CountryId

Id for the country
Use api/countries to get all countries

 string

Max length: 2
Url

Url

 string

Max length: 100
VatRegistrationNumber

VAT identification number

 string

Max length: 50

Response Formats

application/json, text/json

Sample: 
{
  "Id": "a684fbbb-efc9-4caf-aac5-e88d590830b8",
  "CreatedBy": "sample string 2",
  "CreatedDate": "12/21/2025 1:08:58 PM",
  "ChangedBy": "sample string 3",
  "ChangedDate": "12/21/2025 1:08:58 PM",
  "IsActive": true,
  "Name": "sample string 5",
  "CSID": 1,
  "SupplierNumber": 1,
  "SupplierCategoryId1": "97499ad8-cd6e-4234-833f-84b35611b046",
  "SupplierCategoryId2": "ad7d2e3a-7fb6-4b99-bdd5-52307e6c00c9",
  "Phone": "sample string 6",
  "Mobile": "sample string 7",
  "OrganisationNumber": "sample string 8",
  "Town": "sample string 9",
  "SearchCode": "sample string 10",
  "Email": "sample string 11",
  "Fax": "sample string 12",
  "Address1": "sample string 13",
  "Address2": "sample string 14",
  "Address3": "sample string 15",
  "PostalCode": "sample string 16",
  "CountryId": "sample string 17",
  "Url": "sample string 18",
  "VatRegistrationNumber": "sample string 19"
}

application/xml, text/xml

Sample: 
<SupplierResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Supplier">
  <Address1>sample string 13</Address1>
  <Address2>sample string 14</Address2>
  <Address3>sample string 15</Address3>
  <CSID>1</CSID>
  <CountryId>sample string 17</CountryId>
  <Email>sample string 11</Email>
  <Fax>sample string 12</Fax>
  <Mobile>sample string 7</Mobile>
  <Name>sample string 5</Name>
  <OrganisationNumber>sample string 8</OrganisationNumber>
  <Phone>sample string 6</Phone>
  <PostalCode>sample string 16</PostalCode>
  <SearchCode>sample string 10</SearchCode>
  <SupplierCategoryId1>97499ad8-cd6e-4234-833f-84b35611b046</SupplierCategoryId1>
  <SupplierCategoryId2>ad7d2e3a-7fb6-4b99-bdd5-52307e6c00c9</SupplierCategoryId2>
  <SupplierNumber>1</SupplierNumber>
  <Town>sample string 9</Town>
  <Url>sample string 18</Url>
  <VatRegistrationNumber>sample string 19</VatRegistrationNumber>
  <ChangedBy>sample string 3</ChangedBy>
  <ChangedDate>2025-12-21T13:08:58.1096182+00:00</ChangedDate>
  <CreatedBy>sample string 2</CreatedBy>
  <CreatedDate>2025-12-21T13:08:58.1096182+00:00</CreatedDate>
  <Id>a684fbbb-efc9-4caf-aac5-e88d590830b8</Id>
  <IsActive>true</IsActive>
</SupplierResponse>