OrderVatTotalsByType: Minox Order VAT Totals by Type
read only per partition REST
- Catalog:
Minox - Schema:
Ordering - Label: Order VAT Totals by Type
Get a list of order documents by type.
The data in this table is partitioned per value of the administration_code column.
Can only retrieve data.
API Source
- Endpoint:
/tenant/{tenant_id}/administration/{administration_id}/ordering/by_type/{type} - Operation:
get /tenant/{tenant_id}/administration/{administration_id}/ordering/by_type/{type}
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
administration_ |
`` | Partition to retrieve data from. | ||
type |
`` | Values: concept, invoice, invoice_draft, quotation, orderresponse, packinglist, billoflading, subscription. |
Table Columns
The columns of the table OrderVatTotalsByType are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.
| Name | Data Type | Label | Required | Marks | Documentation |
|---|---|---|---|---|---|
carrier_ |
varchar2 |
Carrier Description | filters on the platform, writable, ::ancestor. |
||
carrier_ |
int64 |
Carrier ID | filters on the platform, writable, ::ancestor. |
||
credit_ |
decimal |
Credit Restriction Percent | filters on the platform, writable, ::ancestor. |
The credit restriction percentage added over the total | |
currency_ |
varchar2 |
Currency Description | filters on the platform, writable, ::ancestor. |
||
currency_ |
varchar2 |
Currency ID | filters on the platform, writable, ::ancestor. |
||
customer_ |
varchar2 |
Customer City | filters on the platform, writable, ::ancestor. |
||
customer_ |
varchar2 |
Customer Contact Name | filters on the platform, writable, ::ancestor. |
||
customer_ |
varchar2 |
Customer Country Code | filters on the platform, writable, ::ancestor. |
An ISO-3166-1-alpha2 country code. See: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements | |
customer_ |
decimal |
Customer ID | filters on the platform, writable, ::ancestor. |
||
customer_ |
varchar2 |
Customer Name | filters on the platform, writable, ::ancestor. |
||
customer_ |
varchar2 |
Customer Postal Code | filters on the platform, writable, ::ancestor. |
||
customer_ |
varchar2 |
Customer Salutation | filters on the platform, writable, ::ancestor. |
||
customer_ |
varchar2 |
Customer Street Name And Number | filters on the platform, writable, ::ancestor. |
||
customer_ |
varchar2 |
Customer Type Description | filters on the platform, writable, ::ancestor. |
||
customer_ |
int64 |
Customer Type ID | filters on the platform, writable, ::ancestor. |
||
delivery_ |
varchar2 |
Delivery Address City | filters on the platform, writable, ::ancestor. |
||
delivery_ |
varchar2 |
Delivery Address Contact Name | filters on the platform, writable, ::ancestor. |
||
delivery_ |
varchar2 |
Delivery Address Country Code | filters on the platform, writable, ::ancestor. |
An ISO-3166-1-alpha2 country code. See: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements | |
delivery_ |
varchar2 |
Delivery Address Extended Name | filters on the platform, writable, ::ancestor. |
||
delivery_ |
varchar2 |
Delivery Address Name | filters on the platform, writable, ::ancestor. |
||
delivery_ |
varchar2 |
Delivery Address Postal Code | filters on the platform, writable, ::ancestor. |
||
delivery_ |
varchar2 |
Delivery Address Streetname and Number | filters on the platform, writable, ::ancestor. |
||
delivery_ |
varchar2 |
Delivery Date | filters on the platform, writable, ::ancestor. |
The ISO date of the delivery (is set automatically when the document transitioned from the type billoflading) | |
delivery_ |
varchar2 |
Delivery Term Description | filters on the platform, writable, ::ancestor. |
||
delivery_ |
int64 |
Delivery Term ID | filters on the platform, writable, ::ancestor. |
||
discount |
decimal |
Discount | writable, discount |
The discount for the VAT percentage | |
discount_ |
decimal |
Discount Percentage | filters on the platform, writable, ::ancestor. |
The discount percentage calculated over the entire order document | |
document_ |
decimal |
Document Number | filters on the platform, writable, ::ancestor. |
The number given when an order document of type orderresponse, packinglist or billoflading is transitioned | |
frequence |
varchar2 |
Frequence | filters on the platform, writable, ::ancestor. |
||
id |
varchar2 |
ID | filters on the platform, writable, ::ancestor. |
||
inclusive_ |
decimal |
Inclusive Amount | writable, inclusive_ |
The amount with the vat amount (filled if vat_inclusive is true) | |
invoice_ |
varchar2 |
Invoice Date | filters on the platform, writable, ::ancestor. |
The ISO date for when the document transitioned to the type invoice | |
invoice_ |
decimal |
Invoice Number | filters on the platform, writable, ::ancestor. |
The number given when an order document is transitioned to the invoice type | |
is_ |
char |
Is G-Account | filters on the platform, writable, ::ancestor. |
||
is_ |
char |
Is Merge | filters on the platform, writable, ::ancestor. |
If the order document has been created by merging multiple order documents | |
mandate_ |
varchar2 |
Mandate Code | filters on the platform, writable, ::ancestor. |
||
mandate_ |
varchar2 |
Mandate Date | filters on the platform, writable, ::ancestor. |
The ISO date calculated based on the invoice date and the mandate_date | |
mandate_ |
decimal |
Mandate Serial Number | filters on the platform, writable, ::ancestor. |
||
memo |
varchar2 |
Memo | filters on the platform, writable, ::ancestor. |
||
next_ |
varchar2 |
Next Invoice Date | filters on the platform, writable, ::ancestor. |
The ISO date for when the document last transitioned from type subscription to the type invoice | |
orderresponse_ |
varchar2 |
Orderresponse Date | filters on the platform, writable, ::ancestor. |
The ISO date for when the document transitioned from the type orderresponse | |
packinglist_ |
varchar2 |
Packinglist Date | filters on the platform, writable, ::ancestor. |
The ISO date for when the document transitioned from the type packinglist | |
payment_ |
decimal |
Payment Discount Percent | filters on the platform, writable, ::ancestor. |
The payment discount percentage subtracted over the total | |
payment_ |
decimal |
Payment Term Days | filters on the platform, writable, ::ancestor. |
||
payment_ |
varchar2 |
Payment Term Description | filters on the platform, writable, ::ancestor. |
||
payment_ |
int64 |
Payment Term ID | filters on the platform, writable, ::ancestor. |
||
payment_ |
varchar2 |
Payment Term Mandate | filters on the platform, writable, ::ancestor. |
||
payment_ |
varchar2 |
Payment Term Start | filters on the platform, writable, ::ancestor. |
||
percentage |
decimal |
Percentage | writable, percentage |
The VAT percentage | |
period_ |
decimal |
Period Number | filters on the platform, writable, ::ancestor. |
The period in which the invoice belongs | |
previous_ |
varchar2 |
Previous Type | filters on the platform, writable, ::ancestor. |
||
quotation_ |
varchar2 |
Quotation Date | filters on the platform, writable, ::ancestor. |
The ISO date for when the document transitioned from the type quotation | |
quotation_ |
decimal |
Quotation Number | filters on the platform, writable, ::ancestor. |
The number given when an order document of type quotation is transitioned | |
reference |
varchar2 |
Reference | filters on the platform, writable, ::ancestor. |
||
region_ |
varchar2 |
Region Description | filters on the platform, writable, ::ancestor. |
||
region_ |
int64 |
Region ID | filters on the platform, writable, ::ancestor. |
||
representative_ |
int64 |
Representative ID | filters on the platform, writable, ::ancestor. |
||
representative_ |
varchar2 |
Representative Name | filters on the platform, writable, ::ancestor. |
||
state_ |
varchar2 |
State Date | filters on the platform, writable, ::ancestor. |
The ISO date for when the last transition happened | |
subscription_ |
varchar2 |
Subscription Date | filters on the platform, writable, ::ancestor. |
The ISO date for when the document transitioned from the type subscription | |
subscription_ |
varchar2 |
Subscription End Date | filters on the platform, writable, ::ancestor. |
The ISO date for when the subscription ends | |
subscription_ |
decimal |
Subscription Number | filters on the platform, writable, ::ancestor. |
The number given when an order document of type subscription is transitioned | |
tax_ |
decimal |
Tax Amount | writable, tax_ |
The VAT amount | |
taxable_ |
decimal |
Taxable Amount | writable, taxable_ |
The amount without VAT | |
totals_ |
decimal |
Totals Amount | filters on the platform, writable, ::ancestor. |
The total amount (before discounts and VAT) | |
totals_ |
decimal |
Totals Credit Restriction | filters on the platform, writable, ::ancestor. |
The credit restriction | |
totals_ |
decimal |
Totals Delivery Quantity | filters on the platform, writable, ::ancestor. |
The total amount of items delivered | |
totals_ |
decimal |
Totals Discount | filters on the platform, writable, ::ancestor. |
The total discount | |
totals_ |
decimal |
Totals Payment Discount | filters on the platform, writable, ::ancestor. |
The payment discount | |
totals_ |
decimal |
Totals Quantity | filters on the platform, writable, ::ancestor. |
The total amount of items | |
totals_ |
decimal |
Totals Total | filters on the platform, writable, ::ancestor. |
The total amount with discounts and VAT | |
type |
varchar2 |
Type | filters on the platform, writable, ::ancestor. |
||
vat_id |
int64 |
VAT ID | writable, vat_id |
The internal VAT identifier | |
vat_ |
char |
VAT Inclusive | filters on the platform, writable, ::ancestor. |
Whether the VAT amounts are included in the amounts | |
vat_ |
char |
VAT Reverse Charged | filters on the platform, writable, ::ancestor. |
Whether the VAT amounts are reverse charged |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver:
Changes of This Table, 26.0 to 27.0
-administration_code-administration_name