Resources Endpoints

Access lookup data for invoice validation

Endpoint

GET /api/v1/resources/{resource}

Content-Type:application/json

Example Request

curl -X 'GET' \
  'https://uat.einvoicing.avetiumtechnologies.com/api/v1/resources' \
  -H 'accept: */*'

Available Resources

GET /resources/countries - Get list of supported countries with ISO codes
GET /resources/currencies - Get list of supported currencies
GET /resources/tax-categories - Get tax category codes and values
GET /resources/payment-means - Get payment method codes
GET /resources/invoice-types - Get invoice type codes
GET /resources/invoice-quantity-codes - Get invoice quantity codes
GET /resources/services-codes - Get invoice service code
GET /resources/vat-exemptions - Get VAT-exempt items
GET /resources/lgas - Get invoice LGAs
GET /resources/states - Get invoice States

Get Countries

Returns all supported countries with ISO 3166 codes. Use the alpha_2 value as the country field in postal_address objects.

GET /api/v1/resources/countries

Example Countries Response

{
  "success": true,
  "message": "Resource fetched successfully",
  "data": [
    {
      "name": "Canada",
      "alpha_2": "CA",
      "alpha_3": "CAN",
      "country_code": "124",
      "iso_3166_2": "ISO 3166-2:CA",
      "region": "Americas",
      "sub_region": "Northern America",
      "intermediate_region": "",
      "region_code": "019",
      "sub_region_code": "021",
      "intermediate_region_code": ""
    },
    {
      "name": "Nigeria",
      "alpha_2": "NG",
      "alpha_3": "NGA",
      "country_code": "566",
      "iso_3166_2": "ISO 3166-2:NG",
      "region": "Africa",
      "sub_region": "Sub-Saharan Africa",
      "intermediate_region": "Western Africa",
      "region_code": "002",
      "sub_region_code": "202",
      "intermediate_region_code": "011"
    }
  ]
}

Get Currencies

Returns all supported currencies. Use the code value as document_currency_code or tax_currency_code (e.g. 'NGN').

GET /api/v1/resources/currencies

Example Currencies Response

{
  "success": true,
  "message": "Resource fetched successfully",
  "data": [
    {
      "symbol": "$",
      "name": "US Dollar",
      "symbol_native": "$",
      "decimal_digits": 2,
      "rounding": 0,
      "code": "USD",
      "name_plural": "US dollars"
    },
    {
      "symbol": "₦",
      "name": "Nigerian Naira",
      "symbol_native": "₦",
      "decimal_digits": 2,
      "rounding": 0,
      "code": "NGN",
      "name_plural": "Nigerian nairas"
    }   
  ]
}

Get Tax Categories

Returns supported tax category codes for use in tax_total[].tax_subtotal[].tax_category.id.

GET /api/v1/resources/tax-categories

Code	Description	Rate
STANDARD_VAT	Standard Value-Added Tax	7.5%
ZERO_VAT	Zero Value-Added Tax	0.0%
REDUCED_GST	Reduced Goods and Services Tax	Not Available

Example Tax Categories Response

{
  "success": true,
  "message": "Resource fetched successfully",
  "data": [
    {
      "code": "STANDARD_VAT",
      "value": "Standard Value-Added Tax",
      "percent": "7.5"
    },
    {
      "code": "ZERO_VAT",
      "value": "Zero Value-Added Tax",
      "percent": "0.0"
    },
    {
      "code": "REDUCED_GST",
      "value": "Reduced Goods and Services Tax",
      "percent": "Not Available"
    }
  ]
}

Get Payment Means

Returns supported payment method codes for use in payment_means[].payment_means_code.

GET /api/v1/resources/payment-means

Code	Payment Means
10	Cash
20	Cheque
48	Bank Card
50	Credit Card

Example Payment Means Response

{
  "success": true,
  "message": "Resource fetched successfully",
  "data": [
    {
      "code": "10",
      "value": "Cash"
    },
    {
      "code": "20",
      "value": "Cheque"
    },
    {
      "code": "48",
      "value": "Bank Card"
    },
    {
      "code": "50",
      "value": "Credit Card"
    },
  ]
}

Get Invoice Types

Returns supported invoice type for use in invoice_types.

GET /api/v1/resources/invoice-types

Code	Invoice Type
380	Credit Note
381	Commercial Invoice
402	Shipping Instructions

{
  "success": true,
  "message": "Resource fetched successfully",
  "data": [
    {
      "code": "380",
      "value": "Credit Note"
    },
    {
      "code": "381",
      "value": "Commercial Invoice"
    },
    {
      "code": "402",
      "value": "Shipping Instructions"
    }
  ]
}

Get Invoice Quantity Codes

Returns supported invoice quantity codes for use in invoice_quantity_codes.

GET /api/v1/resources/invoice-quantity-codes

Code	Invoice Quantity
10	Group
15	Stick, Military
2J	Cubic Centimetre Per Second

{
  "success": true,
  "message": "Resource fetched successfully",
  "data": [
    {
      "code": "10",
      "name": "group",
      "description": "A unit of count defining the number of groups (group: set of items classified together)."
    },
    {
      "code": "15",
      "name": "stick, military",
      "description": "A unit of count defining the number of military sticks (military stick: bombs or paratroops released in rapid succession from an aircraft)."
    },
    {
      "code": "2J",
      "name": "cubic centimetre per second",
      "description": "cubic centimetre per second"
    },
  ]
}

Get Service Codes

Returns a list of service classification codes.

GET /api/v1/resources/services-codes

Code	Invoice Service
0111	Growing of cereals (except rice), leguminous crops and oil seeds
0115	Growing of tobacco
0128	Growing of spices, aromatic, drug and pharmaceutical crops

Example Service Codes Response

{
  "success": true,
  "message": "Resource fetched successfully",
  "data": [
    {
      "description": "Growing of cereals (except rice), leguminous crops and oil seeds",
      "code": "0111"
    },
    {
      "description": "Growing of tobacco",
      "code": "0115"
    },
    {
      "description": "Growing of spices, aromatic, drug and pharmaceutical crops",
      "code": "0128"
    },
  ]
}

Get VAT Exemptions

Returns a list of VAT-exempt items and their harmonized system codes.

GET /api/v1/resources/vat-exemptions

Code	Tariff	VAT-Exempt Items
2915.3100	Ethyl acetate	Saturated acyclic monocarboxylic acids and their derivatives
2939.6100	Ergometrin (INN) and its salts	Vegetable alkaloids, natural or reproduced by synthesis
3002.1000	Vaccines for human medicine	Glands and other organs for organotherapeutic uses

Example VAT Exemptions Response

{
  "success": true,
  "message": "Resource fetched successfully",
  "data": [
    {
      "heading_no": "29.15",
      "harmonized_system_code": "2915.3100",
      "tariff_category": "MEDICAL, VENTIRINARY AND PHARMACEUTICAL RAW MATERIALS AND PRODUCTS",
      "tariff": "Ethyl acetate",
      "description": "Saturated acyclic monocarboxylic acids and their derivatives."
    },
    {
      "heading_no": "29.39",
      "harmonized_system_code": "2939.6100",
      "tariff_category": "MEDICAL, VENTIRINARY AND PHARMACEUTICAL RAW MATERIALS AND PRODUCTS",
      "tariff": "Ergometrin (INN) and its salts",
      "description": "Vegetable alkaloids, natural or reproduced by synthesis"
    },
    {
      "heading_no": "30.01",
      "harmonized_system_code": "3002.1000",
      "tariff_category": "MEDICAL, VENTIRINARY AND PHARMACEUTICAL RAW MATERIALS AND PRODUCTS",
      "tariff": "Vaccines for human medicine",
      "description": "Glands and other organs for organotherapeutic uses"
    }
  ]
}

Get LGA Codes

Returns

GET /api/v1/resources/lgas

Code	State Code
NG-FC-AML	NG-FC
NG-ED-OEA	NG-ED
NG-LA-EOS	NG-LA

Example LGA Code Response

{
  "success": true,
  "message": "Resource fetched successfully",
  "data": [
    {
      "name": "Abuja Municipal",
      "code": "NG-FC-AML",
      "state_code": "NG-FC"
    },
    {
      "name": "Owan East",
      "code": "NG-ED-OEA",
      "state_code": "NG-ED"
    },
    {
      "name": "Eti-Osa",
      "code": "NG-LA-EOS",
      "state_code": "NG-LA"
    }
  ]
}

Get State Codes

Returns

GET /api/v1/resources/states

Code	State
NG-FC	Abuja Federal Capital Territory
NG-ED	Edo
NG-LA	Lagos

Example State Code Response

{
  "success": true,
  "message": "Resource fetched successfully",
  "data": [
    {
      "name": "Abuja Federal Capital Territory",
      "code": "NG-FC"
    },
    {
      "name": "Edo",
      "code": "NG-ED"
    },
    {
      "name": "lagos",
      "code": "NG-LA"
    }
  ]
}

Endpoint​

Header​

Example Request​

Available Resources​

Get Countries​

Example Countries Response​

Get Currencies​

Example Currencies Response​

Get Tax Categories​

Example Tax Categories Response​

Get Payment Means​

Example Payment Means Response​

Get Invoice Types​

Get Invoice Quantity Codes​

Get Service Codes​

Example Service Codes Response​

Get VAT Exemptions​

Example VAT Exemptions Response​

Get LGA Codes​

Example LGA Code Response​

Get State Codes​

Example State Code Response​