> ## Documentation Index
> Fetch the complete documentation index at: https://docs.api.onechain-tms.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Fetch an invoice
> This endpoint returns the invoice corresponding to the given number.
## OpenAPI
````yaml openapi.json get /v1/invoices/{reference}
openapi: 3.1.0
info:
title: OneChain API
version: 1.3.2
x-logo:
href: https://www.onechain-tms.com
url: static/logo.png
servers:
- url: localhost:8080
security: []
tags:
- description: |-
This API lets you fetch your data from ONECHAIN's servers.
URL: https://api.onechain-tms.com
name: Introduction
x-displayName: Introduction
- description: >-
To safely access the resources exposed by our API, you will need to
provide an authenticated token in your requests headers. Please reach out
to your ONECHAIN’s Account Manager to get your token.
| Name of the header | Type of authentication |
|--------------------|------------------------|
| Authorization | API AUTHORIZATION KEY |
Please note that the API authorization key must be prefixed with "Bearer "
For example:
`Authorization: Bearer 1234567890`
name: Authentication
x-displayName: Authentication
- description: |-
All endpoints fetching multiple items are paginated.
Use `skip` to skip to the items you want to retrieve.
Use `take` to define how many items you want to retrieve.
`skip` and `take` are optional parameters.
If you do not input them, `skip` equals to 0 and `take` equals to 10.
Example:
`/v1/shipments?skip=20&take=10`
name: Pagination
x-displayName: Pagination
- name: Shipments
- name: Purchase Orders
- name: Documents
- name: Locations
- name: Invoices
- name: Users
- name: Reporting
- description:
name: ShipmentObject
x-displayName: ShipmentObject
- description:
name: TrackingObject
x-displayName: TrackingObject
- description:
name: OrderPreparationObject
x-displayName: OrderPreparationObject
- description:
name: PurchaseOrderObject
x-displayName: PurchaseOrderObject
- description:
name: TrackingEventObject
x-displayName: TrackingEventObject
- description:
name: TrackingDateObject
x-displayName: TrackingDateObject
- description:
name: TrackingStepObject
x-displayName: TrackingStepObject
- description:
name: ProductObject
x-displayName: ProductObject
- description:
name: PortObject
x-displayName: PortObject
- description:
name: CoordinatesObject
x-displayName: CoordinatesObject
- description:
name: ContainerObject
x-displayName: ContainerObject
- description:
name: UserObject
x-displayName: UserObject
- description:
name: LoadObject
x-displayName: LoadObject
- description:
name: DocumentObject
x-displayName: DocumentObject
- description:
name: InvoiceObject
x-displayName: InvoiceObject
- description:
name: LocationObject
x-displayName: LocationObject
- description:
name: PriceObject
x-displayName: PriceObject
- description:
name: QuantityObject
x-displayName: QuantityObject
- description:
name: SizeObject
x-displayName: SizeObject
- description:
name: VolumeObject
x-displayName: VolumeObject
- description:
name: WeightObject
x-displayName: WeightObject
- description:
name: SimpleDateObject
x-displayName: SimpleDateObject
- description:
name: DateWithTimeObject
x-displayName: DateWithTimeObject
paths:
/v1/invoices/{reference}:
get:
tags:
- Invoices
summary: Fetch an invoice
description: This endpoint returns the invoice corresponding to the given number.
parameters:
- schema:
type: string
in: path
name: reference
required: true
responses:
'200':
description: Fetch an invoice given its reference
content:
application/json:
schema:
$ref: '#/components/schemas/Invoice'
description: Fetch an invoice given its reference
'404':
description: Invoice not found
content:
application/json:
schema:
description: Invoice not found
type: object
components:
schemas:
Invoice:
modelName: Invoice
type: object
properties:
reference:
type: string
example: CDEF - 0342/7055 2022
number:
type: string
example: FAC2022-9567
onechain_shipment_id:
type: string
example: CDEF
type:
type: string
enum:
- invoice
- credit_note
default: invoice
status:
type: string
enum:
- available
- due
- in_modification
- litigious
- new
- paid
- partially_paid
- write_off
sent_date:
$ref: '#/components/schemas/DateWithTime'
due_date:
$ref: '#/components/schemas/SimpleDate'
lines:
type: array
items:
type: object
properties:
category:
type: string
enum:
- arrival_customs
- arrival_fees
- arrival_truck_freight
- arrival_logistics
- carbon_offset
- customs
- departure_customs
- departure_fees
- departure_logistics
- departure_truck_freight
- freight
- insurance
- other
description:
type: string
example: IMO Surcharge
price:
$ref: '#/components/schemas/Price'
quantity:
$ref: '#/components/schemas/Quantity'
unit_rate:
$ref: '#/components/schemas/Price'
vatRate:
type:
- 'null'
- number
format: integer
example: 20
usd_to_eur_rate:
type: number
format: float
example: 0.82
DateWithTime:
modelName: DateWithTime
type: string
example: '2021-09-20T10:02:09+01:00'
SimpleDate:
modelName: SimpleDate
type: string
example: '2021-10-11'
Price:
modelName: Price
type: object
properties:
amount:
type: number
format: float
example: 150357.99
currency:
type: string
enum:
- AED
- AUD
- BHD
- BRL
- CAD
- CHF
- CNY
- EUR
- GBP
- HKD
- IDR
- INR
- JPY
- MXN
- KRW
- KWD
- MYR
- NZD
- PLN
- SEK
- SGD
- THB
- TWD
- USD
- XOF
- XPF
- ZAR
example: USD
Quantity:
modelName: Quantity
type: object
properties:
value:
type: number
format: float
example: 350.25
unit:
type: string
enum:
- tc
- teu
- t
- pallet
- cbm
- kg
- cm
- chargeable_weight
- weight_measurement_lcl
- km
- 'null'
````