POS API Interface¶
A new RestAPI Interface was created to enable POS document processing especially related to e-shop documents (creating e-shop orders and e-shop order credit memos). All endpoints included in the interface are a part of the group navertica\pos.
Endpoint posShops¶
This endpoint exists for external systems to be able to download basic informations about the POS Shop setup. This endpoint only supports GET method.
| Element | Meaning |
|---|---|
| no | contains the value of the "No." field from the shop card |
| name | contains the value of the "Name" field from the shop card |
| defaultCustomerNo | contains the value of the "Default Customer No." from the shop card |
| customerPriceGroup | contains the value of the "Customer Price Group" field from the shop card |
| customerDiscountGroup | contains the value of the "Customer Discount Group" field from the shop card |
| priceGroupPriority | contains the value of the "Price Group Priority" field from the shop card, it can have two values
|
| address | contains the value of the "Address" field from the shop card |
| address2 | contains the value of the "Address 2" field from the shop card |
| city | contains the value of the "City" field from the shop card |
| postCode | contains the value of the "Post Code" field from the shop card |
| county | contains the value of the "County" field from the shop card |
| countryRegionCode | contains the value of the "Country/Region Code" from the shop card |
| contact | contains the value of the "Contact" field from the shop card |
| phoneNo | contains the value of the "Phone No." field from the shop card |
| phoneNo2 | contains the value of the "Phone No. 2" field from the shop card |
| reasonCodeBill | contains the value of the "Reason Code (Bill)" field from the shop card |
| reasonCodeReservation | contains the value of the "Reason Code (Reservation)" field from the shop card |
| reasonCodeEshop | contains the value of the "Reason Code (E-shop)" field from the shop card |
| reasonCodeOtherSources | contains the value of the "Reason Code (Other Sources)" field from the shop card |
| voucherApplicationLocation | contains the value of the "Voucher Application Location" field from the shop card |
| systemModifiedDateTime | contains the value of the standard system field "Last Modified Date Time" from the shop card |
| systemCreatedDateTime | contains the value of the standard system field "System Credted Date Time" from the shop card |
Endpoint posItems¶
This endoint exists for external systems to be able to read basic data of the shop items used for POS shop orders. This endpoint only supports GET method.
| Element | Meaning |
|---|---|
| no | contains the value of the "No." field from the item card |
| description | contains the value of the "Description" field from the item card |
| description2 | contains the value of the "Description 2" field from the item card |
| blocked | contains the value of the "Blocked" field from the item card |
| type | contains the value of the "Type" field from the item card, it can therefore contain values:
|
| baseUoM | contains the value of the "Base Unit Of Measure" field from the item card |
| gtin | contains the value of the "GTIN" field from the item card |
| itemCategoryCode | contains the values of the "Item Category Code" field from the item card |
| netWeight | contains the value of the "Net Weight" field from the item card |
| grossWeight | contains the value of the "Gross Weight" field from the item card |
| unitVolume | contains the value of the "Unit Volumne" field from the item card |
| tariffNo | contains the value of the "Tariff No." field from the item card |
| countryOfOrigin | contains the value of the "Country/Region of Origin" field from the item card |
| itemDiscountGroup | contains the value "Item Discount Group" field from the item card |
| salesUoM | contains the value of the "Sales Unit Of Measure" field from the item card |
| salesBlocked | contains the value of the "Sales Blocked" field from the item card |
| serviceBlocked | contains the value of the "Service Blocked" field from the item card |
| vendorNo | contains the value of the "Vendor No." field from the item card |
| vendorItemNo | contains the value of the "Vendor Item No." field from the item card |
| purchasingUoM | contains the value of the "Purchase Unit Of Measure" field from the item card |
| purchasingBlocked | contains the value of the "Purchasing Blocked" field from the item card |
| replenishmentSystem | contains the value of the "Replenishment System" field from the item card, it can therefore contain values:
|
| assemblyPolicy | contains the value of the "Assembly Policy" field from the item card |
| leadTime | contains the value of the "Lead Time Calculation" field from the item card |
| systemModifiedDateTime | contains the value of the standard "System Modified Date Time" field from the item card |
| systemCreatedDateTime | contains the value of the standard "System Created Date Time" field from the item card |
| systemId | contains the GUID of the item card record |
Endpoint posItemVariants¶
This endpoint allows for external systems to read the basic item variant data. This endpoint only supports GET method.
| Element | Meaning |
|---|---|
| itemNo | contains the value of the field "Item No." from the item variant |
| code | contains the value of the field "Code" from the item variant |
| description | contains the value of the field "Description" from the item variant |
| description2 | contains the value of the field "Description 2" from the item variant |
| blocked | contains the value of the field "Blocked" from the item variant |
| salesBlocked | contains the value of the field "Sales Blocked" from the item variant |
| serviceBlocked | contains the value of the field "Service Blocked" from the item variant |
| purchasingBlocked | contains the value of the field "Purchasing Blocked" from the item variant |
| systemModifiedDateTime | contains the value of the standard system field "System Modified Date Time" from the item variant |
| systemCreatedDateTime | contains the value of the standard system field "System Created Date Time" from the item variant |
| systemId | contains the value of the GUID of the item variant record |
| itemId | contains the value of the GUID of the item variant record |
Endpoint posItemReferences¶
This endpoint allows for external systems to read item references for your POS items and variants. This endpoint only supports GET method.
| Element | Meaning |
|---|---|
| itemNo | contains the value of the "Item No." field from the item reference |
| variantCode | contains the value of the "Variant Code" field from the item reference |
| description | contains the value of the "Description" field from the item reference |
| description2 | contains the value of the "Description 2" field from the item reference |
| referenceType | contains the value of the "Reference Type" field from the item reference, it can therefore contain values:
|
| referenceTypeNo | contains the value of the "Reference Type No." field from the item reference, meaning the related customer of vendor number |
| referenceNo | contains the value of the "Reerence No." field from the item reference, meaning the actual cross reference for the given combination of item and business partner |
| unitOfMeasure | contains the value of the "Unit of Measure" field from the item reference, meaning the unit of measure for which the cross reference is valid |
| startingDate | contains the value of the "Starting Date" field from the item reference |
| endingDate | contains the value of the "Ending Date" field from the item reference |
| systemModifiedDateTime | contains the value of the standard "System Modified Date Time" field from the item reference |
| systemCreatedDateTime | contains the value of the standard "System Created Date Time" field from the item reference |
| systemId | contains the value of the GUID of the item reference record |
| itemId | contains the value of the GUID of the related item record |
| variantId | contains the value of the GUID of the related item variant record |
Endpoint posPrices¶
This endpoint allows for external system to read sales and purchase prices used for your POS. This endpoint only supports GET method.
| Element | Meaning |
|---|---|
| priceListCode | contains the value of the "Price List Code" field from the price list line |
| lineNo | contains the value of the "Line No." field from the price list line |
| priceType | contains the value of the "Price Type" field from the price list line, it can therefore contain values:
|
| sourceType | contains the value of the "Source Type" field from the price list line, it can therefore contain values:
|
| sourceNo | contains the value of the "Source No." field from the price list line |
| assetType | contains the value of the "Asset Type" field from the price list line, it can therefore contain values:
|
| assetNo | contains the value of the "Asset No." field from the price list line |
| variantCode | contains the value of the "Variant Code" field from the price list line |
| currencyCode | contains the value of the "Currency Code" field from the price list line |
| startingDate | contains the value of the "Starting Date" field from the price list line |
| endingDate | contains the value of the "Ending Date" field from the price list line |
| minimumQuantity | contains the value of the "Minimum Quantity" field from the price list line |
| unitofMeasure | contains the value of the "Unit Of Measure" field from the price list line |
| specifies | contains the value of the "Defines" field from the price list line, it can therefore contain values:
|
| unitPrice | contains the value of the "Unit Price" field from the price list line (relevant for sales prices) |
| directUnitCost | contains the value of the "Direct Unit Cost" field from the price list line (relevant for purchase prices) |
| lineDiscount | contains the value of the "Line Discount %" field from the price list line |
| pricesIncludingVAT | contains the value of the "Prices Including VAT" field from the price list line |
| status | contains the value of the "Status" field from the price list line |
| vatProductPostingGroup | contains the value of the "VAT Product Posting Group" field from the price list line |
| vatBusinessPostingGroup | contains the value of the "VAT Business Posting Group" field from the price list line |
| allowLineDiscount | contains the value of the "Allow Line Discount" field from the price list line |
| allowInvoiceDiscount | contains the value of the "Allow Invoice Discount" field from the price list line |
| description | contains the value of the "Description" field from the price list line |
| systemModifiedDateTime | contains the value of the standard "System Modified Date Time" field from the price list line |
| systemCreatedDateTime | contains the value of the standard "System Created Date Time" field from the price list line |
Endpoint posLocations¶
This endpoint allows for the external system to read shop locations for your shops to be able to determine which location is connected to which shop. This endpoint only supports GET method.
| Element | Meaning |
|---|---|
| shopNo | contains the value of the "Shop No." field from the shop locations table |
| locationType | contains the value of the "Location Type" field from the shop locations table, it can therefore contain values:
|
| locationCode | contains the value of the "Location Code" field from the shop locations table |
| systemModifiedDateTime | contains the value of the standard "System Modified Date Time" field from the shop locations table |
| systemCreatedDateTime | contains the value of the standard "System Created Date Time" field from the shop locations table |
Endpoint posCustomers¶
This endpoint allows for the external system to read and created customers. This endpoint therefore supports using GET, POST and PATCH methods.
If you want to use the endpoint to create new customer record, you need to make sure that you have set up relevant customer templates in the "API Setup".
| Element | Meaning |
|---|---|
| no | contains the value of the "No." field from the customer card |
| name | contains the value of the "Name" field from the customer card |
| name2 | contains the value of the "Name 2" field from the customer card |
| address | contains the value of the "Address" field from the customer card |
| address2 | contains the value of the "Address 2" field from the customer card |
| city | contains the value of the "City" field from the customer card |
| postCode | contains the value of the "Post Code" field from the customer card |
| county | contains the value of the "County" field from the customer card |
| countryRegionCode | contains the value of the "Country/Region Code" field from the customer card |
| registrationNo | contains the value of the "Registration No." field from the customer card |
| vatRegistrationNo | contains the value of the "VAT Registration No." field from the customer card |
| billToCustotmerNo | contains the value of the "Bill-To-Customer No." field from the customer card |
| contact | contains the value of the "Contact" field from the customer card |
| phoneNo | contains the value of the "Phone No." field from the customer card |
| contains the value of the "E-Mail" field from the customer card | |
| languageCode | contains the value of the "Language Code" field from the customer card |
| formatRegion | contains the value of the "Format Region" field from the customer card |
| salesPersonCode | contains the value of the "Salesperson Code" field from the customer card |
| currencyCode | contains the value of the "Currency Code" field from the customer card |
| customerPriceGroup | contains the value of the "Customer Price Group" field from the customer card |
| customerDiscountGroup | contains the value of the "Customer Discount Group" field from the customer card |
| paymentTermCode | contains the value of the "Payment Terms Code" field from the customer card |
| paymentMethodCode | contains the value of the "Payment Method Code" field from the customer card |
| shipmentMethodCode | contains the value of the "Shipment Method Code" field from the customer card |
| shippingAgent | contains the value of the "Shipping Agent" field from the customer card |
| shippingAgentService | contains the value of the "Shipping Agent Service Code" field from the customer card |
| blocked | contains the value of the "Blocked" field from the customer card, it can therefore contain values:
|
| balance | contains the value of the "Balance (LCY)" field from the customer card |
| balanceDue | contains the value of the "Balance Due (LCY)" field from the customer card |
| creditLimit | contains the value of the "Credit Limit (LCY)" field from the customer card |
| systemModifiedDateTime | contains the value of the standard "System Modified Date Time" field from the customer card |
| systemCreatedDateTime | contains the value of the standard "System Created Date Time" field from the customer card |
Endpoint posShipToAddresses¶
This endpoint allows for the external system to read and create ship-to addresses for the customer. This endpoint therefore supports using GET, POST and PATCH methods.
| Element | Meaning |
|---|---|
| code | contains the value of the "Code" field from the ship-to address |
| customerNo | contains the value of the "Customer No." field from the ship-to address |
| name | contains the value of the "Name" field from the ship-to address |
| name2 | contains the value of the "Name 2" field from the ship-to address |
| address | contains the value of the "Address" field from the ship-to address |
| address2 | contains the value of the "Address 2" field from the ship-to address |
| city | contains the value of the "City" field from the ship-to address |
| postCode | contains the value of the "Post Code" field from the ship-to address |
| county | contains the value of the "County" field from the ship-to address |
| countryRegionCode | contains the value of the "Country/Region Code" field from the ship-to address |
| contact | contains the value of the "Contact" field from the ship-to address |
| phoneNo | contains the value of the "Phone No." field from the ship-to address |
| contains the value of the "E-Mail" field from the ship-to address | |
| salesPersonCode | contains the value of the "Salesperson Code" field from the ship-to address |
| shipmentMethodCode | contains the value of the "Shipment Method Code" field from the ship-to address |
| shippingAgent | contains the value of the "Shipping Agent Code" field from the ship-to address |
| shippingAgentService | contains the value of the "Shipping Agent Service Code" field from the ship-to address |
| systemModifiedDateTime | contains the value of the standard "System Modified Date Time" field from the ship-to address |
| systemCreatedDateTime | contains the value of the standard "System Created Date Time" field from the ship-to address |
Endpoint posSalesDocuments¶
This endpoint allows for the external system to read and create sales documents (POS bills and orders or credit memos) that origin in another system and are supposed to be fullfilled on POS. This endpoint therefore supports using GET, POST and PATCH methods.
| Element | Meaning |
|---|---|
| documentType | contains the value of the "Document Type" field from the sales header, the user can create following types of documents:
|
| documentNo | contains the value of the "Document No" field from the sales header; when inserting the document it is automatically assigned from the number series if not specified otherwise in the request |
| sellToCustomerNo | contains the value of the "Sell-To-Customer - No." field from the sales header |
| sellToCustomerName | contains the value of the "Sell-To-Customer - Name" field from the sales header |
| sellToCustomerName2 | contains the value of the "Sell-To- Customer - Name 2" field from the sales header |
| sellToCustomerAddress | contains the value of the "Sell-To-Customer - Address" field from the sales header |
| sellToCustomerAddresss2 | contains the value of the "Sell-To-Customer - Address 2" field from the sales header |
| sellToCustomerCity | contains the value of the "Sell-To-Customer - City" field from the sales header |
| sellToCustomerPostCode | contains the value of the "Sell-To-Customer - Post Code" field from the sales header |
| sellToCustomerCounty | contains the value of the "Sell-To-Customer - County" field from the sales header |
| sellToCustomerCountryRegion | contains the value of the "Sell-To-Customer - Country/Region Code" field from the sales header |
| sellToContact | contains the value of the "Sell-To-Customer - Contact" field from the sales header |
| sellToPhoneNo | contains the value of the "Sell-To-Customer - Phone No." field from the sales header |
| sellToEmail | contains the value of the "Sell-To-Customer - E-Mail" field from the sales header |
| billToCustomerNo | contians the value of the "Bill-To-Customer - No." field from the sales header |
| billToCustomerName | contains the value of the "Bill-To-Customer - Name" field from the sales header |
| billToCustomerName2 | contains the value of the "Bill-To-Customer - Name 2" field from the sales header |
| billToCustomerAddress | contains the value of the "Bill-To-Customer - Address" field from the sales header |
| billToCustomerAddresss2 | contains the value of the "Bill-To-Customer - Address 2" field from the sales header |
| billToCustomerCity | contains the value of the "Bill-To-Customer - City" field from the sales header |
| billToCustomerPostCode | contains the value of the "Bill-To-Customer - Post Code" field from the sales header |
| billToCustomerCounty | contains the value of the "Bill-To-Customer - County" field from the sales header |
| billToCustomerCountryRegion | contains the value of the "Bill-To-Customer - Country/Region Code" field from the sales header |
| billToContact | contains the value of the "Bill-To Contact" field from the sales header |
| shipToCode | contains the value of the "Ship-To-Code" field from the sales header |
| shipToCustomerName | contains the value of the "Ship-To - Name" field from the sales header |
| shipToCustomerName2 | contains the value of the "Ship-To - Name 2" field from the sales header |
| shipToCustomerAddress | contains the value of the "Ship-To - Address" field from the sales header |
| shipToCustomerAddresss2 | contains the value of the "Ship-To - Address 2" field from the sales header |
| shipToCustomerCity | contains the value of the "Ship-To - City" field from the sales header |
| shipToCustomerPostCode | contains the value of the "Ship-To - Post Code" field from the sales header |
| shipToCustomerCounty | contains the value of the "Ship-To - County" field from the sales header |
| shipToCustomerCountryRegion | contains the value of the "Ship-To - Country/Region Code" field from the sales header |
| shipToContact | contains the value of the "Ship-To - Contact" field from the sales header |
| shipToPhoneNo | contains the value of the "Ship-To - Phone No." field from the sales header |
| documentDate | contains the value of the "Document Date" field from the sales header |
| orderDate | contains the value of the "Order Date" field from the sales header |
| dueDate | contains the value of the "Due Date" field from the sales header |
| requestedDeliveryDate | contains the value of the "Requested Delivery Date" field from the sales header |
| promisedDeliveryDate | contains the value of the "Promised Delivery Date" field from the sales header |
| externalDocumentNo | contains the value of the "External Document No." field from the sales header |
| yourReference | contains the value of the "Your Reference" field from the sales header |
| salesPersonCode | contains the value of the "Salesperson Code" field from the sales header |
| status | contains the value of the "Status" field from the sales header |
| workDescription | contains the value of the "Work Description" field from the sales header |
| currencyCode | contains the value of the "Currency Code" field from the sales header |
| currencyFactor | contains the value of the "Currency Factor" field from the sales header (it gives the information about the currency exchange rate and is calcuated by deviding [1]:[Currency Exchange Rate]) |
| languageCode | contains the value of the "Language Code" field from the sales header |
| regionFormat | contains the value of the "Region Format" field from the sales header |
| pricesIncludingVAT | contains the value of the "Prices Including VAT" field from the sales header |
| registrationNo | contains the value of the "Registration No." field from the sales header |
| vatRegistrationNo | contains the value of the "VAT Registration No." field from the sales header |
| paymentTermsCode | contains the value of the "Payment Terms Code" field from the sales header |
| paymentMethodCode | contains the value of the "Payment Method Code" field from the sales header |
| shipmentMethodCode | contains the values of the "Shipment Method Code" field from the sales header |
| shippingAgent | contains the value of the "Shipping Agent Code" field from the sales header |
| shippingAgentService | contains the value of the "Shipping Agent Service Code" field from the sales header |
| locationCode | contains the value of the "Location Code" field from the sales header |
| shopNo | contains the value of the "Shop No." field from the sales header |
| reasonCode | contains the value of the "Reason Code" field from the sales header |
| amount | contains the value of the "Amount" field from the sales header |
| amountIncludingVAT | contains the value of the "Amount Including VAT" field from the sales header |
| systemModifiedDateTime | contains the value of the standard "System Modified Date Time" field from the sales header |
| systemCreatedDateTime | contains the value of the standard "System Created Date Time" field from the sales header |
Endpoint posSalesDocumentLines¶
This endpoint enables you to read and create sales document lines for documents to be processed on your POS. This endpoint therefore enables using GET, POST and PATCH methods.
| Element | Meaning |
|---|---|
| documentType | contains the value of the "Document Type" field from the sales line, the user should be able to user following types of documents:
|
| documentNo | contains the value of the "Document No." field from the sales line |
| documentLineNo | contains the value of the "Document Line No." field from the sales line |
| type | contains the value of the "Type" field from the sales line, it can therefore contain following values:
|
| no | contains the value of the "No." field from the sales line, it can therefore contain following types of values:
|
| variantCode | contains the value of the "Variant Code" field from the sales line for the line type Item |
| itemReferenceNo | contains the value of the "Item Reference No." field from the sales line for the line type Item |
| description | contains the value of the "Description" field from the sales line |
| description2 | contains the value of the "Description 2" field from the sales line |
| locationCode | contains the value of the "Location Code" field from the sales line |
| quantity | contains the value of the "Quantity" field from the sales line |
| unitOfMeasure | contains the value of the "Unit Of Measure" field from the sales line |
| unitPrice | contains the value of the "Unit Price" field from the sales line and contains the unit price excluding/including VAT based on the Prices Including VAT setup for the sales header |
| lineDiscount% | contains the value of the "Line Discount %" field from the sales line |
| vat% | contains the value of the "VAT %" field from the sales line - this field is read-only and it is not possible to modify its value |
| lineDiscountAmount | contains the value of the "Line Discount Amount" field from the sales line |
| lineAmount | contains the value of the "Line Amount" field from the sales line |
| shipmentDate | contains the value of the "Shipment Date" field from the sales line |
| requestedDeliveryDate | contains the value of the "Requested Delivery Date" field from the sales line |
| promisedDeliveryDate | contains the value of the "Promised Delivery Date" field from the sales line |
| appliesToEntryNo | contains the value of the "Applies To Entry No" field from the sales line |
| systemModifiedDateTime | contains the value of the standard "System Modified Date Time" field from the sales line |
| systemCreatedDateTime | contains the value of the standard "System Created Date Time" field from the sales line |
Endpoint posSalesInvoices¶
This enpdoint allows the external systems to download data regarding fullfilled sales orders. This endpoint only allows using GET method.
| Element | Meaning |
|---|---|
| no | contains the value of the "No." field from the posted sales invoice header |
| orderNo | contains the value of the "Order No." field from the posted sales invoice header |
| sellToCustomerNo | contains the value of the "Sell-To-Customer - No." field from the posted sales invoice header |
| sellToCustomerName | contains the value of the "Sell-To-Customer - Name" field from the posted sales invoice header |
| sellToCustomerName2 | contains the value of the "Sell-To- Customer - Name 2" field from the posted sales invoice header |
| sellToCustomerAddress | contains the value of the "Sell-To-Customer - Address" field from the posted sales invoice header |
| sellToCustomerAddresss2 | contains the value of the "Sell-To-Customer - Address 2" field from the posted sales invoice header |
| sellToCustomerCity | contains the value of the "Sell-To-Customer - City" field from the posted sales invoice header |
| sellToCustomerPostCode | contains the value of the "Sell-To-Customer - Post Code" field from the posted sales invoice header |
| sellToCustomerCounty | contains the value of the "Sell-To-Customer - County" field from the posted sales invoice header |
| sellToCustomerCountryRegion | contains the value of the "Sell-To-Customer - Country/Region Code" field from the posted sales invoice header |
| sellToContact | contains the value of the "Sell-To-Customer - Contact" field from the posted sales invoice header |
| sellToPhoneNo | contains the value of the "Sell-To-Customer - Phone No." field from the posted sales invoice header |
| sellToEmail | contains the value of the "Sell-To-Customer - E-Mail" field from the posted sales invoice header |
| billToCustomerNo | contians the value of the "Bill-To-Customer - No." field from the posted sales invoice header |
| billToCustomerName | contains the value of the "Bill-To-Customer - Name" field from the posted sales invoice header |
| billToCustomerName2 | contains the value of the "Bill-To-Customer - Name 2" field from the posted sales invoice header |
| billToCustomerAddress | contains the value of the "Bill-To-Customer - Address" field from the posted sales invoice header |
| billToCustomerAddresss2 | contains the value of the "Bill-To-Customer - Address 2" field from the posted sales invoice header |
| billToCustomerCity | contains the value of the "Bill-To-Customer - City" field from the posted sales invoice header |
| billToCustomerPostCode | contains the value of the "Bill-To-Customer - Post Code" field from the posted sales invoice header |
| billToCustomerCounty | contains the value of the "Bill-To-Customer - County" field from the posted sales invoice header |
| billToCustomerCountryRegion | contains the value of the "Bill-To-Customer - Country/Region Code" field from the posted sales invoice header |
| billToContact | contains the value of the "Bill-To Contact" field from the posted sales invoice header |
| shipToCode | contains the value of the "Ship-To-Code" field from the posted sales invoice header |
| shipToCustomerName | contains the value of the "Ship-To - Name" field from the posted sales invoice header |
| shipToCustomerName2 | contains the value of the "Ship-To - Name 2" field from the posted sales invoice header |
| shipToCustomerAddress | contains the value of the "Ship-To - Address" field from the posted sales invoice header |
| shipToCustomerAddresss2 | contains the value of the "Ship-To - Address 2" field from the posted sales invoice header |
| shipToCustomerCity | contains the value of the "Ship-To - City" field from the posted sales invoice header |
| shipToCustomerPostCode | contains the value of the "Ship-To - Post Code" field from the posted sales invoice header |
| shipToCustomerCounty | contains the value of the "Ship-To - County" field from the posted sales invoice header |
| shipToCustomerCountryRegion | contains the value of the "Ship-To - Country/Region Code" field from the posted sales invoice header |
| shipToContact | contains the value of the "Ship-To - Contact" field from the posted sales invoice header |
| shipToPhoneNo | contains the value of the "Ship-To - Phone No." field from the posted sales invoice header |
| documentDate | contans the value of the "Document Date" field from the posted sales invoice header |
| postingDate | contains the value of the "Posting Date" field from the posted sales invoice header |
| orderDate | contains the value of the "Order Date" field from the posted sales invoice header |
| dueDate | contains the value of the "Due Date" field from the posted sales invoice header |
| requestedDeliveryDate | contains the value of the "Requested Delivery Date" field from the posted sales invoice header |
| promisedDeliveryDate | contains the value of the "Promised Delivery Date" field from the posted sales invoice header |
| externalDocumentNo | contains the value of the "External Document No" field from the posted sales invoice header |
| yourReference | contains the value of the "Your Reference" field from the posted sales invoice header |
| salesPersonCode | contains the value of the "Salesperson Code" field from the posted sales invoice header |
| workDescription | contains the value of the "Work Description" field from the posted sales invoice header |
| currencyCode | contains the value of the "Currency Code" field from the posted sales invoice header |
| currencyFactor | contains the value of the "Currency Factor" field from the posted sales invoice header, it displays the value calculated as: [1]:[Currency Exchange Rate] |
| languageCode | contains the value of the "Language Code" field from the posted sales invoice header |
| regionFormat | contains the value of the "Region Format" field from the posted sales invoice header |
| pricesIncludingVAT | contains the value of the "Prices Including VAT" field from the posted sales invoice header |
| registrationNo | contains the value of the "Registration No." field from the posted sales invoice header |
| vatRegistrationNo | contains the value of the "VAT Registration No." field from the posted sales invoice header |
| paymentTermsCode | contains the value of the "Payment Terms Code" field from the posted sales invoice header |
| paymentMethodCode | contains the value of the "Payment Method Code" field from the posted sales invoice header |
| shipmentMethodCode | contains the value of the "Shipment Method Code" field from the posted sales invoice header |
| shippingAgent | contains the value of the "Shipping Agent Code" field from the posted sales invoice header |
| shippingAgentService | contains the value of the "Shipping Agent Service Code" field from the posted sales invoice header |
| locationCode | cointains the value of the "Location Code" field from the posted sales invoice header |
| shopNo | contains the value of the "Shop No." field from the posted sales invoice header |
| reasonCode | contains the value of the "Reason Code" field from the posted sales invoice header |
| cancelled | contains the value of the "Cancelled" field from the posted sales invoice header |
| closed | contains the value of the "Closed" field from the posted sales invoice header |
| amount | contains the value of the "Amount" field from the posted sales inovice header |
| amountIncludingVAT | contains the value of the "Amount Including VAT" field from the posted sales invoice header |
| remainingAmount | contains the value of the "Remaining Amount" field from the posted sales inovice header |
| systemModifiedDateTime | contains the value of the standard "System Modified Date Time" field from the posted sales invoice header |
| systemCreatedDateTime | contains the value of the standard "System Created Date Time" field from the posted sales invoice header |
Endpoint posSalesInvoiceLines¶
This endpoint allows the external system to download lines of the fullfilled sales orders. This endpoint therefore only allows using the GET method.
| Element | Meaning |
|---|---|
| documentNo | contains the value of the "Document No." field from the posted sales invoice line |
| documentLineNo | contains the value of the "Document Line No." field from the posted sales invoice line |
| type | contains the value of the "Type" field from the posted sales invoice line, it can therefore contain values:
|
| no | contains the value of the "No." field from the posted sales invoice line, it can therefore contains:
|
| variantCode | contains the value of the "Variant Code" field from the posted sales invoice line for lines with type "Item" |
| itemReferenceNo | contains the value of the "Item Reference No" field from the posted sales invoice line for the lines with type "Item" |
| description | contains the value of the "Description" field from the posted sales invoice line |
| description2 | contains the value of the "Description 2" field from the posted sales invoice line |
| locationCode | contains the value of the "Location Code" field from the posted sales invoice line |
| quantity | contains the value of the "Quantity" field from the posted sales invoice line |
| unitOfMeasure | contains the value of the "Unit of Measure" field from the posted sales invoice line |
| unitPrice | contains the value of the "Unit Price" field from the posted sales invoice line |
| lineDiscount% | contains the value of the "Line Disocunt %" field from the posted sales invoice line |
| vat% | contains the value of the "VAT %" field from the posted sales invoice line |
| lineDiscountAmount | contains the value of the "Line Discount Amount" field from the posted sales invoice line |
| lineAmount | contains the value of the "Line Amount" field from the posted sales invoice line; it contains the value the amount including/excluding VAT based on the prices including VAT setup of the sales invoice header |
| shipmentDate | contrains the value of the "Shipment Date" field from the posted sales invoice line |
| requestedDeliveryDate | contains the value of the "Requested Delivery Date" field from the posted sales invoice line |
| promisedDeliveryDate | contains the value of the "Promised Delivery Date" field from the posted sales invoice line |
| appliesToEntryNo | contains the value of the "Applies To Entry No." field from the posted sales invoice line |
| systemModifiedDateTime | contains the value of the standard "System Modified Date Time" field from the posted sales invoice line |
| systemCreatedDateTime | contains the value of the standard "System Created Date Time" field from the posted sales invoice line |
Endpoint posSalesCreditMemos¶
This enpdoint allows the external systems to download data regarding processed sales credit memos. This endpoint only allows using GET method.
| Element | Meaning |
|---|---|
| no | contains the value of the "No." field from the posted sales credit memo header |
| returnOrderNo | contains the value of the "Return Order No." field from the posted sales credit memo header |
| sellToCustomerNo | contains the value of the "Sell-To-Customer - No." field from the posted sales credit memo header |
| sellToCustomerName | contains the value of the "Sell-To-Customer - Name" field from the posted sales credit memo header |
| sellToCustomerName2 | contains the value of the "Sell-To- Customer - Name 2" field from the posted sales credit memo header |
| sellToCustomerAddress | contains the value of the "Sell-To-Customer - Address" field from the posted sales credit memo header |
| sellToCustomerAddresss2 | contains the value of the "Sell-To-Customer - Address 2" field from the posted sales credit memo header |
| sellToCustomerCity | contains the value of the "Sell-To-Customer - City" field from the posted sales credit memo header |
| sellToCustomerPostCode | contains the value of the "Sell-To-Customer - Post Code" field from the posted sales credit memo header |
| sellToCustomerCounty | contains the value of the "Sell-To-Customer - County" field from the posted sales credit memo header |
| sellToCustomerCountryRegion | contains the value of the "Sell-To-Customer - Country/Region Code" field from the posted sales credit memo header |
| sellToContact | contains the value of the "Sell-To-Customer - Contact" field from the posted sales credit memo header |
| sellToPhoneNo | contains the value of the "Sell-To-Customer - Phone No." field from the posted sales credit memo header |
| sellToEmail | contains the value of the "Sell-To-Customer - E-Mail" field from the posted sales credit memo header |
| billToCustomerNo | contians the value of the "Bill-To-Customer - No." field from the posted sales credit memo header |
| billToCustomerName | contains the value of the "Bill-To-Customer - Name" field from the posted sales credit memo header |
| billToCustomerName2 | contains the value of the "Bill-To-Customer - Name 2" field from the posted sales credit memo header |
| billToCustomerAddress | contains the value of the "Bill-To-Customer - Address" field from the posted sales credit memo header |
| billToCustomerAddresss2 | contains the value of the "Bill-To-Customer - Address 2" field from the posted sales credit memo header |
| billToCustomerCity | contains the value of the "Bill-To-Customer - City" field from the posted sales credit memo header |
| billToCustomerPostCode | contains the value of the "Bill-To-Customer - Post Code" field from the posted sales credit memo header |
| billToCustomerCounty | contains the value of the "Bill-To-Customer - County" field from the posted sales credit memo header |
| billToCustomerCountryRegion | contains the value of the "Bill-To-Customer - Country/Region Code" field from the posted sales credit memo header |
| billToContact | contains the value of the "Bill-To Contact" field from the posted sales credit memo header |
| shipToCode | contains the value of the "Ship-To-Code" field from the posted sales credit memo header |
| shipToCustomerName | contains the value of the "Ship-To - Name" field from the posted sales credit memo header |
| shipToCustomerName2 | contains the value of the "Ship-To - Name 2" field from the posted sales credit memo header |
| shipToCustomerAddress | contains the value of the "Ship-To - Address" field from the posted sales credit memo header |
| shipToCustomerAddresss2 | contains the value of the "Ship-To - Address 2" field from the posted sales credit memo header |
| shipToCustomerCity | contains the value of the "Ship-To - City" field from the posted sales credit memo header |
| shipToCustomerPostCode | contains the value of the "Ship-To - Post Code" field from the posted sales credit memo header |
| shipToCustomerCounty | contains the value of the "Ship-To - County" field from the posted sales credit memo header |
| shipToCustomerCountryRegion | contains the value of the "Ship-To - Country/Region Code" field from the posted sales credit memo header |
| shipToContact | contains the value of the "Ship-To - Contact" field from the posted sales credit memo header |
| shipToPhoneNo | contains the value of the "Ship-To - Phone No." field from the posted sales credit memo header |
| documentDate | contains the value of the "Document Date" field from the posted sales credit memo header |
| postingDate | contains the value of the "Posting Date" field from the posted sales credit memo header |
| orderDate | contains the value of the "Order Date" field from the posted sales credit memo header |
| dueDate | contains the value of the "Due Date" field from the posted sales credit memo header |
| requestedDeliveryDate | contains the value of the "Requested Delivery Date" field from the posted sales credit memo header |
| promisedDeliveryDate | contains the value of the "Promised Delivery Date" field from the posted sales credit memo header |
| externalDocumentNo | contains the value of the "External Document No" field from the posted sales credit memo header |
| yourReference | contains the value of the "Your Reference" field from the posted sales credit memo header |
| salesPersonCode | contains the value of the "Salesperson Code" field from the posted sales credit memo header |
| workDescription | contains the value of the "Work Description" field from the posted sales credit memo header |
| currencyCode | contains the value of the "Currency Code" field from the posted sales credit memo header |
| currencyFactor | contains the value of the "Currency Factor" field from the posted sales credit memo header |
| languageCode | contains the value of the "Language Code" field from the posted sales credit memo header |
| regionFormat | contains the value of the "Region Format" field from the posted sales credit memo header |
| pricesIncludingVAT | contains the value of the "Prices Including VAT" field from the posted sales credit memo header |
| registrationNo | contains the value of the "Registration No." field from the posted sales credit memo header |
| vatRegistrationNo | contains the value of the "VAT Registration No." field from the posted sales credit memo header |
| paymentTermsCode | contains the value of the "Payment Terms Code" field from the posted sales credit memo header |
| paymentMethodCode | contains the value of the "Payment Method Code" field from the posted sales credit memo header |
| shipmentMethodCode | contains the value of the "Shipment Method Code" field from the posted sales credit memo header |
| shippingAgent | contains the value of the "Shipping Agent Code" field from the posted sales credit memo header |
| shippingAgentService | contains the value of the "Shipping Agent Service Code" field from the posted sales credit memo header |
| locationCode | contains the value of the "Location Code" field from the posted sales credit memo header |
| shopNo | contains the value of the "Shop No." field from the posted sales credit memo header |
| reasonCode | contains the value of the "Reason Code" field from the posted sales credit memo header |
| cancelled | contains the value of the "Cancelled" field from the posted sales credit memo header |
| paid | contains the value of the "Paid" field from the posted sales credit memo header |
| amount | contains the value of the "Amount" field from the posted sales credit memo header |
| amountIncludingVAT | contains the value of the "Amount Including VAT" field from the posted sales credit memo header |
| remainingAmount | contains the value of the "Remaining Amount" field from the posted sales credit memo header |
| systemModifiedDateTime | contains the value of the standard "System Modified Date Time" field from the posted sales credit memo header |
| systemCreatedDateTime | contains the value of the standard "System Created Date Time" field from the posted sales credit memo header |
Endpoint posSlaesCreditMemoLines¶
This endpoint allows the external system to download data for the processed credit memo lines. This endpoint only supports the GET method.
| Element | Meaning |
|---|---|
| documentNo | contains the value of the "Document No." field from the posted sales credit memo line |
| documentLineNo | contains the value of the "Document Line NO." field from the posted sales credit memo line |
| type | contains the value of the "Type" field from the posted sales credit memo line, therefore it can contain following values:
|
| no | containt the value of the "No." field from the poted sales credit memo line, therefore it can contain following values:
|
| variantCode | contains the value of the "Variant Code" field from the posted sales credit memo line (it can only be used if the line type is set to Item) |
| itemReferenceNo | contains the value of the "Item Reference No." field from the posted sales credit memo line (it can only be used if the line type is set to Item) |
| description | contains the value of the "Description" field from the posted sales credit memo line |
| description2 | contains the value of the "Description 2" field from the posted sales credit memo line |
| locationCode | contains the value of the "Location Code" field from the posted sales credit memo line |
| quantity | contains the value of the "Quantity" field from the posted sales credit memo line |
| unitOfMeasure | contains the value of the "Unit Of Measure" field from the posted sales credit memo line |
| unitPrice | contains the value of the "Unit Price" field from the posted sales credit memo line; it shouws (bude obsahovat hodnotu pole "Jednotková cena s/bez DPH" z řádku účtovaného prodejního dobropisu) |
| lineDiscount% (bude obsahovat hodnotu pole "Řádková sleva %" z řádku účtovaného prodejního dobropisu) | |
| vat% (bude obsahovat hodnotu pole "DPH %" z řádku účtovaného prodejního dobropisu) | |
| lineDiscountAmount (bude obsahovat hodnotu pole "Částka řádkové slevy" z řádku účtovaného prodejního dobropisu) | |
| lineAmount (bude obsahovat hodnotu pole Částka na řádku s/bez DPH" z řádku účtovaného prodejního dobropisu) | |
| shipmentDate (bude obsahovat hodnotu pole "Datum odeslání" z řádku účtovaného prodejního dobropisu) | |
| requestedDeliveryDate (bude obsahovat hodnotu z pole "Požadované datum dodávky" z řádku účtovaného prodejního dobropisu) | |
| promisedDeliveryDate (bude obsahovat hodnotu z pole "Přislíbené datum dodávky" z řádku účtovaného prodejního dobropisu) | |
| appliesToEntryNo (bude obsahovat hodnotu z pole "Vyrovnáno položkou zboží" z řádku účtovaného prodejního dobropisu) | |
| systemModifiedDateTime (bude obsahovat hodnotu systémového pole "Datum a čas poslední změny" z řádku účtovaného prodejního dobropisu) | |
| systemCreatedDateTime (bude obsahovat hodnotu systémového pole "Datum a čas vytvoření" z řádku účtovaného prodejního dobropisu) |