Load Shiipp Courier Billing History and Invoice List

The Load Bills endpoint returns the complete billing history for courier invoices managed within Shiipp, including computed totals, tax amounts, payment records, and current invoice status. Access is automatically scoped by role: courier users see only their own billing records, while admin and manager roles have visibility across all couriers in the tenant.

Endpoint

GET /api/LoadCourierBills.php

Authentication

All requests must include a valid JWT Bearer token in the Authorization header.

Authorization: Bearer <your_jwt_token>

Role-Based Scoping

Admin / Manager
Courier

Receives the full billing history for all couriers in the tenant. Results are ordered by created_at descending.

Receives only the invoices associated with their own courier account. draft status invoices are typically filtered out — see the note below.

Example Request

curl https://app.shiipp.com/api/LoadCourierBills.php \
  -H "Authorization: Bearer <your_jwt_token>"

Response

200 — Success

{
  "status": "success",
  "count": 5,
  "data": [
    {
      "bill_id": "bill-uuid",
      "invoice_number": "INV-2024-001",
      "courier_id": "courier-uuid",
      "courier_name": "Express Couriers",
      "courier_code": "EXP",
      "service_type": "Air Standard",
      "start_date": "2024-01-01",
      "end_date": "2024-01-31",
      "total_packages": 47,
      "subtotal": 348.00,
      "tax_amount": 34.80,
      "total_amount": 382.80,
      "paid_amount": 382.80,
      "status": "paid",
      "created_at": "2024-02-01 09:00:00"
    }
  ]
}

Response Fields

count

integer

Total number of bill records returned in this response.

data

array

Array of invoice objects.

Show bill fields

bill_id

string

Unique UUID for the billing record.

invoice_number

string

Human-readable invoice identifier (e.g., INV-2024-001), used on printed and emailed invoices.

courier_id

string

UUID of the courier organization associated with this invoice.

courier_name

string

Display name of the invoiced courier.

courier_code

string

Short alphanumeric code identifying the courier (e.g., EXP).

service_type

string

The service level associated with this billing period (e.g., Air Standard, Express).

start_date

string

Start of the billing period in YYYY-MM-DD format.

end_date

string

End of the billing period in YYYY-MM-DD format.

total_packages

integer

Number of packages included in this invoice.

subtotal

number

Total package fees for this billing period, before tax is applied. This is the base amount used to compute total_amount.

tax_amount

number

Tax amount applied to the subtotal.

total_amount

number

Final invoice total (subtotal + tax_amount).

paid_amount

number

Cumulative sum of all payments recorded against this invoice. To compute the outstanding balance, subtract paid_amount from total_amount.

status

string

Current invoice status. One of:

draft — invoice has been computed but not yet published
published — invoice has been finalized and sent to the courier
paid — full payment has been recorded

created_at

string

UTC timestamp of when the invoice was created, in YYYY-MM-DD HH:MM:SS format.

Notes

To compute the outstanding balance on any invoice, subtract paid_amount from total_amount. A result of 0.00 indicates the invoice is fully settled, which will also be reflected by status: "paid".

Courier role users typically see only published and paid invoices. draft invoices are hidden from couriers until they are finalized and published by an admin or manager through the billing UI.

​Endpoint

​Authentication

​Role-Based Scoping

​Example Request

​Response

​200 — Success

​Response Fields

​Notes

Endpoint

Authentication

Role-Based Scoping

Example Request

Response

200 — Success

Response Fields

Notes