GET
/
invoices
{
  "data": [
    {
      "irn": "ITW20853450-AAD5150E-20240703",
      "entry_status": "TRANSMITTED",
      "payment_status": "PENDING",
      "invoice_type_code": "396",
      "document_currency_code": "NGN",
      "tax_currency_code": "NGN",
      "issue_date": "2023-12-25",
      "issue_time": "<string>",
      "due_date": "2023-12-25",
      "sync_date": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "current_page": 123,
    "total_pages": 123,
    "total_items": 123,
    "items_per_page": 123
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication using access token

Query Parameters

size
integer
default:20

Number of items per page

page
integer
default:1

Page number

sort_by
string
default:created_at

Field to sort by

sort_direction_desc
boolean
default:true

Sort direction

irn
string

Filter by IRN

payment_status
enum<string>

Filter by payment status

Available options:
PENDING,
PAID,
REJECTED
invoice_type_code
string

Filter by invoice type code

issue_date
string

Filter by issue date

due_date
string

Filter by due date

tax_currency_code
string

Filter by tax currency code

document_currency_code
string

Filter by document currency code

Response

200 - application/json

Invoices retrieved successfully

The response is of type object.