v1.0.0
Request Access

Invoices Data Service API

Download OpenAPI Document

Retrieve invoices for a customer.

Overview

Returns approved invoices for the authenticated customer.

  • bookingReference — Booking reference (HBL number).
  • limit — Maximum number of invoices to return.
  • offset — Number of records to skip.
Scope: invoice:read

Getting started

Access to this API is limited to approved customers currently doing business with Airlift.

Getting Started Guide

OAuth 2.0

Bearer Token

Get an OAuth 2.0 access token using client credentials before calling the APIs.

Open Authorization Guide

List invoices.

Returns approved invoices for the authenticated customer.

Query Parameters

bookingReference stringAIRLAMD132196
Booking reference (HBL number).
limit integer25
Maximum number of invoices to return.
offset integer0
Number of records to skip.

Headers

Authorization stringBearer YOUR_TOKEN
Bearer token issued for your registered application must be provided with every request.

Responses

  • 200Successful operation.
  • 400Bad request; the request is unacceptable often due to a missing or invalid parameter.
  • 401The client cannot be authenticated by the system.
  • 403The client does not have permissions to access this endpoint.
  • 404The requested resource cannot be found.
  • 500Internal server error.

Models

ErrorResponseModel
object1 fields
Fields
error
object
Properties
code
string

Error code

message
string

Human-readable error message

InvoiceModel
object16 fields
Description

Invoice details.

Fields
bl_release_request
string

BL release request status.

cgst
number

CGST amount.

container_no
string

Container numbers.

date
string

Invoice date.

e_invoice_status
string

E-invoice status.

hbl_number
string

HBL number.

hbl_release_status
string

HBL release status.

igst
number

IGST amount.

invoice_number
string

Invoice number.

non_taxable_amount
number

Non-taxable amount.

payment_type
string

Payment type.

rate_list
array

Rate list items.

remarks
string

Remarks.

sgst
number

SGST amount.

taxable_amount
number

Taxable amount.

total
number

Total amount.

InvoiceRateModel
object8 fields
Description

Invoice rate details.

Fields
cgst_in
number

CGST amount.

collections
string

Collections type.

exchange_rate
number

Exchange rate.

igst_in
number

IGST amount.

rate
number

Rate amount.

rate_description
string

Rate description.

sgst_in
number

SGST amount.

type
string

Rate type.

Rate limits

Per Hour Per Minute Burst
400060100

Release Notes

Version Date Notes
1.0.02025-01-06Initial release of invoice retrieval.