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": "5a7f58bb-01b7-47f1-9bed-47e08c5657fb",
"internal_number": "sample string 2",
"company_id": "c4bf6700-3d5a-4e92-9cf3-739c1796719e",
"company_code": "sample string 4",
"company_name": "sample string 5",
"company_email": "sample string 6",
"company_phone": "sample string 7",
"date_create": "2025-05-17T18:12:38.7018854+00:00",
"memo": "sample string 9",
"description": "sample string 10",
"invoice_type": "sample string 11",
"source_type": "sample string 12",
"source_id_in_table": "bc2c4c8e-0513-436a-ab3a-6704b87edc9a",
"total_lines": 14,
"total_amount": 15.0,
"db_currency_id": "21521e70-0dd9-43ad-947f-771da9a9b602",
"total_taxes": 17.0,
"due_date": "2025-05-17T18:12:38.7018854+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": "32bd3a37-8c82-4bd2-9350-a62b61e7f3c6",
"id2": 27,
"customer_remarks": "sample string 28",
"bill_to_party": "sample string 29",
"bill_to_contact_id": "38ce709b-2440-489d-a5b5-07eca95f8499",
"contact_id": "079fe950-35e9-4908-b2c7-f76ad7684c5d",
"article_price_label_id": "7ede4fdd-7057-47af-a38b-da71cbb9e482",
"db_language_id": "ef3fb5b5-9051-47f2-b57c-b5cbb7a9d011",
"invoice_status_id": "7d70b62c-e2eb-4490-99f9-1c86e7b18679",
"invoice_status_name": "sample string 35",
"discount_group_id": "4a42748c-1f6c-4032-915e-7b6a93ec556a",
"discount": 37.0,
"email": "sample string 38",
"invoice_number": "sample string 39",
"bill_to_company_id": "2f16606e-38b1-4f44-a60c-4092f185767e",
"dateutc_confirmation": "2025-05-17T18:12:38.7018854+00:00",
"modified_dateutc": "2025-05-17T18:12:38.7018854+00:00",
"invoice_details": [
{
"id": "c8f1daa7-ee43-4ce9-a4a1-22f91ee6788d",
"invoice_id": "4bc23bcb-b36e-4be0-94ef-b7c5f5bc451a",
"article_id": "90035749-c0e3-4c9e-9296-f46ae977751b",
"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": "9ebdc301-8cdc-4994-a330-1380aca63970",
"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": "6de2920c-feb2-4d4c-861f-95493343dadb",
"company_vat_code": "sample string 25",
"modified_dateutc": "2025-05-17T18:12:38.7018854+00:00"
},
{
"id": "c8f1daa7-ee43-4ce9-a4a1-22f91ee6788d",
"invoice_id": "4bc23bcb-b36e-4be0-94ef-b7c5f5bc451a",
"article_id": "90035749-c0e3-4c9e-9296-f46ae977751b",
"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": "9ebdc301-8cdc-4994-a330-1380aca63970",
"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": "6de2920c-feb2-4d4c-861f-95493343dadb",
"company_vat_code": "sample string 25",
"modified_dateutc": "2025-05-17T18:12:38.7018854+00:00"
}
],
"db_payment_method_name": "sample string 43",
"db_payment_method_pm": "sample string 44"
}