Convert/amount (версия 5)

Материал из post-API.ru
Перейти к: навигация, поиск

Версия API

 Версия 5.0 (общее описание).

Описание

convert/amount - функция, производящая преобразование суммы, записанной цифрами в текст. Например, число 97346667637647673467343,32 преобразуется в Девяносто семь секстиллионов триста сорок шесть квинтиллионов шестьсот шестьдесят семь квадриллионов шестьсот тридцать семь триллионов шестьсот сорок семь миллиардов шестьсот семьдесят три миллиона четыреста шестьдесят семь тысяч триста сорок три рубля 32 копейки.

Возможности

Функция обеспечивает:

  • Распознавание числа в широких пределах, в том числе с пробелами
  • Автоматическую замену запятой в плавающую запятую ('32,4' -> '32.4')
  • Отрицательные числа
  • Добавление валюты (рублей)
  • Выравнивание копеек до двух цифр ('32.4' -> '32 рубля 40 копеек')

Параметры

Параметры показаны в следующей таблице

Параметр Значение
full Если true, то к целой и дробной частям добавляются рублей и копеек. Если false, то руб. и коп.. По умолчанию - true.
currency Если true, то к целой и дробной частям добавляется название валюты - рубли и копейки по форме, определенной в параметре full. По умолчанию - true. Если currency равно false, то автоматически параметру fractional присваивается значение false.
fractional Если true, то к сумме прописью добавляются копейки (тридцать рублей 04 копейки). Если false, то копейки не выводятся. По умолчанию - true.

Результат

Успех

В случае, если формат числа распознан - будет возвращена модель amount.

Ошибка

Ошибкой вызова функции convert/amount является передача пустого параметра amount, или числа с ошибкой (например, с двумя точками).

В случае указанных выше ошибок, в клиентское ПО возвращается ошибка 400 с разъяснением причины, согласно кодам ошибок.

Используемые модели