Retrieves the invoice with the specified key

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
key

invoice.id

 globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult

invoice_view
NameDescriptionTypeAdditional information
id

Primary key

 globally unique identifier

Required
id2

Internal numeric ID (when reference_back_office is empty)

 integer
reference_back_office

Back office reference

 string

Max length: 50
invoice_number

Invoice number - unique identifier

 string
dateutc_confirmation

Date and time when the invoice was confirmed in UTC

 date
total_vat

Total taxes/VAT - rounded to 2 decimal places

 decimal number
net_amount

Net amount (total without tax) - rounded to 2 decimal places

 decimal number
total_amount

Total amount (net_amount + total_vat)

 decimal number
source

Source of the invoice When invoice.source_db_table_id = '00000000-0000-0000-0000-000000000000', then source='Manual' When source table is contract, then source=contract number When source table is job_approval, then source=reference_back_office or id2 of root job When source table is invoice (for credit note), then source=invoice.invoice_number

 string
invoice_type

Invoice type: 'Invoice' or 'CreditNote'

 string
modified_dateutc

Modified date UTC (system field, readonly)

 date

Response Formats

application/json, text/json

Sample: 
{
  "id": "56f83740-b7de-414e-9554-b9514addc414",
  "id2": 2,
  "reference_back_office": "sample string 3",
  "invoice_number": "sample string 4",
  "dateutc_confirmation": "2026-06-18T15:19:30.5062509+00:00",
  "total_vat": 6.0,
  "net_amount": 7.0,
  "total_amount": 8.0,
  "source": "sample string 9",
  "invoice_type": "sample string 10",
  "modified_dateutc": "2026-06-18T15:19:30.5062509+00:00"
}

application/xml, text/xml

Sample: 
<invoice_view xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <dateutc_confirmation>2026-06-18T15:19:30.506Z</dateutc_confirmation>
  <id>56f83740-b7de-414e-9554-b9514addc414</id>
  <id2>2</id2>
  <invoice_number>sample string 4</invoice_number>
  <invoice_type>sample string 10</invoice_type>
  <modified_dateutc>2026-06-18T15:19:30.506Z</modified_dateutc>
  <net_amount>7</net_amount>
  <reference_back_office>sample string 3</reference_back_office>
  <source>sample string 9</source>
  <total_amount>8</total_amount>
  <total_vat>6</total_vat>
</invoice_view>