# fbr-invoice

Source: https://pakdatakit.dev/api/typescript/fbr-invoice/

## Interfaces

| Interface | Description |
| :------ | :------ |
| [FbrInvoiceItem](https://pakdatakit.dev/api/typescript/fbr-invoice/interfaces/fbrinvoiceitem/) | One line of an invoice (spec §4.1, `items`). Amounts are in rupees. |
| [FbrInvoice](https://pakdatakit.dev/api/typescript/fbr-invoice/interfaces/fbrinvoice/) | The invoice body for `postinvoicedata` and `validateinvoicedata` (spec §4.1, §4.2). |
| [FbrInvoiceTotals](https://pakdatakit.dev/api/typescript/fbr-invoice/interfaces/fbrinvoicetotals/) | Column totals of an invoice, in rupees. Not sent to FBR. |
| [FbrInvoiceBuild](https://pakdatakit.dev/api/typescript/fbr-invoice/interfaces/fbrinvoicebuild/) | Result of [buildFbrInvoice](https://pakdatakit.dev/api/typescript/fbr-invoice/functions/buildfbrinvoice/). |
| [FbrInvoiceError](https://pakdatakit.dev/api/typescript/fbr-invoice/interfaces/fbrinvoiceerror/) | One problem found by [validateFbrInvoice](https://pakdatakit.dev/api/typescript/fbr-invoice/functions/validatefbrinvoice/). |
| [FbrInvoiceValidation](https://pakdatakit.dev/api/typescript/fbr-invoice/interfaces/fbrinvoicevalidation/) | Result of [validateFbrInvoice](https://pakdatakit.dev/api/typescript/fbr-invoice/functions/validatefbrinvoice/). |
| [FbrInvoiceValidationOptions](https://pakdatakit.dev/api/typescript/fbr-invoice/interfaces/fbrinvoicevalidationoptions/) | Options for [validateFbrInvoice](https://pakdatakit.dev/api/typescript/fbr-invoice/functions/validatefbrinvoice/). |

## Type Aliases

| Type Alias | Description |
| :------ | :------ |
| [FbrInvoiceType](https://pakdatakit.dev/api/typescript/fbr-invoice/type-aliases/fbrinvoicetype/) | `invoiceType` values in the specification. |
| [FbrRegistrationType](https://pakdatakit.dev/api/typescript/fbr-invoice/type-aliases/fbrregistrationtype/) | `buyerRegistrationType` values in the specification. |
| [FbrInvoiceItemInput](https://pakdatakit.dev/api/typescript/fbr-invoice/type-aliases/fbrinvoiceiteminput/) | An item for [buildFbrInvoice](https://pakdatakit.dev/api/typescript/fbr-invoice/functions/buildfbrinvoice/): the tax may be left out. |
| [FbrInvoiceInput](https://pakdatakit.dev/api/typescript/fbr-invoice/type-aliases/fbrinvoiceinput/) | Input for [buildFbrInvoice](https://pakdatakit.dev/api/typescript/fbr-invoice/functions/buildfbrinvoice/). |

## Variables

| Variable | Description |
| :------ | :------ |
| [FBR\_DI\_SPEC\_VERSION](https://pakdatakit.dev/api/typescript/fbr-invoice/variables/fbr_di_spec_version/) | Version of PRAL's technical specification this module follows. |

## Functions

| Function | Description |
| :------ | :------ |
| [expectedSalesTax](https://pakdatakit.dev/api/typescript/fbr-invoice/functions/expectedsalestax/) | The sales tax FBR expects on a line, in rupees, or `null` when the rate is not a plain percentage or per-unit amount (spec §7, errors 0102, 0104, 0105): |
| [buildFbrInvoice](https://pakdatakit.dev/api/typescript/fbr-invoice/functions/buildfbrinvoice/) | Builds an FBR digital invoice from your own fields, working out `salesTaxApplicable` on each line where you leave it out (see [expectedSalesTax](https://pakdatakit.dev/api/typescript/fbr-invoice/functions/expectedsalestax/); uses `calculateSalesTax`). Lines with a rate that is neither `N%` nor `Rs.N` (`Exempt`, combined rates) get 0 unless you give the tax. |
| [validateFbrInvoice](https://pakdatakit.dev/api/typescript/fbr-invoice/functions/validatefbrinvoice/) | Checks an FBR digital invoice against the rules of PRAL's specification (v1.12) and Error Message Guide that need no call to FBR, and returns every problem with FBR's error code. |
