Get invoice using specific key.
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
invoice_view| Name | Description | Type | Additional 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 | |
| db_currency_id |
Key of db_currency entity, identifies the db_currency of the invoice |
globally unique identifier | |
| total_taxes |
Total taxes |
decimal number | |
| due_date |
The due date |
date | |
| source_db_table_name |
The name of db table |
string | |
| delivery_name |
The delivery name |
string | |
| delivery_street |
The street for delivery |
string | |
| delivery_city |
The city for delivery |
string | |
| delivery_zip |
The zip for delivery |
string | |
| delivery_db_country_name |
The country name for delivery |
string | |
| reference_back_office |
Reference data for back office |
string | |
| db_payment_method_id |
Payment method id |
globally unique identifier | |
| id2 |
id for internal |
integer | |
| customer_remarks |
Customer remarks |
string | |
| bill_to_party |
The bill to party |
string | |
| bill_to_contact_id |
Contact id for bill |
globally unique identifier | |
| contact_id |
Contact id of invoice |
globally unique identifier | |
| article_price_label_id |
Article price label id |
globally unique identifier | |
| db_language_id |
The language id |
globally unique identifier | |
| invoice_status_id |
The status id of invoice |
globally unique identifier | |
| invoice_status_name |
The status name of invoice |
string | |
| discount_group_id |
The id of discount group |
globally unique identifier | |
| discount |
Discount value |
decimal number | |
|
The email |
string | ||
| invoice_number |
Invoice number |
string | |
| bill_to_company_id |
Company id for bill |
globally unique identifier | |
| dateutc_confirmation |
The confirmation date (UTC) |
date | |
| 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 | |
| db_payment_method_name |
Payment method name of the invoice |
string | |
| db_payment_method_pm |
Payment method pm of the invoice |
string |
Response Formats
application/json, text/json
{
"id": "99b9d45c-1ed9-4e48-88ad-08627f8fdcf7",
"internal_number": "sample string 2",
"company_id": "ba346cea-80df-4890-b877-3f660414474b",
"company_code": "sample string 4",
"company_name": "sample string 5",
"company_email": "sample string 6",
"company_phone": "sample string 7",
"date_create": "2025-11-24T07:42:22.8840973+00:00",
"memo": "sample string 9",
"description": "sample string 10",
"invoice_type": "sample string 11",
"source_type": "sample string 12",
"source_id_in_table": "0307581f-a5d3-410e-a6aa-b75dbcf5f416",
"total_lines": 14,
"total_amount": 15.0,
"db_currency_id": "0f1838f4-4029-4654-8942-7a5d0b152ebe",
"total_taxes": 17.0,
"due_date": "2025-11-24T07:42:22.8840973+00:00",
"source_db_table_name": "sample string 19",
"delivery_name": "sample string 20",
"delivery_street": "sample string 21",
"delivery_city": "sample string 22",
"delivery_zip": "sample string 23",
"delivery_db_country_name": "sample string 24",
"reference_back_office": "sample string 25",
"db_payment_method_id": "c316a561-d1c0-4824-9d91-2e5f93b1dc4b",
"id2": 27,
"customer_remarks": "sample string 28",
"bill_to_party": "sample string 29",
"bill_to_contact_id": "6b29aa16-a999-4641-bb9c-27cdefa72962",
"contact_id": "b4ffcd54-e463-4e17-a641-5a922a49fde4",
"article_price_label_id": "a9fa1d76-c431-4735-8a29-817f05b9e3fd",
"db_language_id": "1f5f73e4-705d-40e1-9239-7eac261a7a3c",
"invoice_status_id": "f20971f0-bfc0-46ab-b725-d79a108e90e1",
"invoice_status_name": "sample string 35",
"discount_group_id": "926e8e03-c33e-402b-8375-a3d986286dff",
"discount": 37.0,
"email": "sample string 38",
"invoice_number": "sample string 39",
"bill_to_company_id": "502be69d-e680-42e6-9d9b-d30e6c4d45f7",
"dateutc_confirmation": "2025-11-24T07:42:22.8840973+00:00",
"modified_dateutc": "2025-11-24T07:42:22.8840973+00:00",
"invoice_details": [
{
"id": "805da138-440c-45dd-8ba7-3615fe5855de",
"invoice_id": "b89bff59-7a5e-49fd-aeaa-13bafef9a942",
"article_id": "10bdd26c-983f-44aa-bf25-aa1b0147bf21",
"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,
"source_db_table_name": "sample string 17",
"source_id_in_table": "5f7e1040-95c3-4267-a561-531d90215e03",
"serial_number": "sample string 19",
"no_warranty_reason": "sample string 20",
"is_under_warranty": true,
"discount_percentage": 22.0,
"cost_price": 23.0,
"company_vat_id": "f96c8ca7-ddb0-449a-93d9-688e8dd2ca54",
"company_vat_code": "sample string 25",
"modified_dateutc": "2025-11-24T07:42:22.8840973+00:00"
},
{
"id": "805da138-440c-45dd-8ba7-3615fe5855de",
"invoice_id": "b89bff59-7a5e-49fd-aeaa-13bafef9a942",
"article_id": "10bdd26c-983f-44aa-bf25-aa1b0147bf21",
"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,
"source_db_table_name": "sample string 17",
"source_id_in_table": "5f7e1040-95c3-4267-a561-531d90215e03",
"serial_number": "sample string 19",
"no_warranty_reason": "sample string 20",
"is_under_warranty": true,
"discount_percentage": 22.0,
"cost_price": 23.0,
"company_vat_id": "f96c8ca7-ddb0-449a-93d9-688e8dd2ca54",
"company_vat_code": "sample string 25",
"modified_dateutc": "2025-11-24T07:42:22.8840973+00:00"
}
],
"db_payment_method_name": "sample string 43",
"db_payment_method_pm": "sample string 44"
}