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": "65584b68-7003-49cc-859b-3bde1bec69d0",
"internal_number": "sample string 2",
"company_id": "5f0f9a0a-28fb-4904-b5a7-189ba08b899b",
"company_code": "sample string 4",
"company_name": "sample string 5",
"company_email": "sample string 6",
"company_phone": "sample string 7",
"date_create": "2025-01-18T10:46:36.5432683+00:00",
"memo": "sample string 9",
"description": "sample string 10",
"invoice_type": "sample string 11",
"source_type": "sample string 12",
"source_id_in_table": "90fa30be-4725-4662-b8b1-a29dab554878",
"total_lines": 14,
"total_amount": 15.0,
"db_currency_id": "b5881e1f-2c01-46cc-9c56-45e75619e1af",
"total_taxes": 17.0,
"due_date": "2025-01-18T10:46:36.5432683+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": "037ec907-c222-4ff5-a484-154d59dec8fa",
"id2": 27,
"customer_remarks": "sample string 28",
"bill_to_party": "sample string 29",
"bill_to_contact_id": "3785c41f-a91c-4039-ac38-5031ea65a797",
"contact_id": "90dd242e-76d0-4c7b-80aa-de530c5128ec",
"article_price_label_id": "1c5c12cb-109d-43ed-98f7-3f47e01eb316",
"db_language_id": "c7516b64-4707-4225-87e3-6c6016537b28",
"invoice_status_id": "0769889c-9351-49aa-8dba-8f212d67e449",
"invoice_status_name": "sample string 35",
"discount_group_id": "d98a845b-d076-445f-a3c6-46f16e8d0e47",
"discount": 37.0,
"email": "sample string 38",
"invoice_number": "sample string 39",
"bill_to_company_id": "9af3afec-f080-49ef-b782-ff708a5ca109",
"dateutc_confirmation": "2025-01-18T10:46:36.5630205+00:00",
"modified_dateutc": "2025-01-18T10:46:36.5630205+00:00",
"invoice_details": [
{
"id": "82780e28-5567-4a31-a9b6-fa6de7a250a2",
"invoice_id": "82dc3707-687a-4407-b3cd-24cff3eb0ff3",
"article_id": "71763122-b4bc-4dad-84ab-6956a5a2601f",
"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": "72d66ab3-b438-449c-b7a6-8d03273d2f0a",
"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": "1eb259b7-3d6a-4b79-983e-1917ba0f9358",
"company_vat_code": "sample string 25",
"modified_dateutc": "2025-01-18T10:46:36.5630205+00:00"
},
{
"id": "82780e28-5567-4a31-a9b6-fa6de7a250a2",
"invoice_id": "82dc3707-687a-4407-b3cd-24cff3eb0ff3",
"article_id": "71763122-b4bc-4dad-84ab-6956a5a2601f",
"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": "72d66ab3-b438-449c-b7a6-8d03273d2f0a",
"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": "1eb259b7-3d6a-4b79-983e-1917ba0f9358",
"company_vat_code": "sample string 25",
"modified_dateutc": "2025-01-18T10:46:36.5630205+00:00"
}
],
"db_payment_method_name": "sample string 43",
"db_payment_method_pm": "sample string 44"
}