PurchaseOrderApi Resource

GET /api/v1/purchaseorder

Eine (offene) Bestellung ermitteln

Ist die Bestellnummer - entweder die Bestellnummer oder die Id - bekannt, wird nur diese Bestellnummer betrachtet. Ist die Bestellnummer unbekannt, aber dafür die Lieferantennummer können darüber die Bestellungen ermittelt werden.

Die purchaseOrderId wird immer als erstes herangezogen, sofern sie angegeben wird. Fehlt sie, aber die Bestellnummer ist angegeben, so wird diese verwendet. Fehlt auch diese, wird die Lieferantennummer herangezogen. Für die Lieferantennummer können mehrere (offene) Bestellungen vorhanden sein.

Request Parameters
name type description constraints
hvtoken header ist der (optionale) beim Logon ermittelte "token" im Header  
addSupplierDetail query (optional) mit true wird zusätzlich der SupplierDetailEntry des Lieferanten ermittelt und ausgegeben boolean
filter_receiptpossible query mit true werden nur Bestellungen ermittelt, die im Status OFFEN, BESTAETIGT oder TEILERLEDIGT haben. Mit false werden alle Bestellungen ermittelt, die der purchaseOrderId, purchaseOrderCnr oder supplierCnr entsprechen. boolean
purchaseOrderCnr query ist die (optionale) gesuchte HELIUM V Bestellnummer  
purchaseOrderid query ist die (optionale) Id der gesuchtes HELIUM V Bestellung int
supplierCnr query ist die (optionale) Lieferantennummer  
userid query ist der (optionale) beim Logon ermittelte "token"  
Response Body
media type data type description
application/json PurchaseOrderEntryList (JSON)
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/purchaseorder
Content-Type: */*
Accept: application/json
hvtoken: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "cnr" : "...",
    "supplierId" : 12345,
    "status" : "NEW",
    "supplierEntry" : {
      "name1" : "...",
      "name2" : "...",
      "name3" : "...",
      "sign" : "...",
      "countryCode" : "...",
      "zipcode" : "...",
      "phone" : "...",
      "city" : "...",
      "addressType" : "...",
      "countryName" : "...",
      "street" : "...",
      "titlePrefix" : "...",
      "titlePostfix" : "...",
      "uid" : "...",
      "eori" : "...",
      "remark" : "...",
      "email" : "...",
      "website" : "...",
      "fax" : "...",
      "formattedCity" : "...",
      "formattedSalutation" : "...",
      "partnerId" : 12345,
      "contactEntries" : { },
      "id" : 12345
    },
    "supplierName" : "...",
    "supplierCity" : "...",
    "id" : 12345
  }, {
    "cnr" : "...",
    "supplierId" : 12345,
    "status" : "OPEN",
    "supplierEntry" : {
      "name1" : "...",
      "name2" : "...",
      "name3" : "...",
      "sign" : "...",
      "countryCode" : "...",
      "zipcode" : "...",
      "phone" : "...",
      "city" : "...",
      "addressType" : "...",
      "countryName" : "...",
      "street" : "...",
      "titlePrefix" : "...",
      "titlePostfix" : "...",
      "uid" : "...",
      "eori" : "...",
      "remark" : "...",
      "email" : "...",
      "website" : "...",
      "fax" : "...",
      "formattedCity" : "...",
      "formattedSalutation" : "...",
      "partnerId" : 12345,
      "contactEntries" : { },
      "id" : 12345
    },
    "supplierName" : "...",
    "supplierCity" : "...",
    "id" : 12345
  } ],
  "rowCount" : 12345
}

GET /api/v1/purchaseorder/goodsreceipt

Information über einen etwaigen Wareneingang zu einer Bestellung ermitteln

Es muss entweder die purchaseOrderCnr oder die purchaseOrderId angegeben werden. Existiert bereits ein Wareneingang mit der angegebenen Lieferscheinnummer, so werden die Daten zum Wareneingang übermittelt, ansonsten wird ein 404-Status zurückgeliefert.

Request Parameters
name type description constraints
hvtoken header ist der (optionale) beim Logon ermittelte "token" im Header  
deliveryslipcnr query ist die Lieferantenlieferscheinnummer für die der Wareneingang ermittelt werden soll  
filter_receiptpossible query boolean
purchaseOrderCnr query ist die (optionale) Bestellnummer  
purchaseOrderid query ist die (optionale) Id der Bestellnummer. int
userid query ist der (optionale) beim Logon ermittelte "token"  
Response Body
media type data type description
application/json GoodsReceiptEntry (JSON)
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/purchaseorder/goodsreceipt
Content-Type: */*
Accept: application/json
hvtoken: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "deliverySlipCnr" : "...",
  "purchaseOrderId" : 12345,
  "id" : 12345
}

POST /api/v1/purchaseorder/goodsreceipt

Eine Wareneingangsposition erstellen

Request Parameters
name type description constraints
hvtoken header ist der (optionale) beim Logon ermittelte "token" im Header  
filter_receiptpossible query wenn true wird der Wareneingang nur dann positiv verarbeitet, wenn für die entsprechende Bestellposition tatsächlich noch eine offene Menge existiert. Mit false kann eine beabsichtigte Überlieferung durchgeführt werden. boolean
userid query ist der (optionale) beim Logon ermittelte "token"  
Request Body
media type data type
application/json CreateGoodsReceiptPositionEntry (JSON)
application/xml;charset=UTF-8 object
Response Body
media type data type description
application/json CreatedGoodsReceiptPositionEntry (JSON) Informationen über die neu erzeugte/abgeänderte Wareneingangsposition
application/xml;charset=UTF-8 object

Example

Request
POST /api/v1/purchaseorder/goodsreceipt
Content-Type: application/json
Accept: application/json
hvtoken: ...

                
{
  "itemIdentity" : {
    "entries" : [ {
      "identity" : "...",
      "amount" : 12345.0,
      "version" : "...",
      "bundleIdentity" : "...",
      "bundleAmount" : 12345.0
    }, {
      "identity" : "...",
      "amount" : 12345.0,
      "version" : "...",
      "bundleIdentity" : "...",
      "bundleAmount" : 12345.0
    } ]
  },
  "amount" : 12345.0,
  "purchaseOrderPositionId" : 12345,
  "deliverySlipCnr" : "...",
  "goodsReceiptId" : 12345
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "openQuantity" : 12345.0,
  "purchaseOrderPositionId" : 12345,
  "goodsReceiptId" : 12345,
  "goodsReceiptPositionId" : 12345
}

POST /api/v1/purchaseorder/goodsreceiptreel

Request Parameters
name type description constraints
hvtoken header  
filter_receiptpossible query boolean
userid query  
Request Body
media type data type
application/json CreateGoodsReceiptPositionReelEntry (JSON)
application/xml;charset=UTF-8 object
Response Body
media type data type description
application/json CreatedGoodsReceiptPositionReelEntry (JSON)
application/xml;charset=UTF-8 object

Example

Request
POST /api/v1/purchaseorder/goodsreceiptreel
Content-Type: application/json
Accept: application/json
hvtoken: ...

                
{
  "amount" : 12345.0,
  "purchaseOrderPositionId" : 12345,
  "deliverySlipCnr" : "...",
  "goodsReceiptId" : 12345,
  "dateCode" : "...",
  "expirationDate" : "...",
  "barcode" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "openQuantity" : 12345.0,
  "purchaseOrderPositionId" : 12345,
  "goodsReceiptId" : 12345,
  "goodsReceiptPositionId" : 12345,
  "identity" : "..."
}

GET /api/v1/purchaseorder/item

Artikelinformationen zu einer Bestellposition ermitteln

Generell gilt, dass die Artikelnummer zu in einer der Bestellpositionen in der angegebenen Bestellungen gehören muss. Zuerst wird die Artikelnummer als Artikelnummer des Artikellieferanten interpretiert. Ist sie dort unbekannt, wird sie als Herstellerartikelnummer interpretiert. Ist sie auch dort unbekannt, wird sie als Artikelnummer ("Artikel CNR") interpretiert.

Request Parameters
name type description constraints
hvtoken header ist der (optionale) beim Logon ermittelte "token" im Header  
filter_receiptpossible query true wenn nur noch Positionen in der Bestellung berücksichtigt werden sollen, die noch offen sind. boolean
itemCnr query die gesuchte Artikelnummer  
purchaseOrderid query ist die Id der Bestellung int
userid query ist der (optionale) beim Logon ermittelte "token"  
Response Body
media type data type description
application/json PurchaseOrderPositionEntry (JSON) die Bestellposition passend zum gewünschten Artikel
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/purchaseorder/item
Content-Type: */*
Accept: application/json
hvtoken: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "itemEntry" : {
    "cnr" : "...",
    "description" : "...",
    "description2" : "...",
    "name" : "...",
    "shortName" : "...",
    "stockAmount" : 12345.0,
    "costs" : 12345.0,
    "billOfMaterialType" : "...",
    "available" : true,
    "comments" : [ "...", "..." ],
    "hidden" : true,
    "unitCnr" : "...",
    "typeCnr" : "...",
    "itemgroupCnr" : "...",
    "itemclassCnr" : "...",
    "revision" : "...",
    "stockAmountInfo" : {
      "stockAmount" : 12345.0,
      "reservedAmount" : 12345.0,
      "missingAmount" : 12345.0,
      "availableAmount" : 12345.0
    },
    "referenceNumber" : "...",
    "index" : "...",
    "hasSerialnr" : true,
    "hasChargenr" : true,
    "producerInfoEntry" : {
      "producerId" : 12345,
      "itemCnr" : "...",
      "itemDescription" : "...",
      "barcodeLeadIn" : "...",
      "hasInfo" : true
    },
    "packagingEntries" : {
      "entries" : [ { }, { } ]
    },
    "packagingAmount" : 12345.0,
    "batchSize" : 12345.0,
    "packagingAverageAmount" : 12345.0,
    "stockplaceInfoEntries" : {
      "entries" : [ { }, { } ]
    },
    "documentInfoEntries" : {
      "entries" : [ { }, { } ]
    },
    "itemCommentMediaInfoEntries" : {
      "entries" : [ { }, { } ]
    },
    "id" : 12345
  },
  "openQuantity" : 12345.0,
  "itemId" : 12345,
  "quantity" : 12345.0,
  "id" : 12345
}

GET /api/v1/purchaseorder/itemlist

Eine Liste aller Bestellpositionen (berücksichtigt werden nur Ident-Artikel oder Handeingaben)

Request Parameters
name type description constraints
hvtoken header ist der (optionale) beim Logon ermittelte "token" im Header  
filter_receiptpossible query true wenn nur noch Positionen in der Bestellung berücksichtigt werden sollen, die noch offen sind. boolean
purchaseOrderid query ist die Id der Bestellung int
userid query userId ist der (optionale) beim Logon ermittelte "token"  
Response Body
media type data type description
application/json PurchaseOrderPositionEntryList (JSON) eine (leere) Liste aller Bestellpositionen
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/purchaseorder/itemlist
Content-Type: */*
Accept: application/json
hvtoken: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "itemEntry" : {
      "cnr" : "...",
      "description" : "...",
      "description2" : "...",
      "name" : "...",
      "shortName" : "...",
      "stockAmount" : 12345.0,
      "costs" : 12345.0,
      "billOfMaterialType" : "...",
      "available" : true,
      "comments" : [ "...", "..." ],
      "hidden" : true,
      "unitCnr" : "...",
      "typeCnr" : "...",
      "itemgroupCnr" : "...",
      "itemclassCnr" : "...",
      "revision" : "...",
      "stockAmountInfo" : { },
      "referenceNumber" : "...",
      "index" : "...",
      "hasSerialnr" : true,
      "hasChargenr" : true,
      "producerInfoEntry" : { },
      "packagingEntries" : { },
      "packagingAmount" : 12345.0,
      "batchSize" : 12345.0,
      "packagingAverageAmount" : 12345.0,
      "stockplaceInfoEntries" : { },
      "documentInfoEntries" : { },
      "itemCommentMediaInfoEntries" : { },
      "id" : 12345
    },
    "openQuantity" : 12345.0,
    "itemId" : 12345,
    "quantity" : 12345.0,
    "id" : 12345
  }, {
    "itemEntry" : {
      "cnr" : "...",
      "description" : "...",
      "description2" : "...",
      "name" : "...",
      "shortName" : "...",
      "stockAmount" : 12345.0,
      "costs" : 12345.0,
      "billOfMaterialType" : "...",
      "available" : true,
      "comments" : [ "...", "..." ],
      "hidden" : true,
      "unitCnr" : "...",
      "typeCnr" : "...",
      "itemgroupCnr" : "...",
      "itemclassCnr" : "...",
      "revision" : "...",
      "stockAmountInfo" : { },
      "referenceNumber" : "...",
      "index" : "...",
      "hasSerialnr" : true,
      "hasChargenr" : true,
      "producerInfoEntry" : { },
      "packagingEntries" : { },
      "packagingAmount" : 12345.0,
      "batchSize" : 12345.0,
      "packagingAverageAmount" : 12345.0,
      "stockplaceInfoEntries" : { },
      "documentInfoEntries" : { },
      "itemCommentMediaInfoEntries" : { },
      "id" : 12345
    },
    "openQuantity" : 12345.0,
    "itemId" : 12345,
    "quantity" : 12345.0,
    "id" : 12345
  } ]
}

GET /api/v1/purchaseorder/list

Eine Liste aller Bestellungen gemäß den Filterkriterien

Request Parameters
name type description constraints
filter_cnr query (optional) schränkt die Ausgabe auf Bestellungen ein, die diesen Teil der Bestellnummer beinhalten  
filter_itemcnr query (optional) schränkt die Ausgabe auf Bestellungen ein, die Positionen mit diesem Artikel beinhalten  
filter_status query (optional) die zu filternden Status (aus PurchaseOrderStatus) getrennt durch Komma  
filter_supplier query (optional) schränkt die Ausgabe auf Bestellungen ein, die für diesen Lieferantennamen ausgestellt wurden  
limit query (optional) die maximale Anzahl von Einträgen die ermittelt werden sollen int
startIndex query (optional) der StartIndex int
userid query userId ist der beim Logon ermittelte "token"  
Response Body
media type data type description
application/json PurchaseOrderEntryList (JSON) eine (leere) Liste von Bestellungen
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/purchaseorder/list
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "cnr" : "...",
    "supplierId" : 12345,
    "status" : "DELIVERED",
    "supplierEntry" : {
      "name1" : "...",
      "name2" : "...",
      "name3" : "...",
      "sign" : "...",
      "countryCode" : "...",
      "zipcode" : "...",
      "phone" : "...",
      "city" : "...",
      "addressType" : "...",
      "countryName" : "...",
      "street" : "...",
      "titlePrefix" : "...",
      "titlePostfix" : "...",
      "uid" : "...",
      "eori" : "...",
      "remark" : "...",
      "email" : "...",
      "website" : "...",
      "fax" : "...",
      "formattedCity" : "...",
      "formattedSalutation" : "...",
      "partnerId" : 12345,
      "contactEntries" : { },
      "id" : 12345
    },
    "supplierName" : "...",
    "supplierCity" : "...",
    "id" : 12345
  }, {
    "cnr" : "...",
    "supplierId" : 12345,
    "status" : "OPEN",
    "supplierEntry" : {
      "name1" : "...",
      "name2" : "...",
      "name3" : "...",
      "sign" : "...",
      "countryCode" : "...",
      "zipcode" : "...",
      "phone" : "...",
      "city" : "...",
      "addressType" : "...",
      "countryName" : "...",
      "street" : "...",
      "titlePrefix" : "...",
      "titlePostfix" : "...",
      "uid" : "...",
      "eori" : "...",
      "remark" : "...",
      "email" : "...",
      "website" : "...",
      "fax" : "...",
      "formattedCity" : "...",
      "formattedSalutation" : "...",
      "partnerId" : 12345,
      "contactEntries" : { },
      "id" : 12345
    },
    "supplierName" : "...",
    "supplierCity" : "...",
    "id" : 12345
  } ],
  "rowCount" : 12345
}

GET /api/v1/purchaseorder/proposal

Eine Liste aller Positionen eines Bestellvorschlags gemäß den Filterkriterien

Request Parameters
name type description constraints
filter_itemcnr query (optional) schränkt die Ausgabe auf diese zu filternde Artikelnummer ein  
filter_noted query (optional) wenn true werden nur als vorgemerkt markierte Positionen geliefert, wenn false nur alle nicht vorgemerkten Positionen boolean
limit query (optional) die maximale Anzahl von Einträgen die ermittelt werden sollen int
startIndex query (optional) der StartIndex int
userid query ist der beim Logon ermittelte "token"  
Response Body
media type data type description
application/json PurchaseOrderProposalPositionEntryList (JSON) eine (leere) Liste von Bestellvorschlagspositionen
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/purchaseorder/proposal
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "itemCnr" : "...",
    "amount" : 12345.0,
    "noted" : true,
    "deliveryDateMs" : 12345,
    "id" : 12345
  }, {
    "itemCnr" : "...",
    "amount" : 12345.0,
    "noted" : true,
    "deliveryDateMs" : 12345,
    "id" : 12345
  } ],
  "rowCount" : 12345
}

POST /api/v1/purchaseorder/proposalposition

Eine Position des Bestellvorschlags erstellen
Wenn diese Position vorgemerkt werden soll (über die Property CreatePurchaseOrderProposalPositionEntry.noted) dann darf es noch keine vorgemerkte Bestellvorschlagsposition des Artikels geben, für den eine neue Position erzeugt werden soll. Ist dies der Fall wird der Request mit einem EXPECTATION_FAILED (417) abgelehnt. Im Header X_HV_ADDITIONAL_ERROR_VALUE in dieser Response ist dabei die Id der bereits existenten Bestellvorschlagsposition enthalten.
Wird die Position nicht vorgemerkt, ist eine beliebige Anzahl an Positionen des jeweiligen Artikels erlaubt.

Request Parameters
name type description
userid query ist der beim Logon ermittelte "token"
Request Body
media type data type description
application/json CreatePurchaseOrderProposalPositionEntry (JSON) die neuen Bestellvorschlagpositionsdaten
application/xml;charset=UTF-8 object
Response Body
media type data type description
application/json CreatedPurchaseOrderProposalPositionEntry (JSON) die neu erzeugten Bestellvorschlagpositionsdaten
application/xml;charset=UTF-8 object

Example

Request
POST /api/v1/purchaseorder/proposalposition
Content-Type: application/json
Accept: application/json

                
{
  "itemId" : 12345,
  "itemCnr" : "...",
  "amount" : 12345.0,
  "noted" : true,
  "deliveryDateMs" : 12345
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "proposalPositionId" : 12345
}

DELETE /api/v1/purchaseorder/proposalposition/{proposalpositionid}

Eine bestehende Position des Bestellvorschlags löschen

Request Parameters
name type description constraints
proposalpositionid path Id der abzuändernden Position des Bestellvorschlags int
userid query ist der beim Logon ermittelte "token"  

Example

Request
DELETE /api/v1/purchaseorder/proposalposition/{proposalpositionid}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

GET /api/v1/purchaseorder/proposalposition/{proposalpositionid}

Liefert eine Position des Bestellvorschlags

Request Parameters
name type description constraints
proposalpositionid path Id der angefragten Position des Bestellvorschlags int
userid query ist der beim Logon ermittelte "token"  
Response Body
media type data type description
application/json PurchaseOrderProposalPositionEntry (JSON) Position des Bestellvorschlags
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/purchaseorder/proposalposition/{proposalpositionid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "itemCnr" : "...",
  "amount" : 12345.0,
  "noted" : true,
  "deliveryDateMs" : 12345,
  "id" : 12345
}

PUT /api/v1/purchaseorder/proposalposition/{proposalpositionid}

Eine bestehende Position des Bestellvorschlags abändern

Request Parameters
name type description constraints
proposalpositionid path Id der abzuändernden Position des Bestellvorschlags int
userid query ist der beim Logon ermittelte "token"  
Request Body
media type data type description
application/json UpdatePurchaseOrderProposalPositionEntry (JSON) die neuen Bestellvorschlagspositiondaten
application/xml;charset=UTF-8 object

Example

Request
PUT /api/v1/purchaseorder/proposalposition/{proposalpositionid}
Content-Type: application/json

                
{
  "amount" : 12345.0,
  "deliveryDateMs" : 12345
}
Response
HTTP/1.1 204 No Content

POST /api/v1/purchaseorder/goodsreceipt/{receiptid}/document

Legt Dateien in die Dokumentenablage eines Wareneingangs ab.

Die maximale Upload-Größe ist derzeit auf 6500KiB gestellt

Entweder headerToken oder userId muss angegeben werden. /

Request Parameters
name type description constraints
hvtoken header ist der (optionale) beim Logon ermittelte "token" im Header  
receiptid path Id des Wareneingangs int
grouping query ist die Gruppierung (optional, "Archiv", "Dokumente", "Gruppe-0", ... vom HELIUM V Anwender definierte Gruppen)  
keywords query sind die Schlagworte des Dokuments (optional)  
securitylevel query ist die Sicherheitsstufe (optional, 0 = keine, 1 = niedrig, 2 = mittel, 3 = hoch, 99 = Archiv) long
type query ist die Belegart (optional, "Auftragsbestätigung", "E-Mail", "kopiertes Dokument", ... vom HELIUM V Anwender definierte Belegarten)  
userid query ist der (optionale) beim Logon ermittelte "token"  
Request Body
media type data type description
application/json MultipartBody (JSON) ist der multipart/form-data des Requests, der den/die Dokumente enthält
application/xml multipartBody (XML)

Example

Request
POST /api/v1/purchaseorder/goodsreceipt/{receiptid}/document
Content-Type: application/json
hvtoken: ...

                
{
  "allAttachments" : [ {
    "contentDisposition" : {
      "type" : "...",
      "parameters" : {
        "property1" : "...",
        "property2" : "..."
      }
    },
    "object" : { },
    "contentType" : {
      "type" : "...",
      "wildcardSubtype" : true,
      "parameters" : {
        "property1" : "...",
        "property2" : "..."
      },
      "wildcardType" : true,
      "subtype" : "..."
    },
    "contentId" : "...",
    "dataHandler" : "...",
    "headers" : {
      "property1" : [ "...", "..." ],
      "property2" : [ "...", "..." ]
    }
  }, {
    "contentDisposition" : {
      "type" : "...",
      "parameters" : {
        "property1" : "...",
        "property2" : "..."
      }
    },
    "object" : { },
    "contentType" : {
      "type" : "...",
      "wildcardSubtype" : true,
      "parameters" : {
        "property1" : "...",
        "property2" : "..."
      },
      "wildcardType" : true,
      "subtype" : "..."
    },
    "contentId" : "...",
    "dataHandler" : "...",
    "headers" : {
      "property1" : [ "...", "..." ],
      "property2" : [ "...", "..." ]
    }
  } ],
  "type" : {
    "type" : "...",
    "wildcardSubtype" : true,
    "parameters" : {
      "property1" : "...",
      "property2" : "..."
    },
    "wildcardType" : true,
    "subtype" : "..."
  },
  "rootAttachment" : {
    "contentDisposition" : {
      "type" : "...",
      "parameters" : {
        "property1" : "...",
        "property2" : "..."
      }
    },
    "object" : { },
    "contentType" : {
      "type" : "...",
      "wildcardSubtype" : true,
      "parameters" : {
        "property1" : "...",
        "property2" : "..."
      },
      "wildcardType" : true,
      "subtype" : "..."
    },
    "contentId" : "...",
    "dataHandler" : "...",
    "headers" : {
      "property1" : [ "...", "..." ],
      "property2" : [ "...", "..." ]
    }
  },
  "childAttachments" : [ {
    "contentDisposition" : {
      "type" : "...",
      "parameters" : {
        "property1" : "...",
        "property2" : "..."
      }
    },
    "object" : { },
    "contentType" : {
      "type" : "...",
      "wildcardSubtype" : true,
      "parameters" : {
        "property1" : "...",
        "property2" : "..."
      },
      "wildcardType" : true,
      "subtype" : "..."
    },
    "contentId" : "...",
    "dataHandler" : "...",
    "headers" : {
      "property1" : [ "...", "..." ],
      "property2" : [ "...", "..." ]
    }
  }, {
    "contentDisposition" : {
      "type" : "...",
      "parameters" : {
        "property1" : "...",
        "property2" : "..."
      }
    },
    "object" : { },
    "contentType" : {
      "type" : "...",
      "wildcardSubtype" : true,
      "parameters" : {
        "property1" : "...",
        "property2" : "..."
      },
      "wildcardType" : true,
      "subtype" : "..."
    },
    "contentId" : "...",
    "dataHandler" : "...",
    "headers" : {
      "property1" : [ "...", "..." ],
      "property2" : [ "...", "..." ]
    }
  } ]
}
Response
HTTP/1.1 201 Created

GET /api/v1/purchaseorder/goodsreceipt/{receiptid}/position

Liefert die Liste aller Wareneingangspositionen

Request Parameters
name type description constraints
hvtoken header ist der (optionale) beim Logon ermittelte "token" im Header  
receiptid path ist die Id des Wareneingangs int
userid query ist der (optionale) beim Logon ermittelte "token"  
Response Body
media type data type description
application/json GoodsReceiptPositionEntryList (JSON) die Liste aller Wareneingangspositionen
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/purchaseorder/goodsreceipt/{receiptid}/position
Content-Type: */*
Accept: application/json
hvtoken: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "id" : 12345
  }, {
    "id" : 12345
  } ]
}

GET /api/v1/purchaseorder/goodsreceipt/{receiptid}/position/{positionid}/print

Das Wareneingangspositions-Etikett drucken

Wird keine Identity (Chargen- oder Seriennummer) angegeben, werden für alle Positionen des Wareneingangs die Etiketten gedruckt. Ansonsten nur für jene Positionen auf die die Idenity zutrifft.

Request Parameters
name type description constraints
hvtoken header ist der (optionale) beim Logon ermittelte "token" im Header  
positionid path ist die Id der Wareneingangsposition int
receiptid path ist die Id des Wareneingangs int
chargenr query ist die (optionale) Chargennummer für die das/die Etiketten gedruckt werden sollen.  
userid query ist der (optionale) beim Logon ermittelte "token"  
Response Body
media type data type description
application/json number (JSON) die WareneingangspositionId
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/purchaseorder/goodsreceipt/{receiptid}/position/{positionid}/print
Content-Type: */*
Accept: application/json
hvtoken: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...