Редактирование Заявки на оплату

Cloud Mock

https://mock.apidog.com/m1/463678-0-default

PATCH

/payment-requests/{id}

Last modified:2024-06-15 16:01:41

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

string

required

Идентификатор записи раздела "Заявки на оплату"

Example:

Body Params application/json

Менеджер должен иметь возможность создать заявку на оплату и из нее уже создать несколько платежей по заявке на оплату, которые далее связываются с платежами в «Международных финансах».

manager

string <iri-reference>

required

Менеджер

Example:

/users/1

managerCode

string <iri-reference>

required

Код менеджера

customer

string <iri-reference>

required

Клиент

Example:

/customers/1

techDealType

string <iri-reference>

required

Тип сделки

Example:

/tech-deal-types/1

payer

string <iri-reference>

required

Плательщик

Example:

/payers/1

ruCompany

string <iri-reference>

required

Компания РФ от кого выставили счет

Example:

/ru-companies/1

paymentMethod

string <iri-reference>

required

Способ оплаты

Example:

/payment-methods/1

agent

string <iri-reference>

required

Продавец (контракт)

Example:

/agents/1

supplier

string

optional

Поставщик в Китае

paymentMethodContract

string <iri-reference>

required

Способ оплаты контракта

Example:

/payment-methods

paymentVariant

string <iri-reference>

optional

Вариант оплаты

Default:

/payment-variants

isNds

boolean

optional

С НДС

Default:

false

contract

string <iri-reference>

required

Контракт

Example:

/contracts/1

invoice

string <iri-reference>

optional

Инвойс (файл)

Example:

/files/1

invoiceNumber

integer

optional

Номер инвойса

invoiceDate

string <date>

optional

Дата инвойса

invoiceCurrency

string <iri-reference>

optional

Валюта инвойса

Example:

/currencies/1

invoiceAmount

number <float>

required

Сумма инвойса

cargoReadyDate

string <date>

required

Дата готовности груза

isCompleted

boolean

optional

Завершено

Default:

false

payments

array[string <iri-reference>]

required

Example

{
       "invoice": "/files/067ed83c-8cd1-431d-85fd-3ea362592fab",
       "manager": "/users/125",
       "managerCode": "/user-codes/70",
       "customer": "/customers/2",
       "payer": "/payers/1"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://mock.apidog.com/m1/463678-0-default/payment-requests/20' \
--header 'Content-Type: application/json' \
--data-raw '{
       "invoice": "/files/067ed83c-8cd1-431d-85fd-3ea362592fab",
       "manager": "/users/125",
       "managerCode": "/user-codes/70",
       "customer": "/customers/2",
       "payer": "/payers/1"
}'

Responses

🟢200OK

application/json

Body

deletedAt

string <date-time> | null

required

integer

required

>= 1

manager

object

Пользователи (base)

required

integer

read-onlyoptional

>= 1

firstname

string

required

surname

string

required

Фамилия

phone

string <phone>

required

Телефон

Match pattern:

^((\+7|7|8)+([0-9]){10})$

string <email>

required

departmentCode

optional

Код подразделения (Идентификатор кода).Обязательно, если роль = "менеджер по продажам".

position

optional

Должность

group

optional

Группа пользователя

codes

array[object (Коды пользователей (users view)) {3}]

optional

Код менеджера (Уникальный код менеджера, состоящий только из букв и чисел).В поле “Код менеджера” не должно быть разрешено сохранять значение с дефисом, должна появляться ошибка.Обязательно, если роль = "Менеджер по продажам".

roles

array[object (Роли) {5}]

required

partner

object

Партнер

optional

date

string <date-time>

required

Дата заявки

marking

string

required

Маркировка

customer

allOf {2}

Клиенты

required

object (BaseFieldsModel)

optional

object

optional

techDealType

object

Типы сделок

required

Права доступа на редактирование, создание и удаление записей в данном разделе должно быть доступно только пользователю группы Администратор.
Администратор самостоятельно может предоставить доступ на управление данным разделом в случае необходимости в карточке настройки прав доступа на определенную Роль.

payer

object

Плательщики

required

ruCompany

object

Компании РФ

required

Должны соответствовать реестру Фирмы АЗ в МФ. Обмен данными должен быть через систему RabbitMQ.

paymentMethod

object

Enum

required

integer

required

>= 1

label

string

required

agent

object

Агенты

required

Агенты должны соответствовать реестру Фирмы АИ из МФ. Обмен данными должен быть через систему RabbitMQ.

deletedAt

string <date-time> | null

required

integer

required

>= 1

title

string

required

Название фирмы

supplier

string

optional

Поставщик в Китае (Контактное лицо)

paymentMethodContract

object

required

Способ оплаты контракта (Выбор из 2 вариантов: Физ.лицо / Юр.лицо)

integer

required

>= 1

title

string

required

Examples:

Физ.лицоЮр.лицо

paymentVariant

object

optional

Вариант оплаты (Выбор из 2 вариантов: Внутренний / Внешний )

integer

required

>= 1

title

string

required

Examples:

ВнутреннийВнешний

isNds

boolean

optional

С НДС

Default:

false

invoiceNumber

integer

optional

Номер инвойса

invoice

object

File

optional

uuid

string <uuid>

optional

name

string

optional

path

string

optional

size

integer

optional

>= 0

mimeType

string

optional

createdBy

object

Пользователи (base)

optional

updatedBy

object

Пользователи (base)

optional

deletedAt

string <date-time> | null

optional

createdAt

string <date-time>

optional

updatedAt

string <date-time>

optional

pathPreview

string

optional

invoiceAmount

number <float>

required

Сумма инвойса

cargoReadyDate

string <date>

required

Дата готовности груза

invoiceBalance

number <float>

optional

Остаток по инвойсу (Рассчитывается автоматически по формуле: Сумма инвойса - Сумма платежей в статусе Оплачено или Завершено)

contract

object

Контракты

required

Редактирование, создание и удаление записей в данном реестре запрещено и должно быть недоступно.

deletedAt

string <date-time> | null

required

integer

required

>= 1

number

string

read-onlyrequired

Номер контракта

date

string <date>

read-onlyrequired

Дата контракта

uniqueCode

string

read-onlyrequired

Уникальный код (Сокращение для отгрузочных)

ruCompany

object

Компании РФ

required

Должны соответствовать реестру Фирмы АЗ в МФ. Обмен данными должен быть через систему RabbitMQ.

agent

object

Агенты

required

Агенты должны соответствовать реестру Фирмы АИ из МФ. Обмен данными должен быть через систему RabbitMQ.

skan

object

File

required

currencies

array[object (Валюты) {6}]

required

Валюты контракта

isCompleted

boolean

optional

Завершено

Default:

false

status

object

Статусы заявок на оплату

optional

deletedAt

string <date-time> | null

required

integer

required

>= 1

title

string

required

Статус заявки на оплату

invoiceDate

string <date>

optional

Дата инвойса

invoiceCurrency

object

Валюты

optional

payments

array[object (Платежи) {26}]

optional

Платежи

deletedAt

string <date-time> | null

required

integer

required

>= 1

commission

number <float>

required

Комиссия (%)

countSwift

integer

required

Кол-во Свифтов

amountSwift

number <float>

required

Сумма Свифтов

кол-во свифтов*200

cardNumber

string

optional

Номер карты (Номер карты при выборе физ лицо в способ оплаты контракта (Добавить валидацию) )

Обязательно, если способ оплаты контракт в заявке указан физ.лицо

factory

object

Реестр фабрик

optional

Реестр фабрик, должен синхронизироваться с реестром “Получатели” в Международных Финансах.

factoryAccount

object

Реестр Счетов фабрик

optional

Данный реестр должен синхронизироваться с реестром “Счета получателей” в Международных Финансах

paymentAmountCurrency

number <float>

required

Сумма оплаты в валюте (Сумма оплаты в долларах)

rateCalculated

number <float>

required

Курс (расчетный)

Редактируемое поле

При создании платежа, по-умолчанию в него должно подставляться значение курса с отдельной ручки (курс с мос биржи по валюте Заявки + 3 руб).

accountFile

object

File

optional

isRejected

boolean

optional

Признак статуса Отклонено

Default:

false

isApproved

boolean

optional

Признак статуса Одобрено

Default:

false

isInvoiceIssued

boolean

optional

Признак статуса Счет выставлен

Default:

false

isComing

boolean

optional

Признак статуса Приход

Default:

false

isTransferPayment

boolean

optional

Признак статуса Передать в оплату

Default:

false

bank

object

Реестр Банков фабрик

required

Реестр банков фабрик, должен синхронизироваться с реестром “Банки получателей” в Международных Финансах:

status

object

Статусы платежа

required

accountAmount

number <float>

required

z: В случае наличия суммы в валюте - подставлять ее; если ее нет - то сумма по инвойсу
Сумма счета = (z + свифт + комиссия * (z + свифт) / 100) * курс

paymentRequest

object

Заявки на оплату

required

При получении оплаты по платежу и при полностью оплаченной заявке на оплату, менеджер должен получать уведомление в разделе “заявки на оплату”.

reasonRefusal

optional

isConfirmed

boolean | null

optional

Default:

false

isBlocked

boolean | null

optional

Default:

false

applicationNumber

string | null

optional

cardOwner

string

optional

Имя владельца карты

financialDataFile

object

File

optional

managerCode

object

Коды пользователей

required

deletedAt

string <date-time> | null

required

integer

required

>= 1

code

string

required

user

object

Пользователи

required

Сущность является наследуемой от глобальной сущности Сотрудник.

amountAccounts

number <float>

optional

Сумма счетов

accountBalance

number <float>

optional

Остаток по счету, руб (Рассчитывается: Сумма счетов - Общая сумма по грузу , руб)

Example

🟠400Ошибки 4XX

🔴500Ошибки 5XX

Modified at 2024-06-15 16:01:41

Получение Заявки на оплату по ID

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