invantive documentation
Invantive Support ForumsLog In / Sign Up

OrdersByType: Minox Orders by Type

read only per partition REST

  • Catalog: Minox
  • Schema: Ordering
  • Label: Orders 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_code `` Partition to retrieve data from.
type `` Values: concept, invoice, invoice_draft, quotation, orderresponse, packinglist, billoflading, subscription.

Table Columns

The columns of the table OrdersByType 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_description varchar2 Carrier Description filters on the platform, writable, carrier.description
carrier_id int64 Carrier ID filters on the platform, writable, carrier.id
credit_restriction_percent decimal Credit Restriction Percent filters on the platform, writable, credit_restriction_percent The credit restriction percentage added over the total
currency_description varchar2 Currency Description filters on the platform, writable, currency.description
currency_id varchar2 Currency ID filters on the platform, writable, currency.id
customer_city varchar2 Customer City filters on the platform, writable, customer.city
customer_contact_name varchar2 Customer Contact Name filters on the platform, writable, customer.contact_name
customer_country_code varchar2 Customer Country Code filters on the platform, writable, customer.country_code An ISO-3166-1-alpha2 country code. See: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
customer_id decimal Customer ID filters on the platform, writable, customer.id
customer_name varchar2 Customer Name filters on the platform, writable, customer.name
customer_postal_code varchar2 Customer Postal Code filters on the platform, writable, customer.postal_code
customer_salutation varchar2 Customer Salutation filters on the platform, writable, customer.salutation
customer_streetname_and_number varchar2 Customer Street Name And Number filters on the platform, writable, customer.streetname_and_number
customer_type_description varchar2 Customer Type Description filters on the platform, writable, customer_type.description
customer_type_id int64 Customer Type ID filters on the platform, writable, customer_type.id
delivery_address_city varchar2 Delivery Address City filters on the platform, writable, delivery_address.city
delivery_address_contact_name varchar2 Delivery Address Contact Name filters on the platform, writable, delivery_address.contact_name
delivery_address_country_code varchar2 Delivery Address Country Code filters on the platform, writable, delivery_address.country_code An ISO-3166-1-alpha2 country code. See: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
delivery_address_extended_name varchar2 Delivery Address Extended Name filters on the platform, writable, delivery_address.extended_name
delivery_address_name varchar2 Delivery Address Name filters on the platform, writable, delivery_address.name
delivery_address_postal_code varchar2 Delivery Address Postal Code filters on the platform, writable, delivery_address.postal_code
delivery_address_streetname_and_number varchar2 Delivery Address Streetname and Number filters on the platform, writable, delivery_address.streetname_and_number
delivery_date varchar2 Delivery Date filters on the platform, writable, delivery_date The ISO date of the delivery (is set automatically when the document transitioned from the type billoflading)
delivery_term_description varchar2 Delivery Term Description filters on the platform, writable, delivery_term.description
delivery_term_id int64 Delivery Term ID filters on the platform, writable, delivery_term.id
discount_percentage decimal Discount Percentage filters on the platform, writable, discount_percentage The discount percentage calculated over the entire order document
document_number decimal Document Number filters on the platform, writable, document_number The number given when an order document of type orderresponse, packinglist or billoflading is transitioned
frequence varchar2 Frequence filters on the platform, writable, frequence
id varchar2 ID filters on the platform, writable, id
invoice_date varchar2 Invoice Date filters on the platform, writable, invoice_date The ISO date for when the document transitioned to the type invoice
invoice_number decimal Invoice Number filters on the platform, writable, invoice_number The number given when an order document is transitioned to the invoice type
is_g_account char Is G-Account filters on the platform, writable, is_g_account
is_merge char Is Merge filters on the platform, writable, is_merge If the order document has been created by merging multiple order documents
mandate_code varchar2 Mandate Code filters on the platform, writable, mandate.code
mandate_date varchar2 Mandate Date filters on the platform, writable, mandate_date The ISO date calculated based on the invoice date and the mandate_date
mandate_serial_number decimal Mandate Serial Number filters on the platform, writable, mandate.serial_number
memo varchar2 Memo filters on the platform, writable, memo
next_invoice_date varchar2 Next Invoice Date filters on the platform, writable, next_invoice_date The ISO date for when the document last transitioned from type subscription to the type invoice
orderresponse_date varchar2 Orderresponse Date filters on the platform, writable, orderresponse_date The ISO date for when the document transitioned from the type orderresponse
packinglist_date varchar2 Packinglist Date filters on the platform, writable, packinglist_date The ISO date for when the document transitioned from the type packinglist
payment_discount_percent decimal Payment Discount Percent filters on the platform, writable, payment_discount_percent The payment discount percentage subtracted over the total
payment_term_days decimal Payment Term Days filters on the platform, writable, payment_term.days
payment_term_description varchar2 Payment Term Description filters on the platform, writable, payment_term.description
payment_term_id int64 Payment Term ID filters on the platform, writable, payment_term.id
payment_term_mandate varchar2 Payment Term Mandate filters on the platform, writable, payment_term.mandate
payment_term_start varchar2 Payment Term Start filters on the platform, writable, payment_term.start
period_number decimal Period Number filters on the platform, writable, period_number The period in which the invoice belongs
previous_type varchar2 Previous Type filters on the platform, writable, previous_type
quotation_date varchar2 Quotation Date filters on the platform, writable, quotation_date The ISO date for when the document transitioned from the type quotation
quotation_number decimal Quotation Number filters on the platform, writable, quotation_number The number given when an order document of type quotation is transitioned
reference varchar2 Reference filters on the platform, writable, reference
region_description varchar2 Region Description filters on the platform, writable, region.description
region_id int64 Region ID filters on the platform, writable, region.id
representative_id int64 Representative ID filters on the platform, writable, representative.id
representative_name varchar2 Representative Name filters on the platform, writable, representative.name
state_date varchar2 State Date filters on the platform, writable, state_date The ISO date for when the last transition happened
subscription_date varchar2 Subscription Date filters on the platform, writable, subscription_date The ISO date for when the document transitioned from the type subscription
subscription_end_date varchar2 Subscription End Date filters on the platform, writable, subscription_end_date The ISO date for when the subscription ends
subscription_number decimal Subscription Number filters on the platform, writable, subscription_number The number given when an order document of type subscription is transitioned
totals_amount decimal Totals Amount filters on the platform, writable, totals.amount The total amount (before discounts and VAT)
totals_credit_restriction decimal Totals Credit Restriction filters on the platform, writable, totals.credit_restriction The credit restriction
totals_delivery_quantity decimal Totals Delivery Quantity filters on the platform, writable, totals.delivery_quantity The total amount of items delivered
totals_discount decimal Totals Discount filters on the platform, writable, totals.discount The total discount
totals_payment_discount decimal Totals Payment Discount filters on the platform, writable, totals.payment_discount The payment discount
totals_quantity decimal Totals Quantity filters on the platform, writable, totals.quantity The total amount of items
totals_total decimal Totals Total filters on the platform, writable, totals.total The total amount with discounts and VAT
type varchar2 Type filters on the platform, writable, type
vat_inclusive char VAT Inclusive filters on the platform, writable, vat_inclusive Whether the VAT amounts are included in the amounts
vat_reverse_charged char VAT Reverse Charged filters on the platform, writable, vat_reverse_charged 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

All changes of the driver, 26.0 to 27.0