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": "b8f7bc44-f744-4771-8777-13adf1911542",
"internal_number": "sample string 2",
"company_id": "6dcf83b7-c9b0-4348-8525-263c7ad1c537",
"company_code": "sample string 4",
"company_name": "sample string 5",
"company_email": "sample string 6",
"company_phone": "sample string 7",
"date_create": "2026-05-24T22:28:27.7751524+00:00",
"memo": "sample string 9",
"description": "sample string 10",
"invoice_type": "sample string 11",
"source_type": "sample string 12",
"source_id_in_table": "d37075e5-cc99-495d-8051-cd8445b21992",
"total_lines": 14,
"total_amount": 15.0,
"db_currency_id": "6b209fd8-1afa-4d66-873f-6bad23cc86a0",
"total_taxes": 17.0,
"due_date": "2026-05-24T22:28:27.7751524+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": "2fb42776-52b9-41e3-9e1f-59060b49e2d2",
"id2": 27,
"customer_remarks": "sample string 28",
"bill_to_party": "sample string 29",
"bill_to_contact_id": "c67903e2-b9ef-43be-bf25-f5fd2a0bf387",
"contact_id": "35091463-e80b-4df6-857d-e511fcd16de5",
"article_price_label_id": "4ac0952c-b08f-40b4-bc36-352e2b3c92c6",
"db_language_id": "db292858-3851-43a7-aede-659d2c42c853",
"invoice_status_id": "6ad4582b-6c1c-495b-9998-bc0a8ce40a6f",
"invoice_status_name": "sample string 35",
"discount_group_id": "ed5c6087-1a6f-4bcf-9a07-2eda2c27951a",
"discount": 37.0,
"email": "sample string 38",
"invoice_number": "sample string 39",
"bill_to_company_id": "0ec35bdd-f2f0-4315-a65a-1e3e922b9e04",
"dateutc_confirmation": "2026-05-24T22:28:27.7751524+00:00",
"modified_dateutc": "2026-05-24T22:28:27.7751524+00:00",
"invoice_details": [
{
"id": "d2f1eb7c-4918-4462-900f-e33ecc94a502",
"invoice_id": "6e9ae64d-bd0d-45d5-989b-00e5d697defb",
"article_id": "b3324f01-829a-4134-a310-45f018c0122f",
"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": "333c4e0f-8fe7-4494-b452-11bf5e68243c",
"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": "73086861-f425-479d-b4d4-1e85060d02c5",
"company_vat_code": "sample string 25",
"modified_dateutc": "2026-05-24T22:28:27.788078+00:00"
},
{
"id": "d2f1eb7c-4918-4462-900f-e33ecc94a502",
"invoice_id": "6e9ae64d-bd0d-45d5-989b-00e5d697defb",
"article_id": "b3324f01-829a-4134-a310-45f018c0122f",
"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": "333c4e0f-8fe7-4494-b452-11bf5e68243c",
"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": "73086861-f425-479d-b4d4-1e85060d02c5",
"company_vat_code": "sample string 25",
"modified_dateutc": "2026-05-24T22:28:27.788078+00:00"
}
],
"db_payment_method_name": "sample string 43",
"db_payment_method_pm": "sample string 44"
}