# amountInWords

Source: https://pakdatakit.dev/api/typescript/words/functions/amountinwords/

```ts
function amountInWords(amount, options?): string;
```

Defined in: [words.ts:261](https://github.com/chmuzamil/pakdatakit/blob/a6eeaa47381308c4e4fcda45b29642fe4fbfb1fc/src/words.ts#L261)

Writes a rupee amount in words, with paisa, as used on Pakistani cheques
and invoices. Amounts are rounded to the nearest paisa.

## Parameters

| Parameter | Type | Description |
| :------ | :------ | :------ |
| `amount` | `number` | Amount in PKR (must be zero or more) |
| `options?` | [`AmountInWordsOptions`](https://pakdatakit.dev/api/typescript/words/interfaces/amountinwordsoptions/) | Output language and cheque style |

## Returns

`string`

The amount in words

## Example

```ts
amountInWords(125000.5);
// "one lakh twenty-five thousand rupees and fifty paisa"
amountInWords(125000, { cheque: true });
// "Rupees One Lakh Twenty-Five Thousand Only"
amountInWords(125000, { language: 'ur' });
// "ایک لاکھ پچیس ہزار روپے"
```

## Throws

If `amount` is negative, not finite, or too large
