STORM QUERY

Orders

Enferno.Storm.Query.Api.DataContexts.OrderModel.DeliveryNote

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

Servers

https://query.storm.io/Query/2.0/

Schemas

Enferno.Storm.Query.Api.DataContexts.OrderModel.PurchaseOrder

Idstring

Id. Key property.

ClientIdinteger(int32)

ClientId.

ApplicationIdinteger(int32)

ApplicationId. Nullable.

PurchaseOrderNostring

PurchaseOrderNo. MaxLength: 50. Nullable.

PurchaseOrderDatestring(date-time)

PurchaseOrderDate.

SupplierIdinteger(int32)

SupplierId. Nullable.

SupplierCodestring

SupplierCode. MaxLength: 50. Nullable.

StatusIdinteger(int32)

StatusId.

PurchaseRepContactIdinteger(int32)

PurchaseRepContactId. Nullable.

PurchaseRepContactCodestring

PurchaseRepContactCode. MaxLength: 50. Nullable.

Sourcestring

Source. MaxLength: 255. Nullable.

DeliveryTermsstring

DeliveryTerms. MaxLength: 10. Nullable.

DeliveryModestring

DeliveryMode. MaxLength: 50. Nullable.

DeliveryDatestring(date-time)

DeliveryDate. Nullable.

IsPartDeliveryboolean

IsPartDelivery.

PaymentTermsstring

PaymentTerms. MaxLength: 100. Nullable.

CurrencyIdinteger(int32)

CurrencyId. Nullable.

VatCodeIdinteger(int32)

VatCodeId. Nullable.

CashDiscountnumber(decimal)

CashDiscount.

LineDiscountnumber(decimal)

LineDiscount.

FreightCostnumber(decimal)

FreightCost.

OrderFeenumber(decimal)

OrderFee.

DeliveryAttentionstring

DeliveryAttention. MaxLength: 100. Nullable.

DeliveryCareOfstring

DeliveryCareOf. MaxLength: 100. Nullable.

DeliveryAddressLine1string

DeliveryAddressLine1. MaxLength: 255. Nullable.

DeliveryAddressLine2string

DeliveryAddressLine2. MaxLength: 255. Nullable.

DeliveryZipCodestring

DeliveryZipCode. MaxLength: 50. Nullable.

DeliveryCitystring

DeliveryCity. MaxLength: 50. Nullable.

DeliveryRegionstring

DeliveryRegion. MaxLength: 100. Nullable.

DeliveryCountryIdinteger(int32)

DeliveryCountryId. Nullable.

LedgerAccountstring

LedgerAccount. MaxLength: 50. Nullable.

Departmentstring

Department. MaxLength: 10. Nullable.

Centrestring

Centre. MaxLength: 10. Nullable.

ExternalPurchaseNostring

ExternalPurchaseNo. MaxLength: 50. Nullable.

SalesCodestring

SalesCode. MaxLength: 50. Nullable.

DeliveryMarkstring

DeliveryMark. MaxLength: 255. Nullable.

InvoiceMarkstring

InvoiceMark. MaxLength: 255. Nullable.

Commentstring

Comment. Nullable.

SellToCustomerCodestring

SellToCustomerCode. MaxLength: 50. Nullable.

SellToSupplierCustomerCodestring

SellToSupplierCustomerCode. MaxLength: 50. Nullable.

SellToAddressIdstring

SellToAddressId. Nullable.

BillToCustomerCodestring

BillToCustomerCode. MaxLength: 50. Nullable.

BillToSupplierCustomerCodestring

BillToSupplierCustomerCode. MaxLength: 50. Nullable.

BillToAddressIdstring

BillToAddressId. Nullable.

ShipToCustomerCodestring

ShipToCustomerCode. MaxLength: 50. Nullable.

ShipToSupplierCustomerCodestring

ShipToSupplierCustomerCode. MaxLength: 50. Nullable.

ShipToAddressIdstring

ShipToAddressId. Nullable.

ShipToEmailstring

ShipToEmail. MaxLength: 255. Nullable.

ShipToPhonestring

ShipToPhone. MaxLength: 50. Nullable.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

RowIdstring

RowId. MaxLength: 8. Nullable.

BillToCustomerInfoIdstring

BillToCustomerInfoId. Nullable.

CurrencyCodestring

CurrencyCode. MaxLength: 3. Nullable.

FreightTermsstring

FreightTerms. MaxLength: 255. Nullable.

InternalCommentstring

InternalComment. MaxLength: 255. Nullable.

SupplierStatusIdinteger(int32)

SupplierStatusId. Nullable.

IsForgottenboolean

IsForgotten.

ForgottenByinteger(int32)

ForgottenBy. Nullable.

ForgottenDatestring(date-time)

ForgottenDate. Nullable.

ItemsArray of objects(OrderService.PurchaseOrderItem)(OrderService.PurchaseOrderItem)

Items.

ShipToAddressobject(OrderService.Address)(OrderService.Address)

SellToAddressobject(OrderService.Address)(OrderService.Address)

BillToAddressobject(OrderService.Address)(OrderService.Address)

{
  "Id": "string",
  "ClientId": 0,
  "ApplicationId": 0,
  "PurchaseOrderNo": "string",
  "PurchaseOrderDate": "2019-08-24T14:15:22Z",
  "SupplierId": 0,
  "SupplierCode": "string",
  "StatusId": 0,
  "PurchaseRepContactId": 0,
  "PurchaseRepContactCode": "string",
  "Source": "string",
  "DeliveryTerms": "string",
  "DeliveryMode": "string",
  "DeliveryDate": "2019-08-24T14:15:22Z",
  "IsPartDelivery": true,
  "PaymentTerms": "string",
  "CurrencyId": 0,
  "VatCodeId": 0,
  "CashDiscount": 0,
  "LineDiscount": 0,
  "FreightCost": 0,
  "OrderFee": 0,
  "DeliveryAttention": "string",
  "DeliveryCareOf": "string",
  "DeliveryAddressLine1": "string",
  "DeliveryAddressLine2": "string",
  "DeliveryZipCode": "string",
  "DeliveryCity": "string",
  "DeliveryRegion": "string",
  "DeliveryCountryId": 0,
  "LedgerAccount": "string",
  "Department": "string",
  "Centre": "string",
  "ExternalPurchaseNo": "string",
  "SalesCode": "string",
  "DeliveryMark": "string",
  "InvoiceMark": "string",
  "Comment": "string",
  "SellToCustomerCode": "string",
  "SellToSupplierCustomerCode": "string",
  "SellToAddressId": "string",
  "BillToCustomerCode": "string",
  "BillToSupplierCustomerCode": "string",
  "BillToAddressId": "string",
  "ShipToCustomerCode": "string",
  "ShipToSupplierCustomerCode": "string",
  "ShipToAddressId": "string",
  "ShipToEmail": "string",
  "ShipToPhone": "string",
  "Created": "2019-08-24T14:15:22Z",
  "CreatedBy": 0,
  "Updated": "2019-08-24T14:15:22Z",
  "UpdatedBy": 0,
  "RowId": "string",
  "BillToCustomerInfoId": "string",
  "CurrencyCode": "string",
  "FreightTerms": "string",
  "InternalComment": "string",
  "SupplierStatusId": 0,
  "IsForgotten": true,
  "ForgottenBy": 0,
  "ForgottenDate": "2019-08-24T14:15:22Z",
  "Items": [
    { … }
  ],
  "ShipToAddress": {
    "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"
  },
  "SellToAddress": {
    "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"
  },
  "BillToAddress": {
    "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.DeliveryNote

Idstring

Id. Key property.

ClientIdinteger(int32)

ClientId.

NoteNostring

NoteNo. MaxLength: 50. Nullable.

SupplierIdinteger(int32)

SupplierId. Nullable.

TypeIdinteger(int32)

TypeId.

ReferenceOrderIdstring

ReferenceOrderId.

BuyerCompanyIdinteger(int32)

BuyerCompanyId. Nullable.

BuyerCompanyCodestring

BuyerCompanyCode. MaxLength: 50. Nullable.

BuyerCustomerIdinteger(int32)

BuyerCustomerId. Nullable.

BuyerCustomerCodestring

BuyerCustomerCode. MaxLength: 50. Nullable.

PayerCompanyIdinteger(int32)

PayerCompanyId. Nullable.

PayerCompanyCodestring

PayerCompanyCode. MaxLength: 50. Nullable.

PayerCustomerIdinteger(int32)

PayerCustomerId. Nullable.

PayerCustomerCodestring

PayerCustomerCode. MaxLength: 50. Nullable.

ResellerCompanyIdinteger(int32)

ResellerCompanyId. Nullable.

ResellerCompanyCodestring

ResellerCompanyCode. MaxLength: 50. Nullable.

ResellerCustomerIdinteger(int32)

ResellerCustomerId. Nullable.

ResellerCustomerCodestring

ResellerCustomerCode. MaxLength: 50. Nullable.

GroupCodestring

GroupCode. MaxLength: 50. Nullable.

DeliveryNamestring

DeliveryName. MaxLength: 100. Nullable.

DeliveryAttentionstring

DeliveryAttention. MaxLength: 100. Nullable.

DeliveryCareOfstring

DeliveryCareOf. MaxLength: 100. Nullable.

DeliveryAddressLine1string

DeliveryAddressLine1. MaxLength: 255. Nullable.

DeliveryAddressLine2string

DeliveryAddressLine2. MaxLength: 255. Nullable.

DeliveryZipCodestring

DeliveryZipCode. MaxLength: 50. Nullable.

DeliveryCitystring

DeliveryCity. MaxLength: 50. Nullable.

DeliveryRegionstring

DeliveryRegion. MaxLength: 100. Nullable.

DeliveryCountryIdinteger(int32)

DeliveryCountryId. Nullable.

DeliveryDatestring(date-time)

DeliveryDate. Nullable.

Quantitynumber(decimal)

Quantity. Nullable.

Volumenumber(decimal)

Volume. Nullable.

Weightnumber(decimal)

Weight. Nullable.

IsPrintedboolean

IsPrinted.

DeliveryTermsstring

DeliveryTerms. MaxLength: 10. Nullable.

DeliveryModestring

DeliveryMode. MaxLength: 50. Nullable.

Sourcestring

Source. MaxLength: 255. Nullable.

DeliveryMarkstring

DeliveryMark. MaxLength: 255. Nullable.

NoteTextstring

NoteText. MaxLength: 255. Nullable.

Departmentstring

Department. MaxLength: 10. Nullable.

Centrestring

Centre. MaxLength: 10. Nullable.

ShippingNostring

ShippingNo. MaxLength: 50. Nullable.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

DeliveryAddressIdstring

DeliveryAddressId. Nullable.

DivisionCodestring

DivisionCode. MaxLength: 50. Nullable.

StatusIdinteger(int32)

StatusId.

IsForgottenboolean

IsForgotten.

ForgottenByinteger(int32)

ForgottenBy. Nullable.

ForgottenDatestring(date-time)

ForgottenDate. Nullable.

ItemsArray of objects(OrderService.DeliveryNoteItem)(OrderService.DeliveryNoteItem)

Items.

PackagesArray of objects(OrderService.DeliveryNotePackage)(OrderService.DeliveryNotePackage)

Packages.

{
  "Id": "string",
  "ClientId": 0,
  "NoteNo": "string",
  "SupplierId": 0,
  "TypeId": 0,
  "ReferenceOrderId": "string",
  "BuyerCompanyId": 0,
  "BuyerCompanyCode": "string",
  "BuyerCustomerId": 0,
  "BuyerCustomerCode": "string",
  "PayerCompanyId": 0,
  "PayerCompanyCode": "string",
  "PayerCustomerId": 0,
  "PayerCustomerCode": "string",
  "ResellerCompanyId": 0,
  "ResellerCompanyCode": "string",
  "ResellerCustomerId": 0,
  "ResellerCustomerCode": "string",
  "GroupCode": "string",
  "DeliveryName": "string",
  "DeliveryAttention": "string",
  "DeliveryCareOf": "string",
  "DeliveryAddressLine1": "string",
  "DeliveryAddressLine2": "string",
  "DeliveryZipCode": "string",
  "DeliveryCity": "string",
  "DeliveryRegion": "string",
  "DeliveryCountryId": 0,
  "DeliveryDate": "2019-08-24T14:15:22Z",
  "Quantity": 0,
  "Volume": 0,
  "Weight": 0,
  "IsPrinted": true,
  "DeliveryTerms": "string",
  "DeliveryMode": "string",
  "Source": "string",
  "DeliveryMark": "string",
  "NoteText": "string",
  "Department": "string",
  "Centre": "string",
  "ShippingNo": "string",
  "Created": "2019-08-24T14:15:22Z",
  "CreatedBy": 0,
  "Updated": "2019-08-24T14:15:22Z",
  "UpdatedBy": 0,
  "DeliveryAddressId": "string",
  "DivisionCode": "string",
  "StatusId": 0,
  "IsForgotten": true,
  "ForgottenBy": 0,
  "ForgottenDate": "2019-08-24T14:15:22Z",
  "Items": [
    { … }
  ],
  "Packages": [
    { … }
  ]
}

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"
  }
}

Orders

Operations