Get invoice using specific key.

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

invoice_view
NameDescriptionTypeAdditional information
id

Primary Key

globally unique identifier
internal_number

Internal number to identify the invoice

string
company_id

Foreign key to company, identifies the company of the invoice

globally unique identifier
company_code

Company code of the invoice

string
company_name

Company name of the invoice

string
company_email

Company email of the invoice

string
company_phone

Company phone of the invoice

string
date_create

Invoice creation date in utc

date
memo

Memo field for invoice

string
description

Decription field for invoice

string
invoice_type

Invoice type, possible values “ContractGenerated“ and “WorkOrderApproval“

string
source_type

Source of invoice, refers to the type of the object from which invoice is derived

string
source_id_in_table

Key of the object from which the invoice is derived

globally unique identifier
total_lines

Total amount of lines linked to the invoice

integer
total_amount

Total value of items in lines linked to the invoice

decimal number
modified_dateutc

Readonly system field managed by database, filled with GetUtcDate when adding,updating

date
invoice_details

Details of invoice

Collection of invoice_details_view

Response Formats

application/json, text/json

Sample:
{
  "id": "16c802ab-496b-49c8-8e8a-5794c65cfb5a",
  "internal_number": "sample string 2",
  "company_id": "024d4374-e556-48c0-8b7a-9fea3c645ef3",
  "company_code": "sample string 4",
  "company_name": "sample string 5",
  "company_email": "sample string 6",
  "company_phone": "sample string 7",
  "date_create": "2025-06-21T11:21:02.5345316+00:00",
  "memo": "sample string 9",
  "description": "sample string 10",
  "invoice_type": "sample string 11",
  "source_type": "sample string 12",
  "source_id_in_table": "38fe0345-5f6b-4b7c-96a0-4e6943d11d94",
  "total_lines": 14,
  "total_amount": 15.0,
  "modified_dateutc": "2025-06-21T11:21:02.5345316+00:00",
  "invoice_details": [
    {
      "id": "6bc3d456-bf90-4c5b-aaac-be25b58ebccd",
      "invoice_id": "3952d765-1fd7-43a8-b8dc-07fcf6b55efd",
      "article_id": "436829bf-f261-414a-9c4b-00ca1d9aaee8",
      "article_name": "sample string 4",
      "article_description": "sample string 5",
      "article_code": "sample string 6",
      "line_num": 7,
      "quantity_decimal": 9.0,
      "article_price": 10.0,
      "discount": 11.0,
      "vat_rate": 12.0,
      "vat_value": 13.0,
      "total_vat": 14.0,
      "total_line": 15.0,
      "total_line_with_vat": 16.0,
      "modified_dateutc": "2025-06-21T11:21:02.5345316+00:00"
    },
    {
      "id": "6bc3d456-bf90-4c5b-aaac-be25b58ebccd",
      "invoice_id": "3952d765-1fd7-43a8-b8dc-07fcf6b55efd",
      "article_id": "436829bf-f261-414a-9c4b-00ca1d9aaee8",
      "article_name": "sample string 4",
      "article_description": "sample string 5",
      "article_code": "sample string 6",
      "line_num": 7,
      "quantity_decimal": 9.0,
      "article_price": 10.0,
      "discount": 11.0,
      "vat_rate": 12.0,
      "vat_value": 13.0,
      "total_vat": 14.0,
      "total_line": 15.0,
      "total_line_with_vat": 16.0,
      "modified_dateutc": "2025-06-21T11:21:02.5345316+00:00"
    }
  ]
}