vendors

Requires at least one of the permissions purchase:debit_note:create, purchase:grn:create, purchase:payment:create, purchase:purchase_invoice:create, purchase:purchase_order:create, suppliers:supplier:list or suppliers:supplier:read.

Lists the organization's active partners that carry the supplier role. Needs a supplier read grant or a grant to raise a purchase document.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query Vendors {
  vendors {
    id
    code
    registrationNumber
    name
    displayName
    legalName
    addresses {
      id
      postalCode
      contactName
      type
      createdAt
      city
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query Vendors {\n  vendors {\n    id\n    code\n    registrationNumber\n    name\n    displayName\n    legalName\n    addresses {\n      id\n      postalCode\n      contactName\n      type\n      createdAt\n      city\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "vendors": [
      {
        "id": "id",
        "code": "string",
        "registrationNumber": "string",
        "name": "string",
        "displayName": "string",
        "legalName": "string",
        "addresses": [
          {
            "id": "id",
            "postalCode": "string",
            "contactName": "string",
            "type": "string",
            "createdAt": "2025-01-15T00:00:00Z",
            "city": "string"
          }
        ]
      }
    ]
  }
}

vendors: [Partner!]!

Type

Partner object

A partner: the one master record for customers and vendors, with its roles, addresses, contacts and account details.