Retrieve All Invoices

GET https://api.beelpoint.com/v1/api/invoices

Response Body

Field
Type
Description

success

Boolean

Indicates if the request was successful.

statusCode

Number

HTTP status code.

message

String

Response message.

data

Object

Contains the list of invoices and pagination information.

invoices

Object

List of invoice documents.

docs

Object

Array of invoice objects.

legal_monetary_total

Object

Contains total monetary amounts for the invoice.

line_extension_amount

Object

Line extension amount (excluding taxes and discounts).

tax_exclusive_amount

Object

Amount before tax.

tax_inclusive_amount

Object

Amount including tax.

payable_amount

Object

Amount to be paid.

payment_status

String

Status of the payment (e.g., PENDING, PAID).

business_id

String

Unique ID of the business.

irn

String

Unique Invoice Reference Number (IRN).

issue_date

String

Date of invoice issuance.

invoice_type_code

String

Type code of the invoice.

document_currency_code

String

Currency code used in the invoice (e.g., NGN).

tax_currency_code

String

Currency code for taxes.

accounting_supplier_party

Object

Supplier details.

party_name

String

Name of the supplier.

tin

String

Supplier Tax Identification Number (TIN).

email

String

Supplier email.

postal_address

Object

Supplier postal address.

street_name

String

Street name of the supplier.

city_name

String

City name of the supplier.

postal_zone

String

Postal code of the supplier.

country

String

Country code of the supplier.

accounting_customer_party

Object

Customer details.

party_name

String

Name of the customer.

tin

String

Customer Tax Identification Number (TIN).

email

String

Customer email.

postal_address

Object

Customer postal address.

invoice_line

Object

Array of invoice line items.

hsn_code

String

Harmonized System Nomenclature (HSN) code.

product_category

String

Category of the product.

invoiced_quantity

Number

Quantity of the invoiced product.

line_extension_amount

Object

Line extension amount.

item

Object

Details of the invoiced item.

name

String

Name of the invoiced product.

description

String

Description of the invoiced product.

pagination

Object

Pagination information.

totalDocs

Number

Total number of documents.

perPage

Number

Number of documents per page.

totalPages

Number

Total number of pages.

currentPage

Number

Current page number.

Error Responses

Name
Type
Description

success

Boolean

Indicates if the request failed.

statusCode

Number

HTTP status code.

message

String

Error message.

/* '/v1/invoices'

Last updated