partner

Requires at least one of the permissions customers:customer:list, customers:customer:read, payments:collection:create, payments:invoice:create, products:discount:update, purchase:debit_note:create, purchase:grn:create, purchase:payment:create, purchase:purchase_invoice:create, purchase:purchase_order:create, sales:credit_note:create, sales:quote:create, sales:sales_order:create, suppliers:supplier:list or suppliers:supplier:read.

Returns one partner by ID, including its money position, if the signed-in user may see it. A customer needs a customer read grant or a grant to raise a customer document; a supplier 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 Partner($id: ID!) {
  partner(id: $id) {
    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 Partner($id: ID!) {\n  partner(id: $id) {\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}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "partner": {
      "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"
        }
      ]
    }
  }
}

partner(
  id: ID!
): Partner!

Arguments

partner.id ● ID! non-null scalar

The ID of the partner.

Type

Partner object

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