Реквизиты покупателей

Реквизиты, под которыми выписываются документы новых заказов покупателя.

Загружаем поисковый индекс…

Реквизиты покупателей

Объекты

CustomerFiscalProfile

  • customer_idintegerобязательно

    ID покупателя.

  • receptorobject или nullобязательно

    Реквизиты, под которыми выписываются документы новых заказов; null — розничный покупатель без реквизитов. Оформленный заказ хранит свою копию (fiscal_receptor заказа).

    Поля · 5
    • id_typestringобязательно

      Вид идентификатора: tax_id — налоговый номер организации (CUIT в Аргентине); personal_id — налоговый номер физлица (CUIL); national_id — удостоверение личности (DNI); passport — паспорт; none — без идентификатора.

      Значения:
      tax_idpersonal_idnational_idpassportnone
    • id_numberstring или nullобязательно

      Номер идентификатора; null, когда id_type — none.

    • namestring или nullобязательно

      Наименование или полное имя для документа; null, если не задано.

    • tax_statusstringобязательно

      Налоговый статус: registered — плательщик НДС (Responsable Inscripto в Аргентине); small_taxpayer — упрощённый режим (Monotributo); exempt — освобождён от НДС; final_consumer — конечный потребитель; not_categorized — без категории; foreign — иностранный покупатель.

      Значения:
      registeredsmall_taxpayerexemptfinal_consumernot_categorizedforeign
    • addressstring или nullобязательно

      Фискальный адрес одной строкой; null, если не задан.

Методы

Фискальные реквизиты покупателя

get/customers/{customer}/fiscal-profile

Scope: customers:read

Параметры

Путь

  • customerintegerобязательно

    ID покупателя.

Ответы

200Успешно

Заголовки

  • ETagstringобязательно

    Версия записи. Передайте её в If-Match, чтобы изменить запись.

    Пример:
    "7"

application/json

Возвращает CustomerFiscalProfile

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

404Объекта нет или он недоступен приложению

application/problem+json

Возвращает Problem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl "https://api.saleya.app/v1/customers/{customer}/fiscal-profile" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "customer_id": 0,
  "receptor": {
    "id_type": "tax_id",
    "id_number": "string",
    "name": "string",
    "tax_status": "registered",
    "address": "string"
  }
}

Заменить фискальные реквизиты покупателя целиком; null — розничный покупатель

put/customers/{customer}/fiscal-profile

Scope: customers:write

Параметры

Путь

  • customerintegerобязательно

    ID покупателя.

Заголовок

  • Idempotency-Keystring

    Уникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.

    Мин. длина:
    1
    Макс. длина:
    255
    Пример:
    8e03978e-40d5-43e8-bc93-6894a57f9324
  • If-Matchstringобязательно

    ETag записи из последнего чтения, например "7". Правка применится, только если запись с тех пор никто не менял, иначе 412. Без заголовка — 428.

    Пример:
    "7"

Тело запроса application/json

  • receptorobject или nullобязательно

    Реквизиты, под которыми выписываются документы новых заказов; null — розничный покупатель без реквизитов. Оформленный заказ хранит свою копию (fiscal_receptor заказа).

    Поля · 5
    • id_typestring

      Вид идентификатора: tax_id — налоговый номер организации (CUIT в Аргентине); personal_id — налоговый номер физлица (CUIL); national_id — удостоверение личности (DNI); passport — паспорт; none — без идентификатора.

      Значения:
      tax_idpersonal_idnational_idpassportnone
    • id_numberstring или null

      Номер идентификатора; null, когда id_type — none.

      Макс. длина:
      32
    • namestring или null

      Наименование или полное имя для документа; null, если не задано.

      Макс. длина:
      255
    • tax_statusstring

      Налоговый статус: registered — плательщик НДС (Responsable Inscripto в Аргентине); small_taxpayer — упрощённый режим (Monotributo); exempt — освобождён от НДС; final_consumer — конечный потребитель; not_categorized — без категории; foreign — иностранный покупатель.

      Значения:
      registeredsmall_taxpayerexemptfinal_consumernot_categorizedforeign
    • addressstring или null

      Фискальный адрес одной строкой; null, если не задан.

      Макс. длина:
      255

Ответы

200Успешно

Заголовки

  • Idempotent-Replayedstring

    true, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.

    Значения:
    true
  • ETagstringобязательно

    Версия записи. Передайте её в If-Match, чтобы изменить запись.

    Пример:
    "7"

application/json

Возвращает CustomerFiscalProfile

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

404Объекта нет или он недоступен приложению

application/problem+json

Возвращает Problem

409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает ConflictProblem

412Запись изменилась после чтения: версия в If-Match не текущая

application/problem+json

Возвращает Problem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

428Запросу нужен If-Match с ETag записи

application/problem+json

Возвращает Problem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl -X PUT "https://api.saleya.app/v1/customers/{customer}/fiscal-profile" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H 'If-Match: "7"' \
  -H "Content-Type: application/json" \
  -d @body.json
Тело запроса — body.json
{
  "receptor": {
    "id_type": "tax_id",
    "id_number": "string",
    "name": "string",
    "tax_status": "registered",
    "address": "string"
  }
}
Пример ответа · 200
{
  "customer_id": 0,
  "receptor": {
    "id_type": "tax_id",
    "id_number": "string",
    "name": "string",
    "tax_status": "registered",
    "address": "string"
  }
}