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": "1e5a62f5-a6e8-4410-8b2c-882e6921b69a",
"internal_number": "sample string 2",
"company_id": "31235460-591d-4bf7-840a-859624fe700f",
"company_code": "sample string 4",
"company_name": "sample string 5",
"company_email": "sample string 6",
"company_phone": "sample string 7",
"date_create": "2025-08-21T11:05:23.7688519+00:00",
"memo": "sample string 9",
"description": "sample string 10",
"invoice_type": "sample string 11",
"source_type": "sample string 12",
"source_id_in_table": "1f6c4fb3-5ff9-46af-97f9-51bd82b01a9f",
"total_lines": 14,
"total_amount": 15.0,
"db_currency_id": "62f1bdc7-57dd-4265-94cc-ca6451c46f68",
"total_taxes": 17.0,
"due_date": "2025-08-21T11:05:23.7688519+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": "0098e322-504f-4fdb-8317-f97845d6bb93",
"id2": 27,
"customer_remarks": "sample string 28",
"bill_to_party": "sample string 29",
"bill_to_contact_id": "7027a087-f9b7-44ba-beda-2d1d82cb572d",
"contact_id": "4de94a63-163e-4ccc-a1b5-45a66324f3fb",
"article_price_label_id": "6fb0da36-0ac0-420b-91df-720d08907c0c",
"db_language_id": "f11a1eef-36fb-4385-b933-9083a95a3b7f",
"invoice_status_id": "dd1d90e9-6d9c-4e98-873c-e21a055d43bf",
"invoice_status_name": "sample string 35",
"discount_group_id": "cb81243c-77da-46b3-9f06-1e05d0e95add",
"discount": 37.0,
"email": "sample string 38",
"invoice_number": "sample string 39",
"bill_to_company_id": "794723b6-f752-4dd6-a694-0040c3155d00",
"dateutc_confirmation": "2025-08-21T11:05:23.7688519+00:00",
"modified_dateutc": "2025-08-21T11:05:23.7688519+00:00",
"invoice_details": [
{
"id": "eca1ab2e-6bd5-4757-97d4-73f4e08b35e4",
"invoice_id": "729cd3c7-4d69-432c-bea0-b8db66957093",
"article_id": "0895817f-3d50-4455-b7bc-2af2fe4b22ca",
"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": "a04b567d-d7b5-4eb4-8967-daed25d2479a",
"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": "b2f663a5-b0c6-4162-a610-3933827bd574",
"company_vat_code": "sample string 25",
"modified_dateutc": "2025-08-21T11:05:23.7688519+00:00"
},
{
"id": "eca1ab2e-6bd5-4757-97d4-73f4e08b35e4",
"invoice_id": "729cd3c7-4d69-432c-bea0-b8db66957093",
"article_id": "0895817f-3d50-4455-b7bc-2af2fe4b22ca",
"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": "a04b567d-d7b5-4eb4-8967-daed25d2479a",
"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": "b2f663a5-b0c6-4162-a610-3933827bd574",
"company_vat_code": "sample string 25",
"modified_dateutc": "2025-08-21T11:05:23.7688519+00:00"
}
],
"db_payment_method_name": "sample string 43",
"db_payment_method_pm": "sample string 44"
}