---
title: "Retrieves a CustomerInvoice resource."
method: GET
path: "/customer-invoices/{id}"
tags: ["Customer Order"]
---

# Retrieves a CustomerInvoice resource.

`GET /customer-invoices/{id}`

## Request

- Base URL: `http://localhost:8000/api/shop`
- URL: `http://localhost:8000/api/shop/customer-invoices/{id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/bagisto/apis/bagisto-shop-api/docs/customer-invoices/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a CustomerInvoice resource.

## Path parameters

- `id` string, required

## Headers

- `X-STOREFRONT-KEY` string, required
- `X-Locale` string
- `X-Channel` string
- `X-Currency` string

## Response `200`

CustomerInvoice resource

- CustomerInvoice: Customer Invoice API Resource Returns invoices belonging to authenticated customer's orders. Read-only, customer-scoped via order relationship. Supports PDF download via separate route.
  - `id` integer
  - `incrementId` string, nullable
  - `state` string, nullable
  - `emailSent` boolean
  - `totalQty` integer, nullable
  - `baseCurrencyCode` string, nullable
  - `channelCurrencyCode` string, nullable
  - `orderCurrencyCode` string, nullable
  - `subTotal` number, nullable
  - `baseSubTotal` number, nullable
  - `grandTotal` number, nullable
  - `baseGrandTotal` number, nullable
  - `shippingAmount` number, nullable
  - `baseShippingAmount` number, nullable
  - `taxAmount` number, nullable
  - `baseTaxAmount` number, nullable
  - `discountAmount` number, nullable
  - `baseDiscountAmount` number, nullable
  - `shippingTaxAmount` number
  - `baseShippingTaxAmount` number
  - `subTotalInclTax` number
  - `baseSubTotalInclTax` number
  - `shippingAmountInclTax` number
  - `baseShippingAmountInclTax` number
  - `transactionId` string, nullable
  - `reminders` integer
  - `nextReminderAt` string, date-time, nullable
  - `createdAt` string, date-time, nullable
  - `updatedAt` string, date-time, nullable
  - `downloadUrl` string
  - `items` string[]
  - `addresses` string[]

## Other responses

- `404`: Not found

---

[API](https://skmtc.dev/bagisto/apis/bagisto-shop-api.md) - [All operations](https://skmtc.dev/bagisto/apis/bagisto-shop-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bagisto/apis/bagisto-shop-api/revisions/f619df36bf29?raw)
