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": "95b991f8-939c-4e5c-99bb-8883d8d541c5",
"internal_number": "sample string 2",
"company_id": "9d18b948-cfd8-429a-8c29-177b6f009158",
"company_code": "sample string 4",
"company_name": "sample string 5",
"company_email": "sample string 6",
"company_phone": "sample string 7",
"date_create": "2025-10-14T21:38:53.6580706+00:00",
"memo": "sample string 9",
"description": "sample string 10",
"invoice_type": "sample string 11",
"source_type": "sample string 12",
"source_id_in_table": "220e726c-4c1a-4bc6-92b1-2eec9f350fc7",
"total_lines": 14,
"total_amount": 15.0,
"db_currency_id": "df118137-e011-4ded-ac6c-36b50741d7e5",
"total_taxes": 17.0,
"due_date": "2025-10-14T21:38:53.6580706+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": "c13fd7d8-b90d-4a59-b931-dfff432f4d96",
"id2": 27,
"customer_remarks": "sample string 28",
"bill_to_party": "sample string 29",
"bill_to_contact_id": "9df53774-c978-46c9-b12c-ea76925828ce",
"contact_id": "aad46581-9383-4d28-a1b1-328235113ad3",
"article_price_label_id": "b9a1678c-ff0f-4eb2-abc9-5ac2e9ee35ad",
"db_language_id": "d83f02c0-34dc-46ce-a9bf-d5f6e7bd1900",
"invoice_status_id": "4fbb9af8-59da-41e0-adae-9e70c761a2b2",
"invoice_status_name": "sample string 35",
"discount_group_id": "71e1e4e5-58bb-4f93-a8c0-0497081f3b28",
"discount": 37.0,
"email": "sample string 38",
"invoice_number": "sample string 39",
"bill_to_company_id": "77d6015e-d0ac-402c-a887-6c914a6c371b",
"dateutc_confirmation": "2025-10-14T21:38:53.6580706+00:00",
"modified_dateutc": "2025-10-14T21:38:53.6580706+00:00",
"invoice_details": [
{
"id": "02edb021-a90f-4afe-ba56-a679f15dc130",
"invoice_id": "e9a1caaf-d6cd-43ac-a691-07833a4091f7",
"article_id": "26f783c6-1cf0-48ff-ad26-bd7f8dfb31c4",
"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": "76bb9df1-5af8-4844-9980-1e5dfa3f4896",
"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": "62ddd849-fd9f-45c6-b3e6-272fe540d092",
"company_vat_code": "sample string 25",
"modified_dateutc": "2025-10-14T21:38:53.6580706+00:00"
},
{
"id": "02edb021-a90f-4afe-ba56-a679f15dc130",
"invoice_id": "e9a1caaf-d6cd-43ac-a691-07833a4091f7",
"article_id": "26f783c6-1cf0-48ff-ad26-bd7f8dfb31c4",
"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": "76bb9df1-5af8-4844-9980-1e5dfa3f4896",
"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": "62ddd849-fd9f-45c6-b3e6-272fe540d092",
"company_vat_code": "sample string 25",
"modified_dateutc": "2025-10-14T21:38:53.6580706+00:00"
}
],
"db_payment_method_name": "sample string 43",
"db_payment_method_pm": "sample string 44"
}