Skip to content
COMMERCE QUERY
/
Orders
/
/
Enferno.Storm.Query.Api.D...

Storm Query API Documentation (2.0)

Storm Query API is an API based on OData V4. It is an API to fill the need for data from Storm in integration services that do not have direct access to Storm’s data and data models.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://customer-slug.api-se.norce.tech/commerce/query/2.0/

Schemas

Schemas

Enferno.Storm.Query.Api.DataContexts.OrderModel.Invoice

Idstring

Id. Key property.

ClientIdinteger(int32)

ClientId.

InvoiceNostring

InvoiceNo. MaxLength: 50. Nullable.

TypeIdinteger(int32)

TypeId.

ReferenceOrderIdstring

ReferenceOrderId.

BuyerCompanyIdinteger(int32)

BuyerCompanyId. Nullable.

BuyerCustomerIdinteger(int32)

BuyerCustomerId. Nullable.

PayerCompanyIdinteger(int32)

PayerCompanyId. Nullable.

PayerCustomerIdinteger(int32)

PayerCustomerId. Nullable.

ResellerCompanyIdinteger(int32)

ResellerCompanyId. Nullable.

ResellerCustomerIdinteger(int32)

ResellerCustomerId. Nullable.

GroupCodestring

GroupCode. MaxLength: 50. Nullable.

DeliveryDatestring(date-time)

DeliveryDate. Nullable.

InvoiceDatestring(date-time)

InvoiceDate.

InvoiceDueDatestring(date-time)

InvoiceDueDate. Nullable.

SalesRepContactIdinteger(int32)

SalesRepContactId. Nullable.

Sourcestring

Source. MaxLength: 255. Nullable.

Quantitynumber(decimal)

Quantity.

Volumenumber(decimal)

Volume. Nullable.

Weightnumber(decimal)

Weight. Nullable.

CurrencyIdinteger(int32)

CurrencyId.

CurrencyRatenumber(decimal)

CurrencyRate.

CashDiscountnumber(decimal)

CashDiscount.

CashDiscountDatestring(date-time)

CashDiscountDate. Nullable.

SumLineDiscountnumber(decimal)

SumLineDiscount.

FreightCostnumber(decimal)

FreightCost.

InvoiceFeenumber(decimal)

InvoiceFee.

CostValuenumber(decimal)

CostValue.

SalesBalancenumber(decimal)

SalesBalance.

InvoiceAmountnumber(decimal)

InvoiceAmount.

InvoiceRoundOffnumber(decimal)

InvoiceRoundOff.

VatDutiable1number(decimal)

VatDutiable1.

VatDutiable2number(decimal)

VatDutiable2.

VatDutiable3number(decimal)

VatDutiable3.

Vat1number(decimal)

Vat1.

Vat2number(decimal)

Vat2.

Vat3number(decimal)

Vat3.

VatRoundOffnumber(decimal)

VatRoundOff.

Vatnumber(decimal)

Vat.

InvoiceNamestring

InvoiceName. MaxLength: 255. Nullable.

InvoiceAttentionstring

InvoiceAttention. MaxLength: 100. Nullable.

InvoiceCareOfstring

InvoiceCareOf. MaxLength: 100. Nullable.

InvoiceAddressLine1string

InvoiceAddressLine1. MaxLength: 255. Nullable.

InvoiceAddressLine2string

InvoiceAddressLine2. MaxLength: 255. Nullable.

InvoiceZipCodestring

InvoiceZipCode. MaxLength: 50. Nullable.

InvoiceCitystring

InvoiceCity. MaxLength: 50. Nullable.

InvoiceRegionstring

InvoiceRegion. MaxLength: 100. Nullable.

InvoiceCountryIdinteger(int32)

InvoiceCountryId. Nullable.

LedgerVoucherstring

LedgerVoucher. MaxLength: 50. Nullable.

Departmentstring

Department. MaxLength: 10. Nullable.

Centrestring

Centre. MaxLength: 10. Nullable.

NoteTextstring

NoteText. MaxLength: 255. Nullable.

LastInvoiceForOrderboolean

LastInvoiceForOrder. Nullable.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

InvoiceAddressIdstring

InvoiceAddressId. Nullable.

ReferenceNoPspstring

ReferenceNoPsp. MaxLength: 50. Nullable.

PaymentMethodIdinteger(int32)

PaymentMethodId. Nullable.

DeliveryMethodIdinteger(int32)

DeliveryMethodId. Nullable.

IsDebitboolean

IsDebit. Nullable.

CreditedInvoiceIdstring

CreditedInvoiceId. Nullable.

Commentstring

Comment. MaxLength: 250. Nullable.

IsForgottenboolean

IsForgotten.

ForgottenByinteger(int32)

ForgottenBy. Nullable.

ForgottenDatestring(date-time)

ForgottenDate. Nullable.

AggregatedInvoiceCodestring

AggregatedInvoiceCode. MaxLength: 100. Nullable.

PaymentMethodCodestring

PaymentMethodCode. MaxLength: 50. Nullable.

PaymentMethodNamestring

PaymentMethodName. MaxLength: 50. Nullable.

ItemsArray of objects(OrderService.InvoiceItem)(OrderService.InvoiceItem)

Items.

Addressobject(OrderService.Address)(OrderService.Address)
{
  "Id": "string",
  "ClientId": 0,
  "InvoiceNo": "string",
  "TypeId": 0,
  "ReferenceOrderId": "string",
  "BuyerCompanyId": 0,
  "BuyerCustomerId": 0,
  "PayerCompanyId": 0,
  "PayerCustomerId": 0,
  "ResellerCompanyId": 0,
  "ResellerCustomerId": 0,
  "GroupCode": "string",
  "DeliveryDate": "2019-08-24T14:15:22Z",
  "InvoiceDate": "2019-08-24T14:15:22Z",
  "InvoiceDueDate": "2019-08-24T14:15:22Z",
  "SalesRepContactId": 0,
  "Source": "string",
  "Quantity": 0,
  "Volume": 0,
  "Weight": 0,
  "CurrencyId": 0,
  "CurrencyRate": 0,
  "CashDiscount": 0,
  "CashDiscountDate": "2019-08-24T14:15:22Z",
  "SumLineDiscount": 0,
  "FreightCost": 0,
  "InvoiceFee": 0,
  "CostValue": 0,
  "SalesBalance": 0,
  "InvoiceAmount": 0,
  "InvoiceRoundOff": 0,
  "VatDutiable1": 0,
  "VatDutiable2": 0,
  "VatDutiable3": 0,
  "Vat1": 0,
  "Vat2": 0,
  "Vat3": 0,
  "VatRoundOff": 0,
  "Vat": 0,
  "InvoiceName": "string",
  "InvoiceAttention": "string",
  "InvoiceCareOf": "string",
  "InvoiceAddressLine1": "string",
  "InvoiceAddressLine2": "string",
  "InvoiceZipCode": "string",
  "InvoiceCity": "string",
  "InvoiceRegion": "string",
  "InvoiceCountryId": 0,
  "LedgerVoucher": "string",
  "Department": "string",
  "Centre": "string",
  "NoteText": "string",
  "LastInvoiceForOrder": true,
  "Created": "2019-08-24T14:15:22Z",
  "CreatedBy": 0,
  "Updated": "2019-08-24T14:15:22Z",
  "UpdatedBy": 0,
  "InvoiceAddressId": "string",
  "ReferenceNoPsp": "string",
  "PaymentMethodId": 0,
  "DeliveryMethodId": 0,
  "IsDebit": true,
  "CreditedInvoiceId": "string",
  "Comment": "string",
  "IsForgotten": true,
  "ForgottenBy": 0,
  "ForgottenDate": "2019-08-24T14:15:22Z",
  "AggregatedInvoiceCode": "string",
  "PaymentMethodCode": "string",
  "PaymentMethodName": "string",
  "Items": [
    { … }
  ],
  "Address": {
    "Id": "string",
    "TypeId": 0,
    "Name": "string",
    "Attention": "string",
    "CareOf": "string",
    "Line1": "string",
    "Line2": "string",
    "ZipCode": "string",
    "City": "string",
    "Region": "string",
    "CountryId": 0,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "RowId": "string",
    "EmailAddress": "string",
    "PhoneNumber": "string",
    "ClientId": 0,
    "ShippingPhoneNumber": "string",
    "Gln": "string"
  }
}

Enferno.Storm.Query.Api.DataContexts.OrderModel.WarehouseTransaction

TransactionNostring

TransactionNo. MaxLength: 50. Nullable.

Idstring

Id. Key property.

TransactionDatestring(date-time)

TransactionDate.

WarehouseCodestring

WarehouseCode. MaxLength: 50. Nullable.

LocationCodestring

LocationCode. MaxLength: 50. Nullable.

Typestring

Type. MaxLength: 50. Nullable.

OrderNostring

OrderNo. MaxLength: 50. Nullable.

PurchaseOrderNostring

PurchaseOrderNo. MaxLength: 50. Nullable.

DeliveryNoteNostring

DeliveryNoteNo. MaxLength: 50. Nullable.

ExternalReferencestring

ExternalReference. MaxLength: 50. Nullable.

ReasonCodestring

ReasonCode. MaxLength: 50. Nullable.

Commentstring

Comment. MaxLength: 500. Nullable.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

ItemsArray of objects(Enferno.Storm.Query.Api.DataContexts.OrderModel.WarehouseTransactionItem)(Enferno.Storm.Query.Api.DataContexts.OrderModel.WarehouseTransactionItem)

Items.

{
  "TransactionNo": "string",
  "Id": "string",
  "TransactionDate": "2019-08-24T14:15:22Z",
  "WarehouseCode": "string",
  "LocationCode": "string",
  "Type": "string",
  "OrderNo": "string",
  "PurchaseOrderNo": "string",
  "DeliveryNoteNo": "string",
  "ExternalReference": "string",
  "ReasonCode": "string",
  "Comment": "string",
  "Created": "2019-08-24T14:15:22Z",
  "CreatedBy": 0,
  "Items": [
    { … }
  ]
}

OrderService.InvoiceItem

Idstring

Id. Key property.

InvoiceIdstring

InvoiceId.

LineNumbernumber(decimal)

LineNumber. Nullable.

StatusIdinteger(int32)

StatusId. Nullable.

PartNostring

PartNo. MaxLength: 50. Nullable.

ExternalPartNostring

ExternalPartNo. MaxLength: 50. Nullable.

ProductNamestring

ProductName. MaxLength: 255. Nullable.

StockUnitOfMeasurementCountnumber(decimal)

StockUnitOfMeasurementCount.

PriceUnitOfMeasurementCountnumber(decimal)

PriceUnitOfMeasurementCount.

WarehouseIdinteger(int32)

WarehouseId. Nullable.

LocationIdinteger(int32)

LocationId. Nullable.

Quantityinteger(int32)

Quantity.

CurrencyIdinteger(int32)

CurrencyId.

VatRatenumber(decimal)

VatRate.

CostUnitnumber(decimal)

CostUnit.

PriceSalenumber(decimal)

PriceSale.

DiscountPercentagenumber(decimal)

DiscountPercentage.

DiscountAmountnumber(decimal)

DiscountAmount.

LineAmountnumber(decimal)

LineAmount.

DeliveryModestring

DeliveryMode. MaxLength: 50. Nullable.

IsPartDeliveryboolean

IsPartDelivery.

DeliveryDatestring(date-time)

DeliveryDate. Nullable.

SalesRepContactIdinteger(int32)

SalesRepContactId. Nullable.

LedgerAccountstring

LedgerAccount. MaxLength: 50. Nullable.

Departmentstring

Department. MaxLength: 10. Nullable.

Centrestring

Centre. MaxLength: 10. Nullable.

TransIdstring

TransId.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

OrderItemIdstring

OrderItemId. Nullable.

PurchaseOrderItemIdstring

PurchaseOrderItemId. Nullable.

LineNumberStringstring

LineNumberString. MaxLength: 50. Nullable.

PriceUnitnumber(decimal)

PriceUnit. Nullable.

Quantity2number(decimal)

Quantity2. Nullable.

ClientIdinteger(int32)

ClientId. Nullable.

OrderItemobject(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderItem)(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderItem)
{
  "Id": "string",
  "InvoiceId": "string",
  "LineNumber": 0,
  "StatusId": 0,
  "PartNo": "string",
  "ExternalPartNo": "string",
  "ProductName": "string",
  "StockUnitOfMeasurementCount": 0,
  "PriceUnitOfMeasurementCount": 0,
  "WarehouseId": 0,
  "LocationId": 0,
  "Quantity": 0,
  "CurrencyId": 0,
  "VatRate": 0,
  "CostUnit": 0,
  "PriceSale": 0,
  "DiscountPercentage": 0,
  "DiscountAmount": 0,
  "LineAmount": 0,
  "DeliveryMode": "string",
  "IsPartDelivery": true,
  "DeliveryDate": "2019-08-24T14:15:22Z",
  "SalesRepContactId": 0,
  "LedgerAccount": "string",
  "Department": "string",
  "Centre": "string",
  "TransId": "string",
  "Created": "2019-08-24T14:15:22Z",
  "CreatedBy": 0,
  "Updated": "2019-08-24T14:15:22Z",
  "UpdatedBy": 0,
  "OrderItemId": "string",
  "PurchaseOrderItemId": "string",
  "LineNumberString": "string",
  "PriceUnit": 0,
  "Quantity2": 0,
  "ClientId": 0,
  "OrderItem": {
    "Id": "string",
    "OrderId": "string",
    "LineNumber": 0,
    "ParentLineNumber": 0,
    "StatusId": 0,
    "PartNo": "string",
    "ExternalPartNo": "string",
    "ProductName": "string",
    "StockUnitOfMeasurementCount": 0,
    "PriceUnitOfMeasurementCount": 0,
    "WarehouseId": 0,
    "LocationId": 0,
    "QtyOrdered": 0,
    "CurrencyId": 0,
    "VatRate": 0,
    "CostUnit": 0,
    "PriceSale": 0,
    "DiscountPercentage": 0,
    "DiscountAmount": 0,
    "LineAmount": 0,
    "DeliveryMode": "string",
    "IsPartDelivery": true,
    "ExpectedDeliveryDate": "2019-08-24T14:15:22Z",
    "ConfirmedDeliveryDate": "2019-08-24T14:15:22Z",
    "SalesRepContactId": 0,
    "LedgerAccount": "string",
    "Department": "string",
    "Centre": "string",
    "TransId": "string",
    "ExternalStatusText": "string",
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "LineNumberString": "string",
    "PriceRecommended": 0,
    "PriceCatalog": 0,
    "PriceStandard": 0,
    "ClientId": 0,
    "InvoiceItem": [ … ],
    "Infos": [ … ]
  }
}

Orders

Operations