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_viewName | 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": "f26b6343-e9b6-489a-8a1f-ff255cb1e327", "internal_number": "sample string 2", "company_id": "6694f89b-1949-4b20-ae94-c77b564c0092", "company_code": "sample string 4", "company_name": "sample string 5", "company_email": "sample string 6", "company_phone": "sample string 7", "date_create": "2025-09-14T07:39:02.3952246+00:00", "memo": "sample string 9", "description": "sample string 10", "invoice_type": "sample string 11", "source_type": "sample string 12", "source_id_in_table": "3455fbdd-9368-4f89-b76d-012579f8ac82", "total_lines": 14, "total_amount": 15.0, "db_currency_id": "b196d2ed-1151-4315-aedf-170e50f41c65", "total_taxes": 17.0, "due_date": "2025-09-14T07:39:02.3952246+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": "a79ee7ac-ed9a-4165-8b09-615e895b61ee", "id2": 27, "customer_remarks": "sample string 28", "bill_to_party": "sample string 29", "bill_to_contact_id": "7df4cb8c-3175-451e-8077-0c2485315f54", "contact_id": "9492e88c-84f8-4d17-b4f2-5f42eac3e36e", "article_price_label_id": "f5d96aa0-6e69-44e6-82d5-1de07d1d4609", "db_language_id": "f29508f6-55f3-4130-afff-23b16fef587d", "invoice_status_id": "45433815-d1d9-4a66-a97c-6ca950a2302a", "invoice_status_name": "sample string 35", "discount_group_id": "4aff069b-e685-41c6-867f-4d756770049e", "discount": 37.0, "email": "sample string 38", "invoice_number": "sample string 39", "bill_to_company_id": "6074215c-b9da-4ee1-9901-80e9fdcd11f5", "dateutc_confirmation": "2025-09-14T07:39:02.3952246+00:00", "modified_dateutc": "2025-09-14T07:39:02.3952246+00:00", "invoice_details": [ { "id": "804bfe94-1097-409b-b17b-5addc64e3286", "invoice_id": "211b645b-5fd7-464f-8929-be9baeb5d576", "article_id": "c701f402-bd80-40e5-86f4-d5b0e5056c66", "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": "eeda2934-a432-4e76-bdff-5c3241689dd3", "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": "347dac6d-7a74-4a98-a167-09749e7e5360", "company_vat_code": "sample string 25", "modified_dateutc": "2025-09-14T07:39:02.4052331+00:00" }, { "id": "804bfe94-1097-409b-b17b-5addc64e3286", "invoice_id": "211b645b-5fd7-464f-8929-be9baeb5d576", "article_id": "c701f402-bd80-40e5-86f4-d5b0e5056c66", "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": "eeda2934-a432-4e76-bdff-5c3241689dd3", "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": "347dac6d-7a74-4a98-a167-09749e7e5360", "company_vat_code": "sample string 25", "modified_dateutc": "2025-09-14T07:39:02.4052331+00:00" } ], "db_payment_method_name": "sample string 43", "db_payment_method_pm": "sample string 44" }