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": "fe3c38d8-c76c-424d-a4bc-950c8a6bece3",
"internal_number": "sample string 2",
"company_id": "39dc5675-ed31-459b-bfb0-2504518570df",
"company_code": "sample string 4",
"company_name": "sample string 5",
"company_email": "sample string 6",
"company_phone": "sample string 7",
"date_create": "2025-10-13T17:06:18.8926356+00:00",
"memo": "sample string 9",
"description": "sample string 10",
"invoice_type": "sample string 11",
"source_type": "sample string 12",
"source_id_in_table": "fe02d8b7-c405-42bc-9962-6c218ca6cf32",
"total_lines": 14,
"total_amount": 15.0,
"db_currency_id": "d10eb65c-05d7-4cca-8dc0-4b0420226c22",
"total_taxes": 17.0,
"due_date": "2025-10-13T17:06:18.8926356+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": "2d0d0a2b-e948-46b6-a4b1-d101e6711ecb",
"id2": 27,
"customer_remarks": "sample string 28",
"bill_to_party": "sample string 29",
"bill_to_contact_id": "8bf974b4-0e9f-4e02-8f76-bcf0038a81a9",
"contact_id": "eb597245-a836-4bba-b6dc-d98b31f1f70b",
"article_price_label_id": "ff71e31c-7972-4b3d-99c9-8d53f9d5c240",
"db_language_id": "16c461d8-9e96-406b-a587-617b743d5216",
"invoice_status_id": "83b58285-112e-43e8-8330-9dfee1f1a6ec",
"invoice_status_name": "sample string 35",
"discount_group_id": "88cf0d3c-656a-424a-9c26-f70f75a8cb48",
"discount": 37.0,
"email": "sample string 38",
"invoice_number": "sample string 39",
"bill_to_company_id": "73e7db72-4e48-4a73-adae-fcdb4953f400",
"dateutc_confirmation": "2025-10-13T17:06:18.8926356+00:00",
"modified_dateutc": "2025-10-13T17:06:18.8926356+00:00",
"invoice_details": [
{
"id": "f6aee52c-9782-452e-a370-28c1ff154c2c",
"invoice_id": "df6d5fcb-3f19-4268-8497-a162d7c411f9",
"article_id": "b14ef779-d490-4b0b-8114-4855753d9683",
"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": "7980d570-167b-46d1-981c-1cd62b401f7e",
"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": "5845a045-d7e8-4862-9e38-3749682b5a9f",
"company_vat_code": "sample string 25",
"modified_dateutc": "2025-10-13T17:06:18.9050544+00:00"
},
{
"id": "f6aee52c-9782-452e-a370-28c1ff154c2c",
"invoice_id": "df6d5fcb-3f19-4268-8497-a162d7c411f9",
"article_id": "b14ef779-d490-4b0b-8114-4855753d9683",
"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": "7980d570-167b-46d1-981c-1cd62b401f7e",
"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": "5845a045-d7e8-4862-9e38-3749682b5a9f",
"company_vat_code": "sample string 25",
"modified_dateutc": "2025-10-13T17:06:18.9050544+00:00"
}
],
"db_payment_method_name": "sample string 43",
"db_payment_method_pm": "sample string 44"
}