Read supplier cards

You use this method to read one or more supplier cards.

Request method


Request url{DossierId}/Supplier?{Key}={KeyValues}[&fields={FieldList}]

Context identification

Identification Description
DossierId The unique identifier of the dossier.


Parameter Description
{Key} The available keys to seek one or more suppliers:
  • SystemNumber={SystemNumber}: Seek supplier cards by system number.
  • NumberPair={Number}<tab>{SubNumber}: Seek supplier cards by number and subnumber.
  • SyncReference={SyncReference}: Seek supplier cards by synchronization reference.
Fields List of fields, containing property names of the supplier card, of which the value has to be returned in the response body. (optional)
Example: Get the supplier with number '2' and subnumber '1' from dossier 'Demo' and limit the data to the following fields: 'Name', 'PostalCode' and 'City'.,PostalCode,City

Request header

See request header.

Request body


Http status

See http status.

Response body

You can receive the response in json or xml.


Response (object)


  "Response": {
    "Suppliers": {
      "Supplier": [
          "Fields" : {
            "Name": "My supplier NV",
            "PostalCode": "8200",
            "City": "Brugge"
<?xml version="1.0" encoding="utf-8"?>
        <Name>My supplier NV</Name>