Resources

There is a WADL document available that describes the resources API.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
CarApi
  • /api/v1/car
  • GET
CustomerApi
  • /api/v1/customer
  • /api/v1/customer/loggedon
  • /api/v1/customer/pricelist
  • /api/v1/customer/{customerid}
  • /api/v1/customer/{customerid}/pricelist
  • GET
  • GET
  • GET
  • GET
  • GET
DeliveryApi
  • /api/v1/delivery
  • /api/v1/delivery/customerposition
  • /api/v1/delivery/deliverable
  • /api/v1/delivery/forecastcustomerposition
  • /api/v1/delivery/list
  • /api/v1/delivery/position
  • /api/v1/delivery/positionfromorder
  • /api/v1/delivery/print
  • /api/v1/delivery/printdispatchlabel
  • /api/v1/delivery/printgoodsissuelabel
  • /api/v1/delivery/customerdeliverables/{customercnr}
  • /api/v1/delivery/customerdeliverablesid/{customerid}
  • /api/v1/delivery/position/{positionid}
  • /api/v1/delivery/{deliveryid}/document
  • /api/v1/delivery/{deliveryid}/itemposition
  • /api/v1/delivery/{deliveryid}/positions
  • /api/v1/delivery/{deliveryid}/printsignature
  • /api/v1/delivery/{deliveryid}/textposition
  • /api/v1/delivery/customerdeliverables/{customercnr}/{deliveryid}
  • /api/v1/delivery/{deliveryid}/document/list
  • /api/v1/delivery/{deliveryid}/itemposition/{positionid}
  • /api/v1/delivery/{deliveryid}/textposition/{positionid}
  • POST
  • POST
  • GET
  • POST
  • GET
  • DELETE POST
  • DELETE POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • PUT
  • GET POST
  • POST
  • GET
  • GET POST
  • POST
  • GET
  • GET
  • PUT
  • PUT
DeviceApi
  • /api/v1/device/config
  • GET PUT
Stellt Funktionen für die gerätespezifische Konfiguration zur Verfügung
DocumentApi
  • /api/v1/document
  • /api/v1/document/list
  • POST
  • GET
EdifactApi
  • /api/beta/edifact/orders
  • POST
FinanceApi
  • /api/v1/finance/currency
  • GET
Funktionalität rund um die Resource Finanzwesen
ForecastApi
  • /api/v1/forecast/deliveryaddress/list
  • /api/v1/forecast/linecall/{linecallid}
  • /api/v1/forecast/material/{positionid}
  • /api/v1/forecast/pickingprinter/list
  • /api/v1/forecast/position/list
  • /api/v1/forecast/position/{positionid}
  • /api/v1/forecast/material/{positionid}/delivery
  • /api/v1/forecast/position/{positionid}/printdispatchlabel
  • /api/v1/forecast/deliveryaddress/{deliveryaddressid}/position/list
  • GET
  • GET POST
  • POST
  • GET
  • GET
  • GET POST
  • GET POST
  • GET
  • GET
HvmaApi
  • /api/v1/hvma/logon
  • /api/v1/hvma/param
  • /api/v1/hvma/privilege
  • POST
  • GET
  • GET
InventoryApi
  • /api/v1/inventory
  • /api/v1/inventory/{inventoryid}/entry
  • /api/v1/inventory/{inventoryid}/entry/{itemid}/{amount}
  • GET
  • POST PUT
  • POST PUT
InvoiceApi
  • /api/v1/invoice
  • /api/v1/invoice/{invoiceid}/cashpayment
  • /api/v1/invoice/{invoiceid}/cashpayment/{paymentid}
  • /api/v1/invoice/{invoiceid}/cashpayment/{year}/{month}/{day}
  • GET
  • POST
  • POST
  • DELETE
Stellt Funktionen zur Ermittlung und Bezahlung von Rechnungen zur Verfügung
ItemApi
  • /api/v1/item
  • /api/v1/item/groups
  • /api/v1/item/list
  • /api/v1/item/properties
  • /api/v1/item/stocks
  • /api/v1/item/{itemid}/properties
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
Funktionalität rund um die Resource Artikel

Grundvoraussetzung für eine erfolgreiche Benutzung dieser Resource ist, dass der HELIUM V Mandant das Modul "Artikel" installiert hat. Für praktisch alle Zugriffe auf den Artikel muss der API Benutzer zumindest Leserechte auf den Artikel haben.

ItemApiV11
  • /api/v11/item
  • /api/v11/item/grouplist
  • /api/v11/item/groups
  • /api/v11/item/itemslistmanufacturer
  • /api/v11/item/itemv1
  • /api/v11/item/list
  • /api/v11/item/pricelist
  • /api/v11/item/pricelists
  • /api/v11/item/properties
  • /api/v11/item/property
  • /api/v11/item/propertylayouts
  • /api/v11/item/shopgrouplist
  • /api/v11/item/stocks
  • /api/v11/item/stockslist
  • /api/v11/item/property/{propertyid}
  • /api/v11/item/{itemid}/discardremaining
  • /api/v11/item/{itemid}/document
  • /api/v11/item/{itemid}/price
  • /api/v11/item/{itemid}/printlabel
  • /api/v11/item/{itemid}/properties
  • /api/v11/item/{itemid}/commentmedia/list
  • /api/v11/item/{itemid}/commentmedia/{itemcommentid}
  • /api/v11/item/{itemid}/document/list
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST PUT
  • GET
  • GET
  • GET
  • GET
  • GET
  • PUT
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
Funktionalität rund um die Resource Artikel

Grundvoraussetzung für eine erfolgreiche Benutzung dieser Resource ist, dass der HELIUM V Mandant das Modul "Artikel" installiert hat. Für praktisch alle Zugriffe auf den Artikel muss der API Benutzer zumindest Leserechte auf den Artikel haben.

Änderungen in dieser Version

Die Lagerstände stockslist werden nun als typisiertes Ergebnis geliefert
MachineApi
  • /api/v1/machine
  • /api/v1/machine/groups
  • /api/v1/machine/planningview
  • /api/v1/machine/{machineid}/availability
  • GET
  • GET
  • GET
  • GET
OrderApi
  • /api/v1/order
  • /api/v1/order/comments
  • /api/v1/order/deliverable
  • /api/v1/order/offline
  • /api/v1/order/position
  • /api/v1/order/position/{positionid}
  • /api/v1/order/{orderid}/activate
  • /api/v1/order/{orderid}/document
  • /api/v1/order/{orderid}/itemposition
  • /api/v1/order/{orderid}/manualitemposition
  • /api/v1/order/{orderid}/position
  • /api/v1/order/{orderid}/settlementofhours
  • /api/v1/order/{orderid}/sortbyitemnumber
  • /api/v1/order/{orderid}/textblock
  • /api/v1/order/{orderid}/textposition
  • /api/v1/order/{orderid}/itemposition/{positionid}
  • /api/v1/order/{orderid}/manualitemposition/{positionid}
  • GET
  • GET
  • GET
  • GET
  • GET
  • DELETE
  • POST
  • POST
  • POST
  • POST
  • GET
  • GET POST
  • POST
  • POST
  • POST
  • PUT
  • PUT
PartlistApi
  • /api/v1/partlist/list
  • /api/v1/partlist/mountingmethod
  • /api/v1/partlist/productiongroup
  • /api/v1/partlist/{partlistid}/browseposition
  • /api/v1/partlist/{partlistid}/email
  • /api/v1/partlist/{partlistid}/position
  • /api/v1/partlist/{partlistid}/print
  • /api/v1/partlist/{partlistid}/workstep
  • /api/v1/partlist/{partlistid}/position/{positionid}
  • GET
  • GET
  • GET
  • GET
  • POST
  • GET POST PUT
  • GET
  • GET
  • DELETE
ProductionApi
  • /api/v1/production
  • /api/v1/production/changeproductionordersize
  • /api/v1/production/changetoproduction
  • /api/v1/production/doneopenworklist
  • /api/v1/production/doneproduction
  • /api/v1/production/emitproduction
  • /api/v1/production/materialrequirements
  • /api/v1/production/materialwithdrawal
  • /api/v1/production/openwork
  • /api/v1/production/openworklist
  • /api/v1/production/printlabels
  • /api/v1/production/printpapers
  • /api/v1/production/stopproduction
  • /api/v1/production/testresult
  • /api/v1/production/{userid}
  • /api/v1/production/list/{userid}
  • /api/v1/production/{productionid}/dates
  • /api/v1/production/{productionid}/delivery
  • /api/v1/production/{productionid}/document
  • /api/v1/production/{productionid}/printlabel
  • /api/v1/production/{productionid}/printpackinglabel
  • /api/v1/production/{productionid}/printproductionsupplynote
  • /api/v1/production/{productionid}/targetmaterial
  • /api/v1/production/{productionid}/testplan
  • /api/v1/production/{productionid}/commentmedia/list
  • /api/v1/production/{productionid}/commentmedia/{itemcommentid}
  • /api/v1/production/{productionid}/document/list
  • /api/v1/production/{productionid}/targetmaterial/{itemid}
  • /api/v1/production/{productionid}/workstep/{productionworkstepid}/machine
  • GET
  • PUT
  • POST
  • PUT
  • POST
  • POST
  • POST
  • POST
  • GET PUT
  • PUT
  • GET
  • GET
  • POST
  • POST
  • GET
  • GET
  • PUT
  • POST
  • GET POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET PUT
ProjectApi
  • /api/v1/project
  • /api/v1/project/{projectid}/document
  • GET
  • POST
PropertyApi
  • /api/v1/property/identity/{itemid}/layouts
  • /api/v1/property/identity/{itemid}/properties
  • /api/v1/property/item/{itemid}/layouts
  • /api/v1/property/identity/{itemid}/properties/{layoutid}
  • GET
  • GET POST PUT
  • GET
  • GET PUT
Stellt Funktionen für die Verarbeitung von Eigenschaften (eines Artikels) zur Verfügung

Welche Eigenschaften prinzipiell für einen bestimmten Eigenschaftstyp zur Verfügung stehen, kann über die Endpunkte mit der Endung "/layouts" ermittelt werden. Aktuell werden

  • Artikeleigenschaften (beginnend mit /item/ und
  • Chargeneigenschaften (beginnend mit /identity/
unterstützt. Das Ergebnis wird als "Beschreibung (der Eigenschaften)" bezeichnet.

Artikelbezogenene Eigenschaften benötigen prinzipiel die Id des Artikels (itemid). Für die Chargeneigenschaften (die auch Eigenschaften für einen seriennummernbehafteten Artikel inkludieren) muss zusätzlich die Identität (Chargen- bzw. Seriennummer) angegeben werden. Eigenschaften die für eine bestimmte Charge- bzw. Seriennummer gesetzt werden, gelten für die gesamte Charge.
PurchaseInvoiceApi
  • /api/v1/purchaseinvoice/mobilebatch
  • /api/v1/purchaseinvoice/{purchaseInvoiceid}/document
  • POST
  • POST
PurchaseOrderApi
  • /api/v1/purchaseorder
  • /api/v1/purchaseorder/goodsreceipt
  • /api/v1/purchaseorder/goodsreceiptreel
  • /api/v1/purchaseorder/item
  • /api/v1/purchaseorder/itemlist
  • /api/v1/purchaseorder/list
  • /api/v1/purchaseorder/proposal
  • /api/v1/purchaseorder/proposalposition
  • /api/v1/purchaseorder/proposalposition/{proposalpositionid}
  • /api/v1/purchaseorder/goodsreceipt/{receiptid}/document
  • /api/v1/purchaseorder/goodsreceipt/{receiptid}/position
  • /api/v1/purchaseorder/goodsreceipt/{receiptid}/position/{positionid}/print
  • GET
  • GET POST
  • POST
  • GET
  • GET
  • GET
  • GET
  • POST
  • DELETE GET PUT
  • POST
  • GET
  • GET
SoapCallsPersonalApi
  • /api/soapcalls/personal/losablieferung
  • /api/soapcalls/personal/losablieferungchg
  • /api/soapcalls/personal/losablieferungsnr
  • /api/soapcalls/personal/losgroessenaenderung
  • POST
  • POST
  • POST
  • POST
Funktionalität rund um die Resource Personal

Es handelt sich um bereits bestehende Soap-Calls die nun zusätzlich als REST Call zur Verfügung stehen.

StaffApi
  • /api/v1/staff
  • GET
Funktionalität rund um das Personal
StaffApiV11
  • /api/v11/staff/list
  • /api/v11/staff/synch
  • /api/v11/staff/{userid}
  • GET
  • POST
  • GET
Funktionalität rund um das Personal
StockApi
  • /api/v1/stock
  • /api/v1/stock/{stockid}/place
  • /api/v1/stock/{stockid}/movement/{itemid}
  • /api/v1/stock/{stockid}/place/{stockplaceid}
  • GET
  • GET POST
  • DELETE GET POST PUT
  • DELETE
SystemApi
  • /api/v1/system/costbearingunit
  • /api/v1/system/country
  • /api/v1/system/itemunit
  • /api/v1/system/localping
  • /api/v1/system/log
  • /api/v1/system/logbarcode
  • /api/v1/system/ping
  • /api/v1/system/taxdescription
  • /api/v1/system/textblock
  • GET
  • GET
  • GET
  • GET
  • POST
  • POST
  • GET
  • GET
  • GET
Systeminformationen abfragen
TodoApi
  • /api/v1/todo
  • GET
TraveltimeApi
  • /api/v1/traveltime/api
  • /api/v1/traveltime/batch
  • /api/v1/traveltime/dailyallowance
  • GET
  • POST
  • GET
UserApi
  • /api/v1/logon
  • /api/v1/logonapp
  • /api/v1/logout
  • /api/v1/password
  • /api/v1/logonidcard/{idcard}
  • /api/v1/logout/{token}
  • POST
  • POST
  • GET
  • POST
  • POST
  • GET
WorktimeApi
  • /api/v1/worktime/activities
  • /api/v1/worktime/barcode
  • /api/v1/worktime/batch
  • /api/v1/worktime/coming
  • /api/v1/worktime/documenttypes
  • /api/v1/worktime/going
  • /api/v1/worktime/machine
  • /api/v1/worktime/monthlyreport
  • /api/v1/worktime/order
  • /api/v1/worktime/pausing
  • /api/v1/worktime/production
  • /api/v1/worktime/project
  • /api/v1/worktime/specialactivities
  • /api/v1/worktime/specialtimes
  • /api/v1/worktime/stopping
  • /api/v1/worktime/timebalance
  • /api/v1/worktime/{worktimeId}
  • /api/v1/worktime/{year}/{month}/{day}
  • GET
  • POST
  • POST
  • POST
  • GET
  • POST
  • POST
  • GET
  • POST
  • POST
  • POST
  • POST
  • GET
  • POST
  • POST
  • GET
  • DELETE
  • GET
Funktionalität rund um die Zeit(daten)erfassung
Generell gilt, dass nur am HELIUM V angemeldete REST-API Benutzer diese Funktionen durchführen können. Weiters werden die Rechte des Benutzers berücksichtigt. Er kann - wenn er darf - im Namen einer anderen Person/Mitarbeiter die Buchungen durchführen.

Der Benutzer der API ist dafür verantwortlich, dass chronologisch richtige Zeitbuchungen entstehen, da der HELIUM V Server zum gegebenen Zeitpunkt (noch) nicht in Zukunft schauen kann.

Weiterführende Dokumentation kann im HELIUM V Benutzerhandbuch nachgelesen werden.