There is a WADL document available that describes the resources API.
You may also enjoy the interactive interface provided for this API by Swagger.
name | path | methods | description |
---|---|---|---|
CarApi |
|
|
|
CustomerApi |
|
|
|
DeliveryApi |
|
|
|
DeviceApi |
|
|
Stellt Funktionen für die gerätespezifische Konfiguration zur Verfügung |
DocumentApi |
|
|
|
EdifactApi |
|
|
|
FinanceApi |
|
|
Funktionalität rund um die Resource Finanzwesen |
ForecastApi |
|
|
|
HvmaApi |
|
|
|
InventoryApi |
|
|
|
InvoiceApi |
|
|
Stellt Funktionen zur Ermittlung und Bezahlung von Rechnungen zur Verfügung |
ItemApi |
|
|
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 |
|
|
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 |
MachineApi |
|
|
|
OrderApi |
|
|
|
PartlistApi |
|
|
|
ProductionApi |
|
|
|
ProjectApi |
|
|
|
PropertyApi |
|
|
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
Artikelbezogenene Eigenschaften benötigen prinzipiel die Id des Artikels
( |
PurchaseInvoiceApi |
|
|
|
PurchaseOrderApi |
|
|
|
SoapCallsPersonalApi |
|
|
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 |
|
|
Funktionalität rund um das Personal |
StaffApiV11 |
|
|
Funktionalität rund um das Personal |
StockApi |
|
|
|
SystemApi |
|
|
Systeminformationen abfragen |
TodoApi |
|
|
|
TraveltimeApi |
|
|
|
UserApi |
|
|
|
WorktimeApi |
|
|
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. |
type | description |
---|---|
Attachment | |
AuslastungsAnzeigeDetailAg | |
BarcodeRecordingEntry | |
BaseEntryCnr | |
BaseEntryId | |
CarEntry | |
CarEntryList | |
ChangePasswordEntry | |
ContactEntry | |
ContactEntryList | |
ContentDisposition | |
CostBearingUnitEntry | |
CostBearingUnitEntryList | |
CountryEntry | |
CountryEntryList | |
CreateDeliveryItemPositionEntry | |
CreateDeliveryPositionEntry | Repräsentiert eine zu liefernde Position |
CreateDeliveryTextPositionEntry | |
CreateGoodsReceiptPositionEntry | Repräsentiert eine zu liefernde Position |
CreateGoodsReceiptPositionReelEntry | Repräsentiert eine zu liefernde Position |
CreateItemCustomerDeliveryPositionEntry | Repräsentiert eine zu liefernde Position |
CreateItemDeliveryPositionEntry | Repräsentiert eine zu liefernde Artikelposition |
CreateItemIdentityPropertyEntry | |
CreateItemIdentityPropertyEntryList | |
CreateItemPropertyEntry | |
CreateOrderItemPositionEntry | |
CreateOrderManualItemPositionEntry | Die Datenstruktur zum Anlegen einer Handeingabe-Position |
CreateOrderTextPositionEntry | |
CreateOrderTextblockPositionEntry | |
CreatePropertyEntry | |
CreatePurchaseOrderProposalPositionEntry | Repräsentiert eine zu erzeugende Position des Bestellvorschlags |
CreatedDeliveryPositionEntry | Repräsentiert die Information über die gelieferte Position |
CreatedGoodsReceiptPositionEntry | Repräsentiert eine zu liefernde Position |
CreatedGoodsReceiptPositionReelEntry | Repräsentiert eine zu liefernde Position |
CreatedOrderPositionEntry | Repräsentiert die Information über eine erzeugte Auftragspositon |
CreatedPurchaseOrderProposalPositionEntry | |
CurrencyEntry | |
CurrencyEntryList | |
CustomerDetailEntry | |
CustomerDetailLoggedOnEntry | |
CustomerEntry | |
CustomerPricelistItemDescriptionDto | |
CustomerPricelistItemDto | |
CustomerPricelistPriceDto | |
CustomerPricelistReportDto | |
CustomerPricelistShopgroupDto | |
DailyAllowanceEntry | |
DailyAllowanceEntryList | |
DayTypeEntry | |
DeliverableDeliveryEntry | |
DeliverableOrderEntry | |
DeliverableOrderPositionEntry | |
DeliverableOrderPositionEntryList | |
DeliveryData | |
DeliveryDocumentStatus | |
DeliveryEntry | |
DeliveryEntryList | |
DeliveryOrderEntry | |
DeliveryOrderEntryList | |
DeliveryPositionEntry | |
DeliveryPositionEntryList | |
DeliveryPostEntry | |
DeliverySlipSignatureEntry | |
DeliverySlipSignaturePostEntry | |
DeliveryTextPositionEntry | |
DeliveryTextPositionEntryList | |
DeviceConfigEntry | Die Daten der Gerätekonfiguration
Teile der Konfiguration können nur durch den HELIUM V Anwender abgeändert werden. |
DocumentInfoEntry | |
DocumentInfoEntryList | |
DocumentRecordingEntry | Die Zeitdaten einer Tätigkeit |
DocumentType | |
DoneProductionEntry | |
EmitProductionEntry | |
ForecastDeliveryAddressEntry | |
ForecastDeliveryAddressEntryList | |
ForecastPositionEntry | |
ForecastPositionEntryList | |
GoodsReceiptEntry | |
GoodsReceiptPositionEntry | |
GoodsReceiptPositionEntryList | |
HvmaLizenzEnum | |
HvmaLogonEntry | |
HvmaParamEntry | |
HvmaParamEntryList | |
HvmaRechtEnum | |
HvmarechtEnumEntryList | |
IdValueDto | |
IdentityAmountEntry | |
InventoryDataEntry | |
InventoryEntry | |
InvoiceCashPaymentEnum | |
InvoiceCashPaymentPostEntry | Properties für die Zahlung
Die Property cnr muss mit der eindeutigen Kassa-Nummer befüllt werden Für eine erfolgreiche Zahlung müssen der Betrag getAmount, die Zahlungsart getPaymentType und die Kassanummer getCnr gesetzt werden. |
InvoiceDocumentStatus | |
InvoiceEntry | |
InvoiceEntryList | |
InvoicePaymentEntry | |
ItemAmountEntry | |
ItemCommentMediaInfoEntry | |
ItemCommentMediaInfoEntryList | |
ItemEntry | |
ItemEntryInternal | |
ItemEntryList | |
ItemGroupEntry | |
ItemGroupEntryList | |
ItemHintEntry | |
ItemHintEntryList | |
ItemIdentityEntry | Die Seriennummer bzw. Chargennummer mit der zugehoerigen Menge |
ItemIdentityEntryList | Die Liste der Chargen- bzw. Seriennummern |
ItemLockEntry | |
ItemLockEntryList | |
ItemPropertyEntry | |
ItemPropertyEntryList | |
ItemPropertyEnum | |
ItemUnitEntry | |
ItemUnitEntryList | |
ItemV1Entry | |
ItemV1EntryList | |
JudgeEntry | |
JudgeEnum | |
LinecallDeliveryPostEntry | |
LinecallDeliveryResultEntry | |
LinecallEntry | |
LinecallEntryList | |
LinecallItemEntry | |
LocalPingResult | |
LogBarcodeEntry | |
LogMessageEntry | |
LogSeverity | |
LoggedOnEntry | Repräsentiert die Antwort eines erfolgreichen Logons |
LoggedOnHvmaEntry | Repräsentiert die Antwort eines erfolgreichen Logons |
LoggedOnTenantEntry | Repräsentiert die Antwort eines erfolgreichen Logons |
LogonEntry | |
LogonIdCardEntry | |
LogonTenantEntry | |
MachineAvailabilityEntry | |
MachineAvailabilityEntryList | |
MachineEntry | |
MachineEntryList | |
MachineGroupEntry | |
MachineGroupEntryList | |
MachineRecordingEntry | |
MachineRecordingType | |
MaterialRequirementEntry | |
MaterialRequirementEntryList | |
MaterialRequirementPostEntry | |
MaterialWithdrawalEntry | |
MediaType | |
MimeTypeEnum | |
MonthlyReportEntry | |
MountingMethodEntry | |
MountingMethodEntryList | |
MultipartBody | |
OfflineOrderEntry | |
OpenWorkEntry | |
OpenWorkEntryList | |
OpenWorkUpdateEntry | |
OpenWorkUpdateEntryList | |
OrderActivationEntry | |
OrderAddress | |
OrderAddressContact | |
OrderComments | |
OrderDocumentStatus | |
OrderEntry | |
OrderRecordingEntry | Die Zeitdaten einer Tätigkeit |
OrderSortedEntry | |
OrderpositionEntry | |
OrderpositionsEntry | |
PackagingInfoEntry | |
PackagingInfoEntryList | |
ParameterEntry | |
ParameterRequestEntry | |
PartlistEmailEntry | |
PartlistEntry | |
PartlistEntryList | |
PartlistPositionEntry | |
PartlistPositionEntryList | |
PartlistPositionPostEntry | |
PartlistPositionPutEntry | |
PartlistWorkstepEntry | |
PartlistWorkstepEntryList | |
PartnerEntry | |
PaymentEnum | |
PickingPrinterEntry | |
PickingPrinterEntryList | |
PickingType | |
PingResult | |
PlanningView | |
PositionDataEntry | Die Metadaten einer Position. Id der Position Positionsart isort |
PositionDataEntryList | |
PositionDataType | |
PostPurchaseInvoices | |
PriceListEntry | |
PriceListEntryList | |
PrintProductionEntry | |
PrintProductionLabelEntry | |
ProducerInfoEntry | |
ProductType | |
ProductionAdditionalStatusEntry | |
ProductionAdditionalStatusEntryList | |
ProductionEntry | |
ProductionEntryList | |
ProductionGroupEntry | |
ProductionGroupEntryList | |
ProductionRecordingEntry | Die Zeitdaten einer Tätigkeit |
ProductionStatus | |
ProductionTargetMaterialEntry | |
ProductionTargetMaterialEntryList | |
ProductionWorkstepEntry | |
ProductionWorkstepEntryList | |
ProjectEntry | |
ProjectEntryList | |
ProjectRecordingEntry | Die Zeitdaten einer Tätigkeit |
PropertyLayoutEntry | |
PropertyLayoutEntryList | |
PropertyLayoutFill | |
PropertyLayoutOrientation | |
PropertyLayoutType | |
PurchaseInvoiceEntry | |
PurchaseInvoiceEntryList | |
PurchaseOrderEntry | |
PurchaseOrderEntryList | |
PurchaseOrderPositionEntry | |
PurchaseOrderPositionEntryList | |
PurchaseOrderProposalPositionEntry | |
PurchaseOrderProposalPositionEntryList | |
PurchaseOrderStatus | |
SettlementOfHoursEntry | |
SettlementOfHoursSignatureEntry | |
ShopGroupEntry | |
ShopGroupEntryList | |
SoapCallPersonalResult | |
SpecialActivity | Eine Sondertaetigkeit |
SpecialTimesEntry | |
SpecialTimesEntryList | |
SpecialTimesEnum | |
StaffEntry | |
StockAmountEntry | |
StockAmountEntryList | |
StockAmountInfoEntry | |
StockEntry | |
StockEntryList | |
StockInfoEntry | |
StockInfoEntryList | |
StockInfoItemEntry | |
StockInfoItemEntryList | |
StockInventoryEntry | |
StockMovementChangeEntry | Die Daten der Handlagerbewegung für eine Umbuchung |
StockMovementEntry | Die Handlagerbewegung |
StockMovementEntryList | |
StockPlaceEntry | |
StockPlaceEntryList | |
StockPlacePostEntry | |
StopProductionEntry | |
SupplierDetailEntry | |
SynchEntry | |
TaxDescriptionEntry | |
TaxDescriptionEntryList | |
TenantEntry | |
TenantEntryList | |
TestPlanCrimpEntry | |
TestPlanCrimpIsoEntry | |
TestPlanDimensionalTestEntry | |
TestPlanElectricalTestEntry | |
TestPlanEntry | |
TestPlanEntryList | |
TestPlanForceMeasurementEntry | |
TestPlanMaterialStatusEntry | |
TestPlanMultipleCrimpEntry | |
TestPlanMultipleCrimpIsoEntry | |
TestPlanOpenTestEntry | |
TestPlanOpticalTestEntry | |
TestResultCrimpingEntry | |
TestResultCrimpingIsolationEntry | |
TestResultDimensionalTestEntry | |
TestResultElectricalTestEntry | |
TestResultEntry | |
TestResultEntryList | |
TestResultForceMeasurementEntry | |
TestResultMaterialStatus | |
TestResultMaterialStatusEntry | |
TestResultMultipleCrimpingEntry | |
TestResultMultipleCrimpingIsolationEntry | |
TestResultOpenTestEntry | |
TestResultOpticalTestEntry | |
TestResultPostEntry | |
TestTypeEnum | |
TextblockEntry | |
TextblockEntryList | |
TimeBalanceEntry | |
TimeRecordingBatchEntry | |
TimeRecordingBatchEntryList | |
TimeRecordingBatchEnum | |
TimeRecordingEntry | |
TodoDetailEntry | |
TodoDetailEntryList | |
TodoDetailEntryType | |
TodoDetailIdentEntry | |
TodoDetailManualEntry | |
TodoDetailProjectEntry | |
TodoDetailTextEntry | |
TodoDetailTravelEnum | |
TodoDetailZwsEntry | |
TodoDocumentEntry | |
TodoDocumentEntryList | |
TodoEntry | Beschreibt die Properties eines Todo-Eintrags |
TodoEntryList | |
TodoEntryType | |
TravelTimeApiInfo | |
TravelTimeRecordingBatchEntry | |
TravelTimeRecordingBatchEntryList | |
UpdateItemPropertyEntry | |
UpdatePropertyEntry | |
UpdatePurchaseOrderProposalPositionEntry | Repräsentiert die optional zu verändernden Eigenschaften einer Position des Bestellvorschlags |
WorkCalendarEntry | |
WorkCalendarEntryList | |
ZeitdatenEntry |
type | description |
---|---|
baseEntryCnr | |
baseEntryId | |
carEntry | |
contactEntry | |
contactEntryList | |
customerDetailEntry | |
customerEntry | |
deliverableDeliveryEntry | |
deliveryDocumentStatus | |
deliveryEntry | |
deliveryPositionEntry | |
deliverySlipSignatureEntry | |
deliverySlipSignaturePostEntry | |
deliveryTextPositionEntry | |
positionDataEntry | Die Metadaten einer Position. Id der Position Positionsart isort |
positionDataType | |
deviceConfigEntry | Die Daten der Gerätekonfiguration
Teile der Konfiguration können nur durch den HELIUM V Anwender abgeändert werden. |
documentInfoEntry | |
documentInfoEntryList | |
currencyEntry | |
forecastDeliveryAddressEntry | |
forecastPositionEntry | |
linecallEntry | |
linecallItemEntry | |
pickingPrinterEntry | |
pickingType | |
productType | |
hvmaParamEntry | |
invoiceCashPaymentEnum | |
invoiceCashPaymentPostEntry | Properties für die Zahlung
Die Property cnr muss mit der eindeutigen Kassa-Nummer befüllt werden Für eine erfolgreiche Zahlung müssen der Betrag getAmount, die Zahlungsart getPaymentType und die Kassanummer getCnr gesetzt werden. |
invoiceDocumentStatus | |
invoiceEntry | |
invoicePaymentEntry | |
inventoryEntry | |
itemCommentMediaInfoEntry | |
itemCommentMediaInfoEntryList | |
itemEntry | |
itemEntryInternal | |
itemGroupEntry | |
itemHintEntry | |
itemIdentityEntry | Die Seriennummer bzw. Chargennummer mit der zugehoerigen Menge |
itemIdentityEntryList | Die Liste der Chargen- bzw. Seriennummern |
itemLockEntry | |
itemPropertyEntry | |
itemPropertyEnum | |
itemV1Entry | |
itemV1EntryList | |
packagingInfoEntry | |
packagingInfoEntryList | |
priceListEntry | |
producerInfoEntry | |
shopGroupEntry | |
stockAmountInfoEntry | |
stockEntry | |
machineEntry | |
machineEntryList | |
machineGroupEntry | |
deliverableOrderEntry | |
deliverableOrderPositionEntry | |
deliverableOrderPositionEntryList | |
deliveryOrderEntry | |
deliveryOrderEntryList | |
orderActivationEntry | |
orderAddress | |
orderComments | |
orderDocumentStatus | |
orderEntry | |
orderSortedEntry | |
orderpositionEntry | |
orderpositionsEntry | |
settlementOfHoursEntry | |
settlementOfHoursSignatureEntry | |
mountingMethodEntry | |
partlistEntry | |
partlistPositionEntry | |
partlistPositionPostEntry | |
partlistPositionPutEntry | |
partlistWorkstepEntry | |
partlistWorkstepEntryList | |
productionGroupEntry | |
testTypeEnum | |
doneProductionEntry | |
emitProductionEntry | |
identityAmountEntry | |
itemHintEntryList | |
itemLockEntryList | |
materialWithdrawalEntry | |
openWorkEntry | |
openWorkUpdateEntry | |
printProductionEntry | |
printProductionLabelEntry | |
productionAdditionalStatusEntry | |
productionAdditionalStatusEntryList | |
productionEntry | |
productionStatus | |
productionTargetMaterialEntry | |
productionTargetMaterialEntryList | |
productionWorkstepEntry | |
productionWorkstepEntryList | |
stopProductionEntry | |
testPlanCrimpEntry | |
testPlanCrimpIsoEntry | |
testPlanDimensionalTestEntry | |
testPlanElectricalTestEntry | |
testPlanEntry | |
testPlanEntryList | |
testPlanForceMeasurementEntry | |
testPlanMaterialStatusEntry | |
testPlanMultipleCrimpEntry | |
testPlanMultipleCrimpIsoEntry | |
testPlanOpenTestEntry | |
testPlanOpticalTestEntry | |
projectEntry | |
createItemIdentityPropertyEntry | |
goodsReceiptEntry | |
goodsReceiptPositionEntry | |
purchaseOrderEntry | |
purchaseOrderPositionEntry | |
purchaseOrderProposalPositionEntry | |
purchaseOrderStatus | |
staffEntry | |
workCalendarEntry | |
itemAmountEntry | |
stockInfoEntry | |
stockInfoEntryList | |
stockInfoItemEntry | |
stockInfoItemEntryList | |
stockInventoryEntry | |
stockMovementChangeEntry | Die Daten der Handlagerbewegung für eine Umbuchung |
stockMovementEntry | Die Handlagerbewegung |
stockPlaceEntry | |
stockPlaceEntryList | |
supplierDetailEntry | |
costBearingUnitEntry | |
countryEntry | |
itemUnitEntry | |
judgeEntry | |
parameterEntry | |
parameterRequestEntry | |
propertyLayoutEntry | |
propertyLayoutFill | |
propertyLayoutOrientation | |
propertyLayoutType | |
taxDescriptionEntry | |
tenantEntry | |
textblockEntry | |
todoDetailEntry | |
todoDetailEntryList | |
todoDetailEntryType | |
todoDetailIdentEntry | |
todoDetailManualEntry | |
todoDetailProjectEntry | |
todoDetailTextEntry | |
todoDetailTravelEnum | |
todoDetailZwsEntry | |
todoDocumentEntry | |
todoDocumentEntryList | |
todoEntry | Beschreibt die Properties eines Todo-Eintrags |
todoEntryType | |
dailyAllowanceEntry | |
changePasswordEntry | |
hvmaLogonEntry | |
logonEntry | |
logonIdCardEntry | |
logonTenantEntry | |
barcodeRecordingEntry | |
dayTypeEntry | |
documentRecordingEntry | Die Zeitdaten einer Tätigkeit |
machineRecordingEntry | |
machineRecordingType | |
orderRecordingEntry | Die Zeitdaten einer Tätigkeit |
productionRecordingEntry | Die Zeitdaten einer Tätigkeit |
projectRecordingEntry | Die Zeitdaten einer Tätigkeit |
specialTimesEntry | |
specialTimesEntryList | |
specialTimesEnum | |
timeRecordingBatchEntry | |
timeRecordingBatchEntryList | |
timeRecordingBatchEnum | |
timeRecordingEntry | |
zeitdatenEntry | |
mimeTypeEnum | |
hvmaLizenzEnum | |
multipartBody |