> ## Documentation Index
> Fetch the complete documentation index at: https://sendcloud.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# Retrieve an invoice item
> Retrieve a single invoice item by id.
The item may be **invoiced** (`invoice_id` set, `tax` and `tax_rate` populated) or **pending** (`invoice_id`, `tax`, and `tax_rate` are `null`).
Pending invoice items (where `invoice_id` is `null`) are **not final**. Amounts and types can still change, and Sendcloud may remove items, up until they are consolidated onto an invoice. Treat pending items as a preview, not a guarantee.
This endpoint is currently in **beta**. Its shape may change in backwards-incompatible ways while we collect feedback.
## OpenAPI
````yaml /.openapi/v3/invoice-items/openapi.yaml get /invoice-items/{invoice_item_id}
openapi: 3.1.0
info:
title: Invoice Items API
version: 3.0.0
contact:
name: Sendcloud API Support
url: https://www.sendcloud.dev
email: contact@sendcloud.com
description: >-
The Invoice Items API lets you retrieve the billable line items charged to
your Sendcloud account, including pending items that have not yet been
consolidated onto an invoice.
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://panel.sendcloud.sc/api/v3
description: Sendcloud Production
security: []
tags:
- name: Invoice Items
description: >-
A single billable line — for example a parcel fee, a pickup fee, or a
subscription charge.
paths:
/invoice-items/{invoice_item_id}:
parameters:
- schema:
type: integer
in: path
name: invoice_item_id
description: The id of the invoice item.
required: true
get:
tags:
- Invoice Items
summary: Retrieve an invoice item
description: >-
Retrieve a single invoice item by id.
The item may be **invoiced** (`invoice_id` set, `tax` and `tax_rate`
populated) or **pending** (`invoice_id`, `tax`, and `tax_rate` are
`null`).
Pending invoice items (where `invoice_id` is `null`) are **not final**. Amounts and types can still change, and Sendcloud may remove items, up until they are consolidated onto an invoice. Treat pending items as a preview, not a guarantee.
This endpoint is currently in **beta**. Its shape may change in backwards-incompatible ways while we collect feedback.
operationId: sc-public-v3-scp-get-invoice_item
responses:
'200':
description: OK
content:
application/json:
schema:
description: Retrieve invoice item
type: object
properties:
data:
$ref: '#/components/schemas/invoice-item'
required:
- data
examples:
RetrieveInvoiceItem:
summary: Retrieve an invoice item
value:
data:
id: 1042
type: shipment
description: Parcel 99887766 — NL → DE
created_at: '2026-05-14T08:21:00Z'
updated_at: '2026-05-14T08:21:00Z'
price:
value: '5.4200'
currency: EUR
tax:
value: '1.1382'
currency: EUR
tax_rate: '0.21'
vat_code: NL_STANDARD
reference: '99887766'
parcel_id: 99887766
pickup_id: null
carrier_id: 17
from_country: NL
invoice_id: 5501
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/errors'
examples:
Unauthorized:
summary: Missing or invalid credentials
value:
errors:
- detail: Authentication credentials were not provided.
status: '401'
code: not_authenticated
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/errors'
examples:
NotFound:
summary: Invoice item not found
value:
errors:
- detail: Not found.
status: '404'
code: not_found
'429':
description: Throttled
security:
- HTTPBasicAuth: []
- OAuth2ClientCreds: []
components:
schemas:
invoice-item:
title: InvoiceItem
description: >-
A single billable line on an invoice (or a pending, not-yet-invoiced
item).
type: object
properties:
id:
type: integer
format: int64
minimum: 1
description: Unique identifier of the invoice item.
type:
type: string
description: The category of the invoice item.
enum:
- addon
- addon_refund
- carrier_impl_fee
- carrier_parcel_fee
- claim
- coulance
- customer_impl_fee
- earned_credit
- fuel_refund
- fuel_surcharge
- import_adm_fee
- import_duties
- import_vat
- insurance
- insurance_refund
- invoice_check_fee
- invoice_check_fee_refund
- notification
- overcharge_fee
- parcel_cancelled
- parcel_fee
- parcel_fee_refund
- pickup
- pickup_cancelled
- pickup_subscription
- refund
- shipment
- subscription
- subscription_refund
- surcharge
- surcharge_refund
- unblock
- validation
example: shipment
description:
type: string
description: Human-readable description of the invoice item.
created_at:
type: string
format: date-time
description: Date the invoice item was created (the billing date of the item).
updated_at:
type:
- string
- 'null'
format: date-time
description: >-
Date the invoice item was last updated. Null if it has never been
updated.
price:
$ref: '#/components/schemas/price'
tax:
oneOf:
- $ref: '#/components/schemas/price'
- type: 'null'
description: >-
Tax amount for this item. Null for pending items: the tax rate is
only
populated when the item is invoiced.
tax_rate:
type:
- string
- 'null'
description: >-
Tax rate applied to the price (e.g. '0.21' for 21%). Null until the
item is invoiced.
example: '0.21'
vat_code:
type:
- string
- 'null'
description: VAT code applied to this item. Null if no VAT code applies.
reference:
type: string
description: External reference for this invoice item.
parcel_id:
type:
- integer
- 'null'
description: Identifier of the parcel this item relates to, when applicable.
pickup_id:
type:
- integer
- 'null'
description: Identifier of the pickup this item relates to, when applicable.
carrier_id:
type:
- integer
- 'null'
description: Identifier of the carrier this item relates to, when applicable.
from_country:
type: string
description: Origin country of the item, as an ISO 3166-1 alpha-2 code.
example: NL
invoice_id:
type:
- integer
- 'null'
description: >-
Identifier of the invoice this item belongs to. Null for pending
items that have not yet been invoiced.
required:
- id
- type
- description
- created_at
- updated_at
- price
- tax
- tax_rate
- vat_code
- reference
- parcel_id
- pickup_id
- carrier_id
- from_country
- invoice_id
errors:
title: Errors
type: object
description: A standardized format for errors in JSON:API responses.
properties:
errors:
type:
- array
- object
items:
type: object
allOf:
- $ref: '#/components/schemas/ErrorObject'
required:
- status
- code
- detail
price:
title: Price
description: >-
A money amount exposed at full database precision (up to 4 decimal
places).
Note: this representation uses 4-decimal precision (unlike the canonical
2-decimal Price model used elsewhere in the v3 API) because invoice
items
store amounts at the precision used by Sendcloud's billing engine.
type: object
properties:
value:
type: string
description: Monetary amount as a decimal string, with up to 4 decimal places.
example: '12.3456'
currency:
type: string
description: ISO 4217 currency code.
example: EUR
required:
- value
- currency
ErrorObject:
title: Error
type: object
description: Error in a JSON:API error format
properties:
id:
type: string
description: A unique identifier for the error.
links:
type: object
description: >-
A set of hyperlinks that provide additional information about the
error.
properties:
about:
type: string
description: A URL that provides additional information about the error.
status:
type: string
format: int32
description: The HTTP status code of the error.
minLength: 1
code:
type: string
description: A unique error code for the error, in snake case format.
minLength: 1
enum:
- unknown_field
- invalid
- forbidden
- invalid_choice
- min_value
- 'null'
- not_found
- required
- not_a_list
- non_field_errors
- authentication_failed
- validation_error
- parcel_announcement_error
title:
type: string
description: A short, human-readable summary of the error.
minLength: 1
detail:
type: string
description: A human-readable explanation of the error.
minLength: 1
source:
type: object
description: >-
An object that identifies the source of the error within the request
payload.
properties:
pointer:
type: string
description: >-
A `JSON` pointer to the location of the error within the request
payload.
parameter:
type: string
description: The name of the `query` parameter that caused the error.
header:
type: string
description: The name of the `header` parameter that caused the error.
meta:
type: object
description: Additional metadata about the error.
securitySchemes:
HTTPBasicAuth:
type: http
description: >-
Basic Authentication using API key and secrets is currently the main
authentication mechanism.
scheme: basic
OAuth2ClientCreds:
type: oauth2
description: >-
OAuth2 is a standardized protocol for authorization that allows users to
share their private resources stored on one site with another site
without having to provide their credentials. OAuth2 Client Credentials
Grant workflow. This workflow is typically used for server-to-server
interactions that require authorization to access specific resources.
flows:
clientCredentials:
tokenUrl: https://account.sendcloud.com/oauth2/token/
scopes:
api: Default OAuth scope required to access Sendcloud API.
````