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_idinteger required

Response

Invoice fetched.

idinteger

Invoice ID

createdUserIdinteger

Created by (display name)

sentByUserIdinteger nullable

Who the invoice was sent by

sentDatestring date nullable

Date the invoice was sent

jobIdinteger

Job ID that this invoice relates to

namestring

Invoice name/title

numberstring nullable

Invoice number

referencestring nullable

Reference shown on the invoice

currencyCodestring

Currency code (ISO 4217)

exchangeRatenumber float

Exchange rate used for this invoice

discountnumber float nullable

Discount percentage applied

instalmentnumber float nullable

Instalment percentage (if invoiced by instalments)

invoiceCurrencyAmountPaidIncTaxnumber float nullable

Amount paid including tax (invoice currency)

invoiceCurrencyTotalAmountExTaxnumber float

Total amount excluding tax (invoice currency)

invoiceCurrencyTotalAmountTaxnumber float

Total tax amount (invoice currency)

invoiceCurrencyTotalAmountIncTaxnumber float

Total amount including tax (invoice currency)

invoiceCurrencyBalancenumber float

Balance remaining (invoice currency)

createdDatetimestring date-time

Created timestamp

invoiceDatestring date

Invoice date

dueDatestring date nullable

Due date

paidDatestring date nullable

Paid date

externalAccountingPlatformIdinteger nullable

External accounting platform ID

externalInvoiceIdstring nullable

External invoice ID

Example response

{
  "sentDate": "2025-01-15",
  "jobId": 1201,
  "name": "January 2025 Retainer",
  "number": "INV-2025-001",
  "reference": "PO-987654",
  "currencyCode": "USD",
  "exchangeRate": 1,
  "discount": 10,
  "instalment": 50,
  "invoiceCurrencyAmountPaidIncTax": 1250,
  "invoiceCurrencyTotalAmountExTax": 2500,
  "invoiceCurrencyTotalAmountTax": 375,
  "invoiceCurrencyTotalAmountIncTax": 2875,
  "invoiceCurrencyBalance": 1625,
  "createdDatetime": "2025-01-10 09:30:00",
  "invoiceDate": "2025-01-10",
  "dueDate": "2025-01-31",
  "paidDate": "2025-01-20",
  "externalAccountingPlatformId": 3,
  "externalInvoiceId": "INV-EXT-12345"
}

Changes

No recorded changes to this operation across all 1 revision of this API.