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": "1445ec0c-c144-4e2f-a5e6-04b2e5ac451d",
"internal_number": "sample string 2",
"company_id": "18da7a51-9983-4139-8fc5-07d7fe8d6ba0",
"company_code": "sample string 4",
"company_name": "sample string 5",
"company_email": "sample string 6",
"company_phone": "sample string 7",
"date_create": "2025-06-27T16:05:13.5488522+00:00",
"memo": "sample string 9",
"description": "sample string 10",
"invoice_type": "sample string 11",
"source_type": "sample string 12",
"source_id_in_table": "c700687e-b859-4193-be70-98099335e3f6",
"total_lines": 14,
"total_amount": 15.0,
"db_currency_id": "1c1cecd0-df9e-4eac-b04d-99bd68756e4c",
"total_taxes": 17.0,
"due_date": "2025-06-27T16:05:13.5488522+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": "f5167496-b5a1-4c31-bb7a-b4b00bd87c2a",
"id2": 27,
"customer_remarks": "sample string 28",
"bill_to_party": "sample string 29",
"bill_to_contact_id": "687ed459-d0e3-4fd3-bac6-9e478c94d3e1",
"contact_id": "c0d32dfd-92e1-401b-bd49-a6721bf0f778",
"article_price_label_id": "7ff3d739-4fdc-4cb9-a5bb-85c80b1ebcbc",
"db_language_id": "fe76e24b-69ea-4361-869b-b57cea140ca1",
"invoice_status_id": "dc9b6900-82ac-4a6d-b33d-09101dac4f57",
"invoice_status_name": "sample string 35",
"discount_group_id": "d5afe739-e144-417f-8a36-be3e906f029d",
"discount": 37.0,
"email": "sample string 38",
"invoice_number": "sample string 39",
"bill_to_company_id": "41891e32-1096-422c-849d-cea5c80345ef",
"dateutc_confirmation": "2025-06-27T16:05:13.5686064+00:00",
"modified_dateutc": "2025-06-27T16:05:13.5686064+00:00",
"invoice_details": [
{
"id": "f75e998f-249c-4a83-a11b-59272badbedd",
"invoice_id": "ee426719-caca-4c72-af88-1df5f34fcb3f",
"article_id": "1bdfdad6-8067-4308-a4b3-0bc1bbc22512",
"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": "ba3e842f-cdbd-4067-87fd-22a8fee0f271",
"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": "d212731f-b4ef-4e4f-ba27-cfa0e618614c",
"company_vat_code": "sample string 25",
"modified_dateutc": "2025-06-27T16:05:13.5686064+00:00"
},
{
"id": "f75e998f-249c-4a83-a11b-59272badbedd",
"invoice_id": "ee426719-caca-4c72-af88-1df5f34fcb3f",
"article_id": "1bdfdad6-8067-4308-a4b3-0bc1bbc22512",
"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": "ba3e842f-cdbd-4067-87fd-22a8fee0f271",
"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": "d212731f-b4ef-4e4f-ba27-cfa0e618614c",
"company_vat_code": "sample string 25",
"modified_dateutc": "2025-06-27T16:05:13.5686064+00:00"
}
],
"db_payment_method_name": "sample string 43",
"db_payment_method_pm": "sample string 44"
}