GET
/
invoices
/
inbox
/
{irn}
/
download
{
  "code": 200,
  "data": {
    "business_id": "<string>",
    "irn": "ITW20853450-AAD5150E-20240703",
    "issue_date": "2024-05-14",
    "due_date": "2024-06-14",
    "issue_time": "17:59:04",
    "invoice_type_code": "396",
    "payment_status": "PENDING",
    "entry_status": "NEW_ENTRY",
    "transmitted": true,
    "delivered": false,
    "note": "dummy_note (will be encrypted in storage)",
    "tax_point_date": "<string>",
    "document_currency_code": "NGN",
    "tax_currency_code": "NGN",
    "accounting_cost": "2000",
    "buyer_reference": "buyer REF IRN?",
    "invoice_delivery_period": {
      "start_date": "2024-06-14",
      "end_date": "2024-06-16"
    },
    "order_reference": "order REF IRN?",
    "billing_reference": [
      {
        "irn": "ITW001-E9E0C0D3-20240619",
        "issue_date": "2024-05-14"
      }
    ],
    "dispatch_document_reference": {
      "irn": "ITW001-E9E0C0D3-20240619",
      "issue_date": "2024-05-14"
    },
    "receipt_document_reference": {
      "irn": "ITW001-E9E0C0D3-20240619",
      "issue_date": "2024-05-14"
    },
    "originator_document_reference": {
      "irn": "ITW001-E9E0C0D3-20240619",
      "issue_date": "2024-05-14"
    },
    "contract_document_reference": {
      "irn": "ITW001-E9E0C0D3-20240619",
      "issue_date": "2024-05-14"
    },
    "_document_reference": [
      {
        "irn": "ITW001-E9E0C0D3-20240619",
        "issue_date": "2024-05-14"
      }
    ],
    "accounting_supplier_party": {
      "party_name": "Test Pls",
      "tin": "TIN-0099990001",
      "email": "supplier_business@email.com",
      "telephone": "+23480254099000",
      "business_description": "this entity is into sales of Cement and building materials",
      "postal_address": {
        "street_name": "32, owonikoko street",
        "city_name": "Gwarikpa",
        "postal_zone": "023401",
        "country": "NG"
      }
    },
    "accounting_customer_party": {
      "party_name": "Test Pls",
      "tin": "TIN-0099990001",
      "email": "supplier_business@email.com",
      "telephone": "+23480254099000",
      "business_description": "this entity is into sales of Cement and building materials",
      "postal_address": {
        "street_name": "32, owonikoko street",
        "city_name": "Gwarikpa",
        "postal_zone": "023401",
        "country": "NG"
      }
    },
    "payee_party": {
      "party_name": "Test Pls",
      "tin": "TIN-0099990001",
      "email": "supplier_business@email.com",
      "telephone": "+23480254099000",
      "business_description": "this entity is into sales of Cement and building materials",
      "postal_address": {
        "street_name": "32, owonikoko street",
        "city_name": "Gwarikpa",
        "postal_zone": "023401",
        "country": "NG"
      }
    },
    "tax_representative_party": {
      "party_name": "Test Pls",
      "tin": "TIN-0099990001",
      "email": "supplier_business@email.com",
      "telephone": "+23480254099000",
      "business_description": "this entity is into sales of Cement and building materials",
      "postal_address": {
        "street_name": "32, owonikoko street",
        "city_name": "Gwarikpa",
        "postal_zone": "023401",
        "country": "NG"
      }
    },
    "actual_delivery_date": "2024-05-14",
    "payment_means": [
      {
        "payment_means_code": "10",
        "payment_due_date": "2024-05-14"
      }
    ],
    "payment_terms_note": "dummy payment terms note (will be encrypted in storage)",
    "allowance_charge": [
      {
        "charge_indicator": true,
        "amount": 800.6
      }
    ],
    "tax_total": [
      {
        "tax_amount": 56.07,
        "tax_subtotal": [
          {
            "taxable_amount": 800,
            "tax_amount": 8,
            "tax_category": {
              "id": "LOCAL_SALES_TAX",
              "percent": 2.3
            }
          }
        ]
      }
    ],
    "legal_monetary_total": {
      "line_extension_amount": 340.5,
      "tax_exclusive_amount": 400,
      "tax_inclusive_amount": 430,
      "payable_amount": 30
    },
    "invoice_line": [
      {
        "hsn_code": "CC-001",
        "product_category": "Food and Beverages",
        "discount_rate": 2.01,
        "discount_amount": 3500,
        "fee_rate": 1.01,
        "fee_amount": 50,
        "invoiced_quantity": 15,
        "line_extension_amount": 30,
        "item": {
          "name": "item name",
          "description": "item description",
          "sellers_item_identification": "identified as spoon by the seller"
        },
        "price": {
          "price_amount": 10,
          "base_quantity": 3,
          "price_unit": "NGN per 1"
        }
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication using access token

Path Parameters

irn
string
required

Invoice Reference Number

Response

200
application/json

Invoice downloaded successfully

The response is of type object.