Skip to main content

Submit Invoice Outbound

submit invoice specifically outbound

Endpoint​

POST /api/v1/submit

Headers​

Content-Type:application/json

x-client-key:ck_live_avetium_456

Request Body​

{
  "invoice_id": "INV-2026-00022",
  "invoice_number": "INV-2026-00022",
  "date": "2026-06-02",
  "due_date": "2026-06-30",
  "payment_status": "pending",
  "currency_code": "NGN",
  "irn": "ITW004-E9E0C0D3-20240618",

  "custom_field": {
    "business_id": "bb99420d-d6bb-422c-b371-b9f6d6009aae",
    "irn": "ITW001-E9E0C0D3-20240619",
    "invoice_kind": "B2B",
    "invoice_type": 223,
    "tax_currency_code": "NGN"
  },

  "organization": {
    "party_name": "Avetium Consult Ltd",
    "tin": "TIN-123456789",
    "email": "finance@avetium.com",
    "telephone": "+2348012345678",
    "business_description": "Technology Consulting",

    "postal_address": {
      "street_name": "10 Admiralty Way",
      "city_name": "Lekki",
      "postal_zone": "100001",
      "lga": "Eti Osa",
      "state": "Lagos",
      "country": "NG"
    }
  },

  "customer": {
    "party_name": "ABC Manufacturing Ltd",
    "tin": "TIN-987654321",
    "email": "accounts@abcmanufacturing.com",
    "telephone": "+2348098765432",
    "business_description": "Manufacturing",

    "postal_address": {
      "street_name": "22 Industrial Estate",
      "city_name": "Ikeja",
      "postal_zone": "100271",
      "lga": "Ikeja",
      "state": "Lagos",
      "country": "NG"
    }
  },

  "line_items": [
    {
      "name": "Payroll Implementation",
      "description": "Payroll system setup and deployment",
      "quantity": 1,
      "rate": 500000,
      "amount": 500000
    },
    {
      "name": "Support Subscription",
      "description": "Annual support subscription",
      "quantity": 1,
      "rate": 100000,
      "amount": 100000
    }
  ],

  "total": {
    "line_extension_amount": 600000,
    "tax_exclusive_amount": 600000,
    "tax_inclusive_amount": 645000,
    "payable_amount": 645000
  }
}

Success Response​

{
  "success": true,
}

Error Request Example​

curl --location -g '{{URL}}/api/v1/submit' \
--header 'Content-Type: application/json' \
--data-raw '{
  "invoice_id": "INV-2027-00290",
  "invoice_number": "INV-2027-00290",
  "date": "2026-06-02",
  "issue_time":"None",
  "due_date": "2026-06-30",
  "payment_status": "PENDING",
  "currency_code": "NGN",
//   "irn": "INVOICE710-75094D27-20260508",

  "custom_field": {
    "business_id": "805bdadb-4d27-4ff2-9d6e-8605dcd44c761",
    "irn": "INVOICE711-75094D27-20260508",
    "invoice_kind": "B2B",
    "invoice_type": 396,
    "tax_currency_code": "NGN"
  },

  "organization": {
    "party_name": "Avetium Consult Ltd",
    "tin": "20188843-0001",
    "email": "finance@avetium.com",
    "telephone": "+2348012345678",
    "business_description": "Technology Consulting",

    "postal_address": {
      "street_name": "10 Admiralty Way",
      "city_name": "Lekki",
      "postal_zone": "100001",
      "lga": "Eti Osa",
      "state": "Lagos",
      "country": "NG"
    }
  },

  "customer": {
    "party_name": "ABC Manufacturing Ltd",
    "tin": "TIN-20188843",
    "email": "accounts@abcmanufacturing.com",
    "telephone": "+2348098765432",
    "business_description": "Manufacturing",

    "postal_address": {
      "street_name": "22 Industrial Estate",
      "city_name": "Ikeja",
      "postal_zone": "100271",
      "lga": "Ikeja",
      "state": "Lagos",
      "country": "NG"
    }
  },

  "line_items": [
        {
            "hsn_code": "1006.30",
            "product_category": "Cereals; rice, semi-milled or wholly milled, whether or not polished or glazed",
            "discount_rate": 2.01,
            "discount_amount": 0.603,
            "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" //optional
            },
            "price": {
                "price_amount": 10,
                "base_quantity": 3,
                "price_unit": "XBG"
            }
        }        
    ],
  "total": {
    "line_extension_amount": 600000,
    "tax_exclusive_amount": 600000,
    "tax_inclusive_amount": 645000,
    "payable_amount": 645000
  }
}

Error Response​

{
  "detail": {
    "error": "NRS validation failed",
    "message": "invalid UUID length: 37",
    "status_code": 400,
    "id": "f155af5d-b705-436e-a1bd-88e150571f77",
    "handler": "invoice_actions",
    "response": "validation failed: we are unable to process your request. also confirm this is not a duplicate request"
  }
}