GET api/portal/suppliers?TypeID={TypeID}

Load supplier records

Request Information

URI Parameters

Name	Description	Type	Additional information
TypeID		integer	Default value is -1

Body Parameters

None.

Response Information

Resource Description

Collection of IBMS_Cloud_API.SupplierModel+AddSupplierFields

Name	Type	Additional information
SupplierID	integer	None.
Reference	string	None.
SupplierName	string	None.
AccRef	string	None.
AddressLine1	string	None.
AddressLine2	string	None.
AddressLine3	string	None.
County	string	None.
CityTown	string	None.
Postcode	string	None.
PhoneNumber	string	None.
Email	string	None.
WebSiteURL	string	None.
Status	string	None.
PaymentTerms	string	None.
PaymentMethod	string	None.
Approved	boolean	None.
ApprovalExpired	string	None.
Type	string	None.
AccountNumber	string	None.
StatusLabel	string	None.
StatusID	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "SupplierID": 1,
    "Reference": "sample string 2",
    "SupplierName": "sample string 3",
    "AccRef": "sample string 4",
    "AddressLine1": "sample string 5",
    "AddressLine2": "sample string 6",
    "AddressLine3": "sample string 7",
    "County": "sample string 8",
    "CityTown": "sample string 9",
    "Postcode": "sample string 10",
    "PhoneNumber": "sample string 11",
    "Email": "sample string 12",
    "WebSiteURL": "sample string 13",
    "Status": "sample string 14",
    "PaymentTerms": "sample string 15",
    "PaymentMethod": "sample string 16",
    "Approved": true,
    "ApprovalExpired": "sample string 18",
    "Type": "sample string 19",
    "AccountNumber": "sample string 20",
    "StatusLabel": "sample string 21",
    "StatusID": 22
  },
  {
    "SupplierID": 1,
    "Reference": "sample string 2",
    "SupplierName": "sample string 3",
    "AccRef": "sample string 4",
    "AddressLine1": "sample string 5",
    "AddressLine2": "sample string 6",
    "AddressLine3": "sample string 7",
    "County": "sample string 8",
    "CityTown": "sample string 9",
    "Postcode": "sample string 10",
    "PhoneNumber": "sample string 11",
    "Email": "sample string 12",
    "WebSiteURL": "sample string 13",
    "Status": "sample string 14",
    "PaymentTerms": "sample string 15",
    "PaymentMethod": "sample string 16",
    "Approved": true,
    "ApprovalExpired": "sample string 18",
    "Type": "sample string 19",
    "AccountNumber": "sample string 20",
    "StatusLabel": "sample string 21",
    "StatusID": 22
  }
]

text/html

Sample:

[{"SupplierID":1,"Reference":"sample string 2","SupplierName":"sample string 3","AccRef":"sample string 4","AddressLine1":"sample string 5","AddressLine2":"sample string 6","AddressLine3":"sample string 7","County":"sample string 8","CityTown":"sample string 9","Postcode":"sample string 10","PhoneNumber":"sample string 11","Email":"sample string 12","WebSiteURL":"sample string 13","Status":"sample string 14","PaymentTerms":"sample string 15","PaymentMethod":"sample string 16","Approved":true,"ApprovalExpired":"sample string 18","Type":"sample string 19","AccountNumber":"sample string 20","StatusLabel":"sample string 21","StatusID":22},{"SupplierID":1,"Reference":"sample string 2","SupplierName":"sample string 3","AccRef":"sample string 4","AddressLine1":"sample string 5","AddressLine2":"sample string 6","AddressLine3":"sample string 7","County":"sample string 8","CityTown":"sample string 9","Postcode":"sample string 10","PhoneNumber":"sample string 11","Email":"sample string 12","WebSiteURL":"sample string 13","Status":"sample string 14","PaymentTerms":"sample string 15","PaymentMethod":"sample string 16","Approved":true,"ApprovalExpired":"sample string 18","Type":"sample string 19","AccountNumber":"sample string 20","StatusLabel":"sample string 21","StatusID":22}]

application/xml, text/xml

Sample:

<ArrayOfSupplierModel.AddSupplierFields xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IBMS_Cloud_API">
  <SupplierModel.AddSupplierFields>
    <AccRef>sample string 4</AccRef>
    <AccountNumber>sample string 20</AccountNumber>
    <AddressLine1>sample string 5</AddressLine1>
    <AddressLine2>sample string 6</AddressLine2>
    <AddressLine3>sample string 7</AddressLine3>
    <ApprovalExpired>sample string 18</ApprovalExpired>
    <Approved>true</Approved>
    <CityTown>sample string 9</CityTown>
    <County>sample string 8</County>
    <Email>sample string 12</Email>
    <PaymentMethod>sample string 16</PaymentMethod>
    <PaymentTerms>sample string 15</PaymentTerms>
    <PhoneNumber>sample string 11</PhoneNumber>
    <Postcode>sample string 10</Postcode>
    <Reference>sample string 2</Reference>
    <Status>sample string 14</Status>
    <StatusID>22</StatusID>
    <StatusLabel>sample string 21</StatusLabel>
    <SupplierID>1</SupplierID>
    <SupplierName>sample string 3</SupplierName>
    <Type>sample string 19</Type>
    <WebSiteURL>sample string 13</WebSiteURL>
  </SupplierModel.AddSupplierFields>
  <SupplierModel.AddSupplierFields>
    <AccRef>sample string 4</AccRef>
    <AccountNumber>sample string 20</AccountNumber>
    <AddressLine1>sample string 5</AddressLine1>
    <AddressLine2>sample string 6</AddressLine2>
    <AddressLine3>sample string 7</AddressLine3>
    <ApprovalExpired>sample string 18</ApprovalExpired>
    <Approved>true</Approved>
    <CityTown>sample string 9</CityTown>
    <County>sample string 8</County>
    <Email>sample string 12</Email>
    <PaymentMethod>sample string 16</PaymentMethod>
    <PaymentTerms>sample string 15</PaymentTerms>
    <PhoneNumber>sample string 11</PhoneNumber>
    <Postcode>sample string 10</Postcode>
    <Reference>sample string 2</Reference>
    <Status>sample string 14</Status>
    <StatusID>22</StatusID>
    <StatusLabel>sample string 21</StatusLabel>
    <SupplierID>1</SupplierID>
    <SupplierName>sample string 3</SupplierName>
    <Type>sample string 19</Type>
    <WebSiteURL>sample string 13</WebSiteURL>
  </SupplierModel.AddSupplierFields>
</ArrayOfSupplierModel.AddSupplierFields>