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": "41f6ab9d-22b5-4c51-8d77-e1375bc70541",
"internal_number": "sample string 2",
"company_id": "9f8d471a-44ab-4362-be79-65bb2887e5c7",
"company_code": "sample string 4",
"company_name": "sample string 5",
"company_email": "sample string 6",
"company_phone": "sample string 7",
"date_create": "2026-07-27T18:22:33.3153699+00:00",
"memo": "sample string 9",
"description": "sample string 10",
"invoice_type": "sample string 11",
"source_type": "sample string 12",
"source_id_in_table": "b15f5631-ef3b-48d2-a97f-0e7de220208d",
"total_lines": 14,
"total_amount": 15.0,
"db_currency_id": "49272f41-f6c2-4a49-8dca-4460b4d3bfcc",
"total_taxes": 17.0,
"due_date": "2026-07-27T18:22:33.3153699+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": "30ad9dda-fc88-492f-8867-11f5c95d884d",
"id2": 27,
"customer_remarks": "sample string 28",
"bill_to_party": "sample string 29",
"bill_to_contact_id": "691fbc3c-d4fb-49ca-8a1e-13815a6a733d",
"contact_id": "83762c9a-2629-453e-93fb-7e717a0c6827",
"article_price_label_id": "e84b9228-8b37-4e52-b552-6f725d5485ba",
"db_language_id": "e240225d-ec15-4b08-b8d2-8e12f6e22b5f",
"invoice_status_id": "d3969620-e475-4806-8958-ea2916156b33",
"invoice_status_name": "sample string 35",
"discount_group_id": "0afa1c9a-66ac-4360-81c1-f22de2605fe8",
"discount": 37.0,
"email": "sample string 38",
"invoice_number": "sample string 39",
"bill_to_company_id": "5931464c-7531-4f50-a7cc-d1805538e129",
"dateutc_confirmation": "2026-07-27T18:22:33.3153699+00:00",
"modified_dateutc": "2026-07-27T18:22:33.3153699+00:00",
"invoice_details": [
{
"id": "3ee6fc20-e08e-4ec9-89ef-72f11aa8c303",
"invoice_id": "ea864e21-409b-4583-b774-8bc51cde2ca0",
"article_id": "c306a3a2-4be9-4902-a12a-8bf9222ac863",
"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": "03cbe342-c6ef-41ae-9dc0-d1d47fc597b1",
"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": "ac2521fc-5f9a-4eb7-b48f-7ab4bbc68bd9",
"company_vat_code": "sample string 25",
"modified_dateutc": "2026-07-27T18:22:33.3153699+00:00"
},
{
"id": "3ee6fc20-e08e-4ec9-89ef-72f11aa8c303",
"invoice_id": "ea864e21-409b-4583-b774-8bc51cde2ca0",
"article_id": "c306a3a2-4be9-4902-a12a-8bf9222ac863",
"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": "03cbe342-c6ef-41ae-9dc0-d1d47fc597b1",
"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": "ac2521fc-5f9a-4eb7-b48f-7ab4bbc68bd9",
"company_vat_code": "sample string 25",
"modified_dateutc": "2026-07-27T18:22:33.3153699+00:00"
}
],
"db_payment_method_name": "sample string 43",
"db_payment_method_pm": "sample string 44"
}