GET api/relationships/{id}

Метод для получения информации о "Взаимоотношении" между Клиентом и Дистрибьютором (aka Договор)

Полный URL-адрес запроса: https://sfa-api.ddapp.biz/api/relationships/{id}?api-version=2.0

  Для этого метода требуется авторизация

Информация о запросе

URL параметры

НазваниеОписаниеТип данныхДополнительная информация
id

Уникальный идентфикатор "Взаимоотношения"

 string

Required
fields

Список дополнительных полей, которые необходимо вернуть

 string

Нет

Тело запроса

Нет параметров в теле запроса

Информация об ответе

RelationshipModel2
НазваниеОписаниеТип данныхДополнительная информация
Id

globally unique identifier

Нет
VendorId

string

Нет
Name

string

Нет
Customer

CustomerModel

Дополнительное поле
PriceCategory

PriceCategoryModel

Дополнительное поле
PriceTiers

Collection of PriceCategoryModel

Дополнительное поле
Currency

CurrencyModel

Дополнительное поле
PaymentTypes

Collection of PaymentTypeModel

Дополнительное поле
PaymentForms

Collection of integer

Дополнительное поле
Deferment

integer

Нет
Limit

decimal number

Нет
MinOrder

decimal number

Нет
Debts

Collection of MultiCurrencySumModel

Дополнительное поле
OverdueDebts

Collection of MultiCurrencySumModel

Дополнительное поле
Properties

Collection of EntityPropertyValueModel

Дополнительное поле
Discounts

Collection of RelationshipDiscountModel

Дополнительное поле
Active

boolean

Нет
DateFrom

date

Нет
DateTill

date

Нет
OrderIndex

integer

Нет
IsFixedPriceCategory

boolean

Нет
DeliveryTypes

Collection of DeliveryTypeModel

Дополнительное поле
BrandPriceCategories

Collection of RelationshipBrandPriceCategoryModel

Дополнительное поле
GroupPriceCategories

Collection of RelationshipGroupPriceCategoryModel

Дополнительное поле

Форматы ответа

{
  "id": "a5747450-6fb5-4b80-84bc-f004dd4be004",
  "vendorId": "sample string 2",
  "name": "sample string 3",
  "customer": {
    "id": "dfaff263-608d-4b6a-b546-e68a3ddb2839",
    "vendorId": "sample string 2",
    "name": "sample string 3",
    "taxNumber": "sample string 4",
    "location": {
      "country": {
        "id": "5df3bf89-ecc8-4c3b-8c9e-c7c9cdc4bbf8",
        "isoCode": "sample string 2",
        "name": "sample string 3"
      },
      "province": {
        "id": "f842a165-99b0-45dd-924f-163257b1c0be",
        "name": "sample string 2"
      },
      "settlement": "sample string 1",
      "addressLine": "sample string 2",
      "geoCoordinate": {
        "latitude": 1.1,
        "longitude": 1.1
      }
    },
    "tradeNetwork": {
      "id": "f53cd551-693c-4feb-ad82-c2d6debe72a8",
      "vendorId": "sample string 2",
      "name": "sample string 3",
      "properties": [
        {
          "entityProperty": {
            "id": "b3c0189a-2371-4f77-bf1e-c74b5d06ea51",
            "vendorId": "sample string 2",
            "name": "sample string 3",
            "entityDataType": "string",
            "valueLookup": "contacts",
            "required": true
          },
          "value": "sample string 1"
        },
        {
          "entityProperty": {
            "id": "b3c0189a-2371-4f77-bf1e-c74b5d06ea51",
            "vendorId": "sample string 2",
            "name": "sample string 3",
            "entityDataType": "string",
            "valueLookup": "contacts",
            "required": true
          },
          "value": "sample string 1"
        }
      ]
    },
    "office": {
      "id": "b3f45958-8b60-4850-baf2-f517d876b539",
      "vendorId": "sample string 2",
      "name": "sample string 3",
      "responsible": {
        "id": "ddf79d5b-5649-4a17-9208-f5169c4fcd29",
        "vendorId": "sample string 2",
        "firstName": "sample string 3",
        "lastName": "sample string 4",
        "middleName": "sample string 5",
        "fullName": "sample string 6",
        "imageUrl": "sample string 7",
        "email": "sample string 8",
        "emailConfirmed": true,
        "phoneNumber": "sample string 10",
        "phoneNumberConfirmed": true,
        "twoFactorEnabled": true,
        "lockoutEndDateUtc": "2025-09-13T21:44:54.3112309Z",
        "lockoutEnabled": true,
        "roles": [
          "sample string 1",
          "sample string 2"
        ]
      },
      "location": {
        "country": {
          "id": "5df3bf89-ecc8-4c3b-8c9e-c7c9cdc4bbf8",
          "isoCode": "sample string 2",
          "name": "sample string 3"
        },
        "province": {
          "id": "f842a165-99b0-45dd-924f-163257b1c0be",
          "name": "sample string 2"
        },
        "settlement": "sample string 1",
        "addressLine": "sample string 2",
        "geoCoordinate": {
          "latitude": 1.1,
          "longitude": 1.1
        }
      },
      "timeZoneId": "sample string 4"
    },
    "properties": [
      {
        "entityProperty": {
          "id": "b3c0189a-2371-4f77-bf1e-c74b5d06ea51",
          "vendorId": "sample string 2",
          "name": "sample string 3",
          "entityDataType": "string",
          "valueLookup": "contacts",
          "required": true
        },
        "value": "sample string 1"
      },
      {
        "entityProperty": {
          "id": "b3c0189a-2371-4f77-bf1e-c74b5d06ea51",
          "vendorId": "sample string 2",
          "name": "sample string 3",
          "entityDataType": "string",
          "valueLookup": "contacts",
          "required": true
        },
        "value": "sample string 1"
      }
    ]
  },
  "priceCategory": {
    "id": "c925e21f-5efa-4584-9954-73b54865f773",
    "vendorId": "sample string 2",
    "name": "sample string 3",
    "orderIndex": 1
  },
  "priceTiers": [
    {
      "id": "c925e21f-5efa-4584-9954-73b54865f773",
      "vendorId": "sample string 2",
      "name": "sample string 3",
      "orderIndex": 1
    },
    {
      "id": "c925e21f-5efa-4584-9954-73b54865f773",
      "vendorId": "sample string 2",
      "name": "sample string 3",
      "orderIndex": 1
    }
  ],
  "currency": {
    "id": "888aaef5-9f9d-44f6-bb93-e0a036718234",
    "isoCode": "sample string 2",
    "isoNumber3": "sample string 3",
    "name": "sample string 4",
    "shortName": "sample string 5",
    "symbol": "sample string 6"
  },
  "paymentTypes": [
    {
      "id": "30b8974a-d474-4cd3-b13e-62c5412487a4",
      "vendorId": "sample string 2",
      "name": "sample string 3",
      "orderIndex": 1
    },
    {
      "id": "30b8974a-d474-4cd3-b13e-62c5412487a4",
      "vendorId": "sample string 2",
      "name": "sample string 3",
      "orderIndex": 1
    }
  ],
  "paymentForms": [
    1,
    2
  ],
  "deferment": 1,
  "limit": 1.0,
  "minOrder": 1.0,
  "debts": [
    {
      "currency": {
        "id": "888aaef5-9f9d-44f6-bb93-e0a036718234",
        "isoCode": "sample string 2",
        "isoNumber3": "sample string 3",
        "name": "sample string 4",
        "shortName": "sample string 5",
        "symbol": "sample string 6"
      },
      "sum": 1.0
    },
    {
      "currency": {
        "id": "888aaef5-9f9d-44f6-bb93-e0a036718234",
        "isoCode": "sample string 2",
        "isoNumber3": "sample string 3",
        "name": "sample string 4",
        "shortName": "sample string 5",
        "symbol": "sample string 6"
      },
      "sum": 1.0
    }
  ],
  "overdueDebts": [
    {
      "currency": {
        "id": "888aaef5-9f9d-44f6-bb93-e0a036718234",
        "isoCode": "sample string 2",
        "isoNumber3": "sample string 3",
        "name": "sample string 4",
        "shortName": "sample string 5",
        "symbol": "sample string 6"
      },
      "sum": 1.0
    },
    {
      "currency": {
        "id": "888aaef5-9f9d-44f6-bb93-e0a036718234",
        "isoCode": "sample string 2",
        "isoNumber3": "sample string 3",
        "name": "sample string 4",
        "shortName": "sample string 5",
        "symbol": "sample string 6"
      },
      "sum": 1.0
    }
  ],
  "properties": [
    {
      "entityProperty": {
        "id": "b3c0189a-2371-4f77-bf1e-c74b5d06ea51",
        "vendorId": "sample string 2",
        "name": "sample string 3",
        "entityDataType": "string",
        "valueLookup": "contacts",
        "required": true
      },
      "value": "sample string 1"
    },
    {
      "entityProperty": {
        "id": "b3c0189a-2371-4f77-bf1e-c74b5d06ea51",
        "vendorId": "sample string 2",
        "name": "sample string 3",
        "entityDataType": "string",
        "valueLookup": "contacts",
        "required": true
      },
      "value": "sample string 1"
    }
  ],
  "discounts": [
    {
      "id": "f7d60ac2-f80c-4bc2-bb02-8e82ad2ba00b",
      "group": {
        "id": "2ed87811-84ad-4c3f-8aea-bdca9fa89d77",
        "vendorId": "sample string 2",
        "name": "sample string 3",
        "hierarchy": {
          "level": 1,
          "path": "sample string 2"
        }
      },
      "brand": {
        "id": "b9ac5ab0-cef1-4650-a91c-25566d6114ed",
        "vendorId": "sample string 2",
        "name": "sample string 3"
      },
      "percent": 2.1
    },
    {
      "id": "f7d60ac2-f80c-4bc2-bb02-8e82ad2ba00b",
      "group": {
        "id": "2ed87811-84ad-4c3f-8aea-bdca9fa89d77",
        "vendorId": "sample string 2",
        "name": "sample string 3",
        "hierarchy": {
          "level": 1,
          "path": "sample string 2"
        }
      },
      "brand": {
        "id": "b9ac5ab0-cef1-4650-a91c-25566d6114ed",
        "vendorId": "sample string 2",
        "name": "sample string 3"
      },
      "percent": 2.1
    }
  ],
  "active": true,
  "dateFrom": "2025-09-13T21:44:54.3112309Z",
  "dateTill": "2025-09-13T21:44:54.3112309Z",
  "orderIndex": 1,
  "isFixedPriceCategory": true,
  "deliveryTypes": [
    {
      "id": "1f04ca9f-4ed8-432a-842c-6153d5cf3d39",
      "vendorId": "sample string 2",
      "name": "sample string 3",
      "orderIndex": 1
    },
    {
      "id": "1f04ca9f-4ed8-432a-842c-6153d5cf3d39",
      "vendorId": "sample string 2",
      "name": "sample string 3",
      "orderIndex": 1
    }
  ],
  "brandPriceCategories": [
    {
      "brand": {
        "id": "b9ac5ab0-cef1-4650-a91c-25566d6114ed",
        "vendorId": "sample string 2",
        "name": "sample string 3"
      },
      "priceCategory": {
        "id": "c925e21f-5efa-4584-9954-73b54865f773",
        "vendorId": "sample string 2",
        "name": "sample string 3",
        "orderIndex": 1
      }
    },
    {
      "brand": {
        "id": "b9ac5ab0-cef1-4650-a91c-25566d6114ed",
        "vendorId": "sample string 2",
        "name": "sample string 3"
      },
      "priceCategory": {
        "id": "c925e21f-5efa-4584-9954-73b54865f773",
        "vendorId": "sample string 2",
        "name": "sample string 3",
        "orderIndex": 1
      }
    }
  ],
  "groupPriceCategories": [
    {
      "group": {
        "id": "2ed87811-84ad-4c3f-8aea-bdca9fa89d77",
        "vendorId": "sample string 2",
        "name": "sample string 3",
        "hierarchy": {
          "level": 1,
          "path": "sample string 2"
        }
      },
      "priceCategory": {
        "id": "c925e21f-5efa-4584-9954-73b54865f773",
        "vendorId": "sample string 2",
        "name": "sample string 3",
        "orderIndex": 1
      }
    },
    {
      "group": {
        "id": "2ed87811-84ad-4c3f-8aea-bdca9fa89d77",
        "vendorId": "sample string 2",
        "name": "sample string 3",
        "hierarchy": {
          "level": 1,
          "path": "sample string 2"
        }
      },
      "priceCategory": {
        "id": "c925e21f-5efa-4584-9954-73b54865f773",
        "vendorId": "sample string 2",
        "name": "sample string 3",
        "orderIndex": 1
      }
    }
  ]
}

Sample not available.

Sample not available.