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
Languages
Servers
https://query.storm.io/Query/2.0/

Orders

Operations

Get OrderItem

Request

Get OrderItem

curl -i -X GET \
  https://query.storm.io/Query/2.0/Orders/OrderItems

Responses

Success

Bodyapplication/jsonArray [
Idstring

Id. Key property.

OrderIdstring

OrderId.

LineNumbernumber(decimal)

LineNumber.

ParentLineNumbernumber(decimal)

ParentLineNumber. Nullable.

StatusIdinteger(int32)

StatusId.

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.

QtyOrderednumber(decimal)

QtyOrdered.

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.

ExpectedDeliveryDatestring(date-time)

ExpectedDeliveryDate. Nullable.

ConfirmedDeliveryDatestring(date-time)

ConfirmedDeliveryDate. Nullable.

SalesRepContactIdinteger(int32)

SalesRepContactId. Nullable.

LedgerAccountstring

LedgerAccount. MaxLength: 50. Nullable.

Departmentstring

Department. MaxLength: 10. Nullable.

Centrestring

Centre. MaxLength: 10. Nullable.

TransIdstring

TransId.

ExternalStatusTextstring

ExternalStatusText. MaxLength: 255. Nullable.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

LineNumberStringstring

LineNumberString. MaxLength: 50. Nullable.

PriceRecommendednumber(decimal)

PriceRecommended. Nullable.

PriceCatalognumber(decimal)

PriceCatalog. Nullable.

PriceStandardnumber(decimal)

PriceStandard. Nullable.

ClientIdinteger(int32)

ClientId. Nullable.

InvoiceItemArray of objects(OrderService.InvoiceItem)(OrderService.InvoiceItem)

InvoiceItem.

InfosArray of objects(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderItemInfo)(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderItemInfo)

Infos.

]
Response
application/json
[ { "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": [] } ]

Get Order

Request

Get Order

curl -i -X GET \
  https://query.storm.io/Query/2.0/Orders/Orders

Responses

Success

Bodyapplication/jsonArray [
Idstring

Id. Key property.

ClientIdinteger(int32)

ClientId.

ApplicationIdinteger(int32)

ApplicationId. Nullable.

QuotationIdinteger(int32)

QuotationId. Nullable.

OrderNostring

OrderNo. MaxLength: 50. Nullable.

OrderDatestring(date-time)

OrderDate.

BuyerCompanyCodestring

BuyerCompanyCode. MaxLength: 50. Nullable.

BuyerCompanyIdinteger(int32)

BuyerCompanyId. Nullable.

BuyerCustomerCodestring

BuyerCustomerCode. MaxLength: 50. Nullable.

BuyerCustomerIdinteger(int32)

BuyerCustomerId. Nullable.

PayerCompanyCodestring

PayerCompanyCode. MaxLength: 50. Nullable.

PayerCompanyIdinteger(int32)

PayerCompanyId. Nullable.

PayerCustomerCodestring

PayerCustomerCode. MaxLength: 50. Nullable.

PayerCustomerIdinteger(int32)

PayerCustomerId. Nullable.

ResellerCompanyCodestring

ResellerCompanyCode. MaxLength: 50. Nullable.

ResellerCompanyIdinteger(int32)

ResellerCompanyId. Nullable.

ResellerCustomerCodestring

ResellerCustomerCode. MaxLength: 50. Nullable.

ResellerCustomerIdinteger(int32)

ResellerCustomerId. Nullable.

GroupCodestring

GroupCode. MaxLength: 50. Nullable.

StatusIdinteger(int32)

StatusId.

SalesRepContactIdinteger(int32)

SalesRepContactId. 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.

VatRatenumber(decimal)

VatRate.

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.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

PayerCustomerInfoIdstring

PayerCustomerInfoId. Nullable.

EstimatedDeliveryTimestring(date-time)

EstimatedDeliveryTime. Nullable.

DeliveryTimestring(date-time)

DeliveryTime. Nullable.

BuyerCustomerInfoIdstring

BuyerCustomerInfoId. Nullable.

ShipToCustomerInfoIdstring

ShipToCustomerInfoId. Nullable.

ExternalRefstring

ExternalRef. MaxLength: 50. Nullable.

PaymentMethodIdinteger(int32)

PaymentMethodId. Nullable.

DeliveryMethodIdinteger(int32)

DeliveryMethodId. Nullable.

OrderTypeIdinteger(int32)

OrderTypeId. Nullable.

IsForgottenboolean

IsForgotten.

ForgottenByinteger(int32)

ForgottenBy. Nullable.

ForgottenDatestring(date-time)

ForgottenDate. Nullable.

DropPointCustomerInfoIdstring

DropPointCustomerInfoId. Nullable.

DropPointCodestring

DropPointCode. MaxLength: 50. Nullable.

Quotationobject(Enferno.Storm.Query.Api.DataContexts.OrderModel.Quotation)(Enferno.Storm.Query.Api.DataContexts.OrderModel.Quotation)
ItemsArray of objects(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderItem)(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderItem)

Items.

InfosArray of objects(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderInfo)(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderInfo)

Infos.

Payerobject(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderCustomerInfo)(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderCustomerInfo)
Buyerobject(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderCustomerInfo)(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderCustomerInfo)
ShipToobject(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderCustomerInfo)(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderCustomerInfo)
DropPointobject(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderCustomerInfo)(Enferno.Storm.Query.Api.DataContexts.OrderModel.OrderCustomerInfo)
]
Response
application/json
[ { "Id": "string", "ClientId": 0, "ApplicationId": 0, "QuotationId": 0, "OrderNo": "string", "OrderDate": "2019-08-24T14:15:22Z", "BuyerCompanyCode": "string", "BuyerCompanyId": 0, "BuyerCustomerCode": "string", "BuyerCustomerId": 0, "PayerCompanyCode": "string", "PayerCompanyId": 0, "PayerCustomerCode": "string", "PayerCustomerId": 0, "ResellerCompanyCode": "string", "ResellerCompanyId": 0, "ResellerCustomerCode": "string", "ResellerCustomerId": 0, "GroupCode": "string", "StatusId": 0, "SalesRepContactId": 0, "Source": "string", "DeliveryTerms": "string", "DeliveryMode": "string", "DeliveryDate": "2019-08-24T14:15:22Z", "IsPartDelivery": true, "PaymentTerms": "string", "CurrencyId": 0, "VatRate": 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", "Created": "2019-08-24T14:15:22Z", "CreatedBy": 0, "Updated": "2019-08-24T14:15:22Z", "UpdatedBy": 0, "PayerCustomerInfoId": "string", "EstimatedDeliveryTime": "2019-08-24T14:15:22Z", "DeliveryTime": "2019-08-24T14:15:22Z", "BuyerCustomerInfoId": "string", "ShipToCustomerInfoId": "string", "ExternalRef": "string", "PaymentMethodId": 0, "DeliveryMethodId": 0, "OrderTypeId": 0, "IsForgotten": true, "ForgottenBy": 0, "ForgottenDate": "2019-08-24T14:15:22Z", "DropPointCustomerInfoId": "string", "DropPointCode": "string", "Quotation": {}, "Items": [], "Infos": [], "Payer": {}, "Buyer": {}, "ShipTo": {}, "DropPoint": {} } ]

Get Quotation

Request

Get Quotation

curl -i -X GET \
  https://query.storm.io/Query/2.0/Orders/Quotations

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

ApplicationIdinteger(int32)

ApplicationId.

SalesContactIdinteger(int32)

SalesContactId. Nullable.

BuyerAccountKeystring(guid)

BuyerAccountKey.

BuyerAccountIdinteger(int32)

BuyerAccountId. Nullable.

PayerAccountIdinteger(int32)

PayerAccountId. Nullable.

PayerAccountKeystring(guid)

PayerAccountKey. Nullable.

StatusIdinteger(int32)

StatusId.

IsPrimaryboolean

IsPrimary.

Namestring

Name. MaxLength: 50. Nullable.

ValidTostring(date-time)

ValidTo. Nullable.

IsDeletableboolean

IsDeletable.

DeleteDatestring(date-time)

DeleteDate. Nullable.

Commentstring

Comment. MaxLength: 250. Nullable.

RejectionReasonIdinteger(int32)

RejectionReasonId. Nullable.

Modifiedstring(date-time)

Modified. Nullable.

Browsedstring(date-time)

Browsed. Nullable.

PaymentMethodIdinteger(int32)

PaymentMethodId. Nullable.

DeliveryMethodIdinteger(int32)

DeliveryMethodId. Nullable.

IpAddressstring

IpAddress. MaxLength: 50. Nullable.

PayerFirstNamestring

PayerFirstName. MaxLength: 50. Nullable.

PayerMiddleNamestring

PayerMiddleName. MaxLength: 50. Nullable.

PayerLastNamestring

PayerLastName. MaxLength: 50. Nullable.

PayerCellPhoneNumberstring

PayerCellPhoneNumber. MaxLength: 50. Nullable.

PayerEmailstring

PayerEmail. MaxLength: 255. Nullable.

CurrencyIdinteger(int32)

CurrencyId.

ResellerCustomerIdinteger(int32)

ResellerCustomerId. Nullable.

IsLockedboolean

IsLocked. Nullable.

DiscountCodestring

DiscountCode. Nullable.

IsActiveboolean

IsActive. Nullable.

ParentQuotationIdinteger(int32)

ParentQuotationId. Nullable.

ClientIdinteger(int32)

ClientId. Nullable.

BuyerCompanyIdinteger(int32)

BuyerCompanyId. Nullable.

PayerCompanyIdinteger(int32)

PayerCompanyId. Nullable.

HasPaymentTransactionboolean

HasPaymentTransaction. Nullable.

BuyerFirstNamestring

BuyerFirstName. MaxLength: 50. Nullable.

BuyerMiddleNamestring

BuyerMiddleName. MaxLength: 50. Nullable.

BuyerLastNamestring

BuyerLastName. MaxLength: 50. Nullable.

BuyerCellPhoneNumberstring

BuyerCellPhoneNumber. MaxLength: 50. Nullable.

BuyerEmailstring

BuyerEmail. MaxLength: 255. Nullable.

CustomerOrderReferencestring

CustomerOrderReference. MaxLength: 50. Nullable.

Createdstring(date-time)

Created. Nullable.

CreatedByinteger(int32)

CreatedBy. Nullable.

ReferIdinteger(int32)

ReferId. Nullable.

ReferUrlstring

ReferUrl. MaxLength: 255. Nullable.

PayerSocialSecurityNumberstring

PayerSocialSecurityNumber. MaxLength: 50. Nullable.

BuyerCustomerIdinteger(int32)

BuyerCustomerId. Nullable.

PayerCustomerIdinteger(int32)

PayerCustomerId. Nullable.

ShipToCustomerIdinteger(int32)

ShipToCustomerId. Nullable.

RowIdstring

RowId. MaxLength: 8. Nullable.

PickupCodestring

PickupCode. MaxLength: 50. Nullable.

AttestedByinteger(int32)

AttestedBy. Nullable.

ModifiedByinteger(int32)

ModifiedBy. Nullable.

TypeIdinteger(int32)

TypeId. Nullable.

DoHoldboolean

DoHold.

DeliveryMethodCodestring

DeliveryMethodCode. MaxLength: 50. Nullable.

FreightPricenumber(decimal)

FreightPrice. Nullable.

InfosArray of objects(Enferno.Storm.Query.Api.DataContexts.OrderModel.QuotationInfo)(Enferno.Storm.Query.Api.DataContexts.OrderModel.QuotationInfo)

Infos.

ItemsArray of objects(OrderService.QuotationItem)(OrderService.QuotationItem)

Items.

AddressesArray of objects(OrderService.QuotationCustomerAddress)(OrderService.QuotationCustomerAddress)

Addresses.

]
Response
application/json
[ { "Id": 0, "ApplicationId": 0, "SalesContactId": 0, "BuyerAccountKey": "string", "BuyerAccountId": 0, "PayerAccountId": 0, "PayerAccountKey": "string", "StatusId": 0, "IsPrimary": true, "Name": "string", "ValidTo": "2019-08-24T14:15:22Z", "IsDeletable": true, "DeleteDate": "2019-08-24T14:15:22Z", "Comment": "string", "RejectionReasonId": 0, "Modified": "2019-08-24T14:15:22Z", "Browsed": "2019-08-24T14:15:22Z", "PaymentMethodId": 0, "DeliveryMethodId": 0, "IpAddress": "string", "PayerFirstName": "string", "PayerMiddleName": "string", "PayerLastName": "string", "PayerCellPhoneNumber": "string", "PayerEmail": "string", "CurrencyId": 0, "ResellerCustomerId": 0, "IsLocked": true, "DiscountCode": "string", "IsActive": true, "ParentQuotationId": 0, "ClientId": 0, "BuyerCompanyId": 0, "PayerCompanyId": 0, "HasPaymentTransaction": true, "BuyerFirstName": "string", "BuyerMiddleName": "string", "BuyerLastName": "string", "BuyerCellPhoneNumber": "string", "BuyerEmail": "string", "CustomerOrderReference": "string", "Created": "2019-08-24T14:15:22Z", "CreatedBy": 0, "ReferId": 0, "ReferUrl": "string", "PayerSocialSecurityNumber": "string", "BuyerCustomerId": 0, "PayerCustomerId": 0, "ShipToCustomerId": 0, "RowId": "string", "PickupCode": "string", "AttestedBy": 0, "ModifiedBy": 0, "TypeId": 0, "DoHold": true, "DeliveryMethodCode": "string", "FreightPrice": 0, "Infos": [], "Items": [], "Addresses": [] } ]

Get PurchaseOrder

Request

Get PurchaseOrder

curl -i -X GET \
  https://query.storm.io/Query/2.0/Orders/PurchaseOrders

Responses

Success

Bodyapplication/jsonArray [
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)
]
Response
application/json
[ { "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": {}, "SellToAddress": {}, "BillToAddress": {} } ]

Get DeliveryNote

Request

Get DeliveryNote

curl -i -X GET \
  https://query.storm.io/Query/2.0/Orders/DeliveryNotes

Responses

Success

Bodyapplication/jsonArray [
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.

]
Response
application/json
[ { "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": [] } ]

Get Invoice

Request

Get Invoice

curl -i -X GET \
  https://query.storm.io/Query/2.0/Orders/Invoices

Responses

Success

Bodyapplication/jsonArray [
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)
]
Response
application/json
[ { "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": {} } ]

Get WarehouseTransaction

Request

Get WarehouseTransaction

curl -i -X GET \
  https://query.storm.io/Query/2.0/Orders/WarehouseTransactions

Responses

Success

Bodyapplication/jsonArray [
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.

]
Response
application/json
[ { "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": [] } ]