Skip to content
Category

Calculate VAT, invoice totals, and inflation-adjusted values.

Finance endpoints provide deterministic calculations that can be used in back-office systems, quoted estimates, and reporting tools. They return both the derived values and the basis used to reach them.

Routes

3 GET

Currency

AOA-first

Invoice input

JSON query payload

Routes in this family

RoutePurposeKey query
/api/v1/finance/vatSplit or build VAT-inclusive totals.amount, rate, inclusive
/api/v1/finance/invoice-totalCompute invoice totals from line items.lines, discount, discountType
/api/v1/finance/inflation-adjustAdjust values across years using the Angola CPI series.amount, from, to

GET /api/v1/finance/vat

Use VAT to split gross totals into net-plus-tax or to build gross totals from a net amount.

ParameterRequiredDescription
amountYesBase amount to evaluate.
rateNoTax rate percentage. Defaults to 14.
inclusiveNoWhen `true`, treats amount as VAT-inclusive. When `false`, treats amount as net.
GNU BashcURL usage
curl -s "https://utils.api.orb3x.com/api/v1/finance/vat?amount=114000&inclusive=true"
JSON200 response
{  "amount": 114000,  "rate": 14,  "inclusive": true,  "netAmount": 100000,  "vatAmount": 14000,  "grossAmount": 114000}
JSONError response
{  "error": {    "code": "INVALID_RATE",    "message": "Tax rates must be between 0 and 100.",    "field": "rate",    "value": 140  }}

GET /api/v1/finance/invoice-total

Use invoice-total to compute invoice totals from encoded line items without duplicating pricing math in each client.

ParameterRequiredDescription
linesYesJSON array string with `description`, `quantity`, `unitPrice`, and optional `vatRate`.
discountNoDiscount amount or percent, depending on `discountType`.
discountTypeNoEither `amount` or `percent`.
GNU BashcURL usage
curl -s "https://utils.api.orb3x.com/api/v1/finance/invoice-total?lines=%5B%7B%22description%22%3A%22Service%22%2C%22quantity%22%3A1%2C%22unitPrice%22%3A100000%2C%22vatRate%22%3A14%7D%5D&discount=10&discountType=percent"
JSON200 response
{  "currency": "AOA",  "discountType": "percent",  "subtotal": 100000,  "discountAmount": 10000,  "taxableBase": 90000,  "vatTotal": 12600,  "grandTotal": 102600}
JSONError response
{  "error": {    "code": "INVALID_JSON",    "message": "The \"lines\" query parameter must be a valid JSON array.",    "field": "lines"  }}

GET /api/v1/finance/inflation-adjust

Use inflation-adjust to compare nominal values across supported Angola CPI years.

ParameterRequiredDescription
amountYesOriginal nominal amount.
fromYesSource date or year string. The first four digits are used as the CPI year.
toYesTarget date or year string. The first four digits are used as the CPI year.
GNU BashcURL usage
curl -s "https://utils.api.orb3x.com/api/v1/finance/inflation-adjust?amount=100000&from=2020-01-01&to=2025-01-01"
JSON200 response
{  "currency": "AOA",  "amount": 100000,  "fromYear": 2020,  "toYear": 2025,  "inflationFactor": 2.5642,  "adjustedAmount": 256420,  "source": "Curated annual Angola CPI index series."}
JSONError response
{  "error": {    "code": "UNSUPPORTED_CPI_YEAR",    "message": "Inflation adjustment is available for Angola annual CPI years from 2019 through 2025.",    "fromYear": 2010,    "toYear": 2025  }}
Persist the calculation year range whenever the adjusted amount is used in reporting or pricing flows.