Skip to main content

Изменить данные документа оплаты по сделке продажи

PATCH 
/v5/orgs/:org_guid/deals/sales/:deal_guid/docs/money/payments/:doc_guid

Коды возможных ошибок:​

[500]: "InternalServerError" - внутренняя ошибка сервера [429]: "TooManyRequests" - превышено ограничение на количество запросов в секунду [401]: "Unauthorized" - для выполнения операции требуется авторизация [403]: "NoPermissions" - нет прав на выполнение этой операции [404]: "NotFound" - запрашиваемый объект или его родительский объект не найдены [422]: "RequestIsNotValid" - параметры запроса не прошли валидацию [422]: "NotAllowedForArchived" - операция не разрешена для объектов находящихся в архиве

Важная информация!​

Данный метод использует JSON PATCH формат: https://tools.ietf.org/html/rfc6902. Успешный ответ возвращается только в том случе, если все запрошенные изменения были произведены успешно.

Request​

Path Parameters

    org_guid uuidrequired

    Уникальный идентификатор организации

    deal_guid uuidrequired

    Уникальный иддентификатор сделки продажи

    doc_guid uuidrequired

    Уникальный идентификатор документа оплаты по сделке продажи

Header Parameters

    Accept-Language stringrequired

    Язык используемый для ответов

    Example: ru-RU
    X-LP-Client-Identifier stringrequired

    Идентификатор клиента

    Example: c18e9d45-675a-4ac6-a02f-e9ae387cf888
    X-LP-Client-Type stringrequired

    Possible values: [Unknown, App, WebApp, Service]

    Тип клиента

    Example: App
    X-LP-Client-Name string

    Имя клиента

    Example: Swagger
    X-LP-Client-OS-Name string

    ОС клиента

    Example: SwaggerDoc
    X-LP-Client-OS-Version string

    Версия ОС клиента

    Example: 1.0
    X-LP-Client-Screen-Resolution string

    Разрешение экрана ОС клиента

    Example: 1280x0900
    X-LP-Client-Model string

    Модель оборудования клиента

    Example: Chrome 75
    X-LP-Organization-Alias string

    Организация по умолчанию

    X-LP-Client-Extensions csv

    Поддерживаемые клиентом расширения моделей

Body

Список изменений в формате JSON PATCH

  • Array [

    • value nullable
    path stringnullable
    op stringnullable
    from stringnullable

  • ]

Responses​

No Content

Schema

    processed_at date-timerequired

    sum_by_card

    object

    required

    value int64
    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    type_of stringnullable

    sum_by_cash

    object

    required

    value int64
    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    type_of stringnullable

    total_sum

    object

    required

    value int64
    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    type_of stringnullable

    positions

    object[]

    nullable

  • Array [

    • paid_quantity doublerequired

    paid_amount

    object

    required

    value int64
    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    type_of stringnullable

    position

    object

    required

    guid uuid
    type_of stringnullable
    type_of stringnullable

  • ]

    • fiscal_document

    object

    guid uuid
    type_of stringnullable

    transactions

    object[]

    nullable

  • Array [

    • guid uuid
    type_of stringnullable

  • ]

    • sale

    object

    guid uuid
    type_of stringnullable
    created_at date-time
    updated_at date-time
    deleted_at date-timenullable
    meta stringnullable

    Possible values: <= 128 characters

    meta_data

    object

    nullable

    property name* string
    guid uuid
    type_of stringnullable
Loading...