---
title: "Get invoice by ID"
method: GET
path: "/invoices/{invoice_id}"
tags: ["Invoices"]
---

# Get invoice by ID

`GET /invoices/{invoice_id}`

## Request

- Base URL: `https://api.streamtime.net/v2`
- URL: `https://api.streamtime.net/v2/invoices/{invoice_id}`
- Auth: HTTP bearer

## Path parameters

- `invoice_id` integer, required

## Response `200`

Invoice fetched.

- Invoice: Invoice details and totals
  - `id` integer: Invoice ID
  - `createdUserId` integer: Created by (display name)
  - `sentByUserId` integer, nullable: Who the invoice was sent by
  - `sentDate` string, date, nullable: Date the invoice was sent
  - `jobId` integer: Job ID that this invoice relates to
  - `name` string: Invoice name/title
  - `number` string, nullable: Invoice number
  - `reference` string, nullable: Reference shown on the invoice
  - `invoiceType` InvoiceType: Type of an invoice
    - `id` 1 | 2: Invoice Type ID (1=Invoice, 2=Credit Note)
    - `name` string
  - `invoiceStatus` InvoiceStatus: Status of an invoice
    - `id` 1 | 2 | 3 | 4 | 5: Company status ID (1=Draft, 2=Awaiting Payment, 3=Paid, 4=Deleted, 5=Voided)
    - `name` string
  - `currencyCode` string: Currency code (ISO 4217)
  - `exchangeRate` number, float: Exchange rate used for this invoice
  - `discount` number, float, nullable: Discount percentage applied
  - `instalment` number, float, nullable: Instalment percentage (if invoiced by instalments)
  - `invoiceCurrencyAmountPaidIncTax` number, float, nullable: Amount paid including tax (invoice currency)
  - `invoiceCurrencyTotalAmountExTax` number, float: Total amount excluding tax (invoice currency)
  - `invoiceCurrencyTotalAmountTax` number, float: Total tax amount (invoice currency)
  - `invoiceCurrencyTotalAmountIncTax` number, float: Total amount including tax (invoice currency)
  - `invoiceCurrencyBalance` number, float: Balance remaining (invoice currency)
  - `createdDatetime` string, date-time: Created timestamp
  - `invoiceDate` string, date: Invoice date
  - `dueDate` string, date, nullable: Due date
  - `paidDate` string, date, nullable: Paid date
  - `externalAccountingPlatformId` integer, nullable: External accounting platform ID
  - `externalInvoiceId` string, nullable: External invoice ID

---

[API](https://skmtc.dev/streamtime/apis/public-api.md) · [All operations](https://skmtc.dev/streamtime/apis/public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/streamtime/apis/public-api/revisions/cda8d1405534?raw)