OrderApi Resource

GET /api/v1/order

Eine Liste aller Aufträge liefern, die den Filterkriterien entsprechen

Request Parameters
name type description constraints
filter_cnr query die zu filternde Auftragsnummer  
filter_customer query der zu filternde Kundenname  
filter_myopen query boolean
filter_project query der zu filternde Projektname des Auftrags  
filter_representativeSign query sofern angegeben, das/die zu filternde Kurzzeichen des Vertreters. Es können mehrere Kurzzeichen angegeben werden, wenn diese durch , (Komma) voneinander getrennt werden. Beispiel: abc oder ab,cd  
filter_withHidden query mit true werden auch versteckte Aufträge geliefert boolean
limit query die maximale Anzahl von Einträgen die ermittelt werden sollen int
startIndex query der StartIndex int
userid query ist der beim Logon ermittelte "token"  
Response Body
media type data type description
application/json array of OrderEntry (JSON) eine (leere) List aller Aufträge, die den Filterkriterien entsprechen
application/xml;charset=UTF-8 object

Example

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

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

                
[ {
  "cnr" : "...",
  "orderType" : "...",
  "projectName" : "...",
  "orderState" : "...",
  "customerName" : "...",
  "customerAddress" : "...",
  "customerPartnerId" : 12345,
  "customerContactId" : 12345,
  "deliveryPartnerId" : 12345,
  "deliveryContactId" : 12345,
  "internalComment" : true,
  "externalComment" : true,
  "deliveryDateMs" : 12345,
  "internalCommentText" : "...",
  "externalCommentText" : "...",
  "customerId" : 12345,
  "customerIdInvoiceAddress" : 12345,
  "customerIdDeliveryAddress" : 12345,
  "representativeSign" : "...",
  "id" : 12345
} ]

GET /api/v1/order/comments

Die Auftragskommentare ermitteln

Einer der Parameter orderId oder orderCnr muss angegeben werden.

Request Parameters
name type description constraints
hvtoken header ist der beim Logon ermittelte Token  
addExternalComment query wenn true oder nicht angegeben wird der externe Kommentar ermittelt boolean
addInternalComment query wenn true oder nicht angegeben wird der interne Kommentar ermittelt boolean
orderCnr query ist die (optionale) Auftragsnummer  
orderid query ist die (optionale) Id des Auftrags int
userid query ist der beim Logon ermittelte "token"  
Response Body
media type data type description
application/json OrderComments (JSON)
application/xml;charset=UTF-8 object

Example

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

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

                
{
  "internalComment" : "...",
  "externalComment" : "...",
  "id" : 12345
}

GET /api/v1/order/deliverable

Ermittelt den "Lieferstatus" eines Auftrags

Request Parameters
name type description constraints
hvtoken header ist der beim Logon ermittelte Token  
orderCnr query ist die (optionale) Auftragsnummer.  
orderid query ist die (optionale) Id des Auftrags. Ist auch die orderCnr angegeben, hat die orderId Priorität int
userid query ist der beim Logon ermittelte "token"  
Response Body
media type data type description
application/json DeliverableOrderEntry (JSON) den Status eines lieferbaren Auftrags
application/xml;charset=UTF-8 object

Example

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

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

                
{
  "cnr" : "...",
  "deliverable" : true,
  "status" : "DONE",
  "deliveryEntries" : {
    "entries" : [ {
      "deliveryCnr" : "...",
      "status" : "CLEARED",
      "id" : 12345
    }, {
      "deliveryCnr" : "...",
      "status" : "CANCELLED",
      "id" : 12345
    } ]
  },
  "positionEntries" : {
    "entries" : [ {
      "itemCnr" : "...",
      "itemId" : 12345,
      "description" : "...",
      "amount" : 12345.0,
      "openAmount" : 12345.0,
      "unitCnr" : "...",
      "status" : "...",
      "itemProperty" : "NOIDENTIY",
      "itemIdentity" : { },
      "stockinfoEntry" : { },
      "id" : 12345
    }, {
      "itemCnr" : "...",
      "itemId" : 12345,
      "description" : "...",
      "amount" : 12345.0,
      "openAmount" : 12345.0,
      "unitCnr" : "...",
      "status" : "...",
      "itemProperty" : "NOIDENTIY",
      "itemIdentity" : { },
      "stockinfoEntry" : { },
      "id" : 12345
    } ]
  },
  "id" : 12345
}

GET /api/v1/order/offline

Liefert die Auftragsdaten für eine spätere Offline-Verarbeitung

Es werden sämtliche den Kritieren entsprechenden Aufträge geliefert. Zusätzlich die Positionen für dieser Aufträge und die unterschiedlichen Lieferadressen.

Request Parameters
name type description constraints
hvtoken header ist der beim Logon ermittelte Token. (optional)  
filter_cnr query die zu filternde Auftragsnummer  
filter_customer query der zu filternde Kundenname des Auftraggebers  
filter_delivery_customer query der zu filternde Kundename des Empfängers  
filter_project query der zu filternde Projektname des Auftrags  
filter_representativeSign query sofern angegeben, das/die zu filternde Kurzzeichen des Vertreters. Es können mehrere Kurzzeichen angegeben werden, wenn diese durch , (Komma) voneinander getrennt werden. Beispiel: abc oder ab,cd  
filter_withHidden query mit true werden auch versteckte Aufträge geliefert boolean
limit query die maximale Anzahl von zu liefernden Aufträgen int
startIndex query der Startindex der Aufträge int
userid query ist der beim Logon ermittelte "token"  
Response Body
media type data type description
application/json OfflineOrderEntry (JSON) eine Liste von OfflineOrderEntry
application/xml;charset=UTF-8 object

Example

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

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

                
{
  "orders" : [ {
    "cnr" : "...",
    "orderType" : "...",
    "projectName" : "...",
    "orderState" : "...",
    "customerName" : "...",
    "customerAddress" : "...",
    "customerPartnerId" : 12345,
    "customerContactId" : 12345,
    "deliveryPartnerId" : 12345,
    "deliveryContactId" : 12345,
    "internalComment" : true,
    "externalComment" : true,
    "deliveryDateMs" : 12345,
    "internalCommentText" : "...",
    "externalCommentText" : "...",
    "customerId" : 12345,
    "customerIdInvoiceAddress" : 12345,
    "customerIdDeliveryAddress" : 12345,
    "representativeSign" : "...",
    "id" : 12345
  }, {
    "cnr" : "...",
    "orderType" : "...",
    "projectName" : "...",
    "orderState" : "...",
    "customerName" : "...",
    "customerAddress" : "...",
    "customerPartnerId" : 12345,
    "customerContactId" : 12345,
    "deliveryPartnerId" : 12345,
    "deliveryContactId" : 12345,
    "internalComment" : true,
    "externalComment" : true,
    "deliveryDateMs" : 12345,
    "internalCommentText" : "...",
    "externalCommentText" : "...",
    "customerId" : 12345,
    "customerIdInvoiceAddress" : 12345,
    "customerIdDeliveryAddress" : 12345,
    "representativeSign" : "...",
    "id" : 12345
  } ],
  "orderpositions" : [ {
    "orderId" : 12345,
    "positionNr" : 12345,
    "amount" : 12345.0,
    "unitCnr" : "...",
    "itemCnr" : "...",
    "description" : "...",
    "price" : 12345.0,
    "status" : "...",
    "id" : 12345
  }, {
    "orderId" : 12345,
    "positionNr" : 12345,
    "amount" : 12345.0,
    "unitCnr" : "...",
    "itemCnr" : "...",
    "description" : "...",
    "price" : 12345.0,
    "status" : "...",
    "id" : 12345
  } ],
  "addresses" : [ {
    "partnerAddress" : {
      "partnerId" : 12345,
      "lines" : [ "...", "..." ],
      "salutation" : "...",
      "titel" : "...",
      "titelSuffix" : "...",
      "name1Lastname" : "...",
      "name2Firstname" : "...",
      "name3Department" : "...",
      "postofficeBox" : "...",
      "street" : "...",
      "countryCode" : "...",
      "zipcode" : "...",
      "city" : "...",
      "email" : "...",
      "phone" : "...",
      "id" : 12345
    },
    "contactAddress" : {
      "partnerId" : 12345,
      "lines" : [ "...", "..." ],
      "salutation" : "...",
      "titel" : "...",
      "titelSuffix" : "...",
      "name1Lastname" : "...",
      "name2Firstname" : "...",
      "name3Department" : "...",
      "postofficeBox" : "...",
      "street" : "...",
      "countryCode" : "...",
      "zipcode" : "...",
      "city" : "...",
      "email" : "...",
      "phone" : "...",
      "id" : 12345
    }
  }, {
    "partnerAddress" : {
      "partnerId" : 12345,
      "lines" : [ "...", "..." ],
      "salutation" : "...",
      "titel" : "...",
      "titelSuffix" : "...",
      "name1Lastname" : "...",
      "name2Firstname" : "...",
      "name3Department" : "...",
      "postofficeBox" : "...",
      "street" : "...",
      "countryCode" : "...",
      "zipcode" : "...",
      "city" : "...",
      "email" : "...",
      "phone" : "...",
      "id" : 12345
    },
    "contactAddress" : {
      "partnerId" : 12345,
      "lines" : [ "...", "..." ],
      "salutation" : "...",
      "titel" : "...",
      "titelSuffix" : "...",
      "name1Lastname" : "...",
      "name2Firstname" : "...",
      "name3Department" : "...",
      "postofficeBox" : "...",
      "street" : "...",
      "countryCode" : "...",
      "zipcode" : "...",
      "city" : "...",
      "email" : "...",
      "phone" : "...",
      "id" : 12345
    }
  } ]
}

GET /api/v1/order/position

Eine Liste aller Positionen die den Filterkriterien für Aufträge entsprechen ermitteln

Request Parameters
name type description constraints
filter_cnr query die zu filternde Auftragsnummer  
filter_customer query der zu filternde Kundenname  
filter_myopen query boolean
filter_project query der zu filternde Projektname des Auftrags  
filter_representativeSign query sofern angegeben, das/die zu filternde Kurzzeichen des Vertreters. Es können mehrere Kurzzeichen angegeben werden, wenn diese durch , (Komma) voneinander getrennt werden. Beispiel: abc oder ab,cd  
filter_withHidden query mit true werden auch versteckte Aufträge geliefert boolean
limit query die maximale Anzahl von zu liefernden Aufträgen int
startIndex query der Startindex der Aufträge int
userid query ist der beim Logon ermittelte "token"  
Response Body
media type data type description
application/json array of OrderpositionsEntry (JSON) eine Liste von OrderpositionsEntry
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/order/position
Content-Type: */*
Accept: application/json

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

                
[ {
  "orderId" : 12345,
  "positionNr" : 12345,
  "amount" : 12345.0,
  "unitCnr" : "...",
  "itemCnr" : "...",
  "description" : "...",
  "price" : 12345.0,
  "status" : "...",
  "id" : 12345
} ]

DELETE /api/v1/order/position/{positionid}

Die angegebene Auftragsposition löschen

Der Auftrag muss im Status ANGELEGT sein.

Request Parameters
name type description constraints
positionid path die zu entfernende AuftragspositionId int
userid query ist der beim Logon ermittelte "token"  

Example

Request
DELETE /api/v1/order/position/{positionid}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

POST /api/v1/order/{orderid}/activate

Einen Auftrag aktivieren

Der Auftrag wird vollständig durchgerechnet und der Status des Auftrags auf OFFEN gestellt, sofern dies möglich ist.

Der Auftrag muss im Status ANGELEGT sein. Es wird das AUFTRAG_CUD Recht benötigt.

Bitte stellen Sie sicher, dass der Auftrag alle jene Informationen enthält, die bei einem etwaigen Druck der Auftragsbestätigung notwendig sind. Zum Beispiel Preise in den Positionen, Steuersätze, Konditionen usw.

Beim Aktivieren wird eine Belegprüfung durchgeführt. Je nach gesetzten Parametern kann es verschiedenen Situation geben (Nullpreise in der Position erlaubt, steuerlose Positionen obwohl Steuer erwartet wird, steuerbehaftete Position obwohl steuerlose Positionen erwartet werden, ...) die zum Abbruch der Aktivierung führen, oder Einträge im OrderActivationEntry hinterlassen.

Request Parameters
name type description constraints
orderid path ist die Id des zu aktivierenden Auftrags int
userid query ist der beim Logon ermittelte "token"  
verified query muss true sein um die Funktion ausführen zu können boolean
Response Body
media type data type description
application/json OrderActivationEntry (JSON) Informationen zur Belegprüfung
application/json OrderActivationEntry (JSON)
application/xml;charset=UTF-8 object

Example

Request
POST /api/v1/order/{orderid}/activate
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "calculationTimestampMs" : 12345,
  "customerExpectsVATorderHasNoneVATpositions" : true,
  "customerHasNoVATorderHasVATpositions" : true,
  "id" : 12345
}

POST /api/v1/order/{orderid}/document

Legt Dateien in die Dokumentenablage eines Auftrags ab.

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

Request Parameters
name type description constraints
orderid path Id des Auftrags int
grouping query ist die Gruppierung (optional)  
keywords query sind die Schlagworte des Dokuments (optional)  
securitylevel query ist die Sicherheitsstufe (optional) long
type query ist die Belegart (optional)  
userid query ist der 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/order/{orderid}/document
Content-Type: application/json

                
{
  "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

POST /api/v1/order/{orderid}/itemposition

Eine Artikel-Position zu einem Auftrag hinzufügen

Der Auftrag muss im Status ANGELEGT sein.

Request Parameters
name type description constraints
orderid path ist die Id des Auftrags int
userid query ist der beim Logon ermittelte "token"  
Request Body
media type data type description
application/json CreateOrderItemPositionEntry (JSON) die hinzuzufügenden Identposition
application/json CreateOrderItemPositionEntry (JSON)
application/xml;charset=UTF-8 object
Response Body
media type data type description
application/json CreatedOrderPositionEntry (JSON) die neu erzeugte Auftragsposition
application/xml;charset=UTF-8 object

Example

Request
POST /api/v1/order/{orderid}/itemposition
Content-Type: application/json
Accept: application/json

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

                
{
  "orderId" : 12345,
  "orderCnr" : "...",
  "orderPositionId" : 12345,
  "amount" : 12345.0
}

POST /api/v1/order/{orderid}/manualitemposition

Eine Handeingabe-Position zu einem Auftrag hinzufügen

Der Auftrag muss im Status ANGELEGT sein.

Request Parameters
name type description constraints
orderid path ist die Id des Auftrags int
userid query ist der beim Logon ermittelte "token"  
Request Body
media type data type description
application/json CreateOrderManualItemPositionEntry (JSON) die hinzuzufügenden Handeingabeposition
application/json CreateOrderManualItemPositionEntry (JSON)
application/xml;charset=UTF-8 object
Response Body
media type data type description
application/json CreatedOrderPositionEntry (JSON) die neu erzeugte Auftragsposition
application/xml;charset=UTF-8 object

Example

Request
POST /api/v1/order/{orderid}/manualitemposition
Content-Type: application/json
Accept: application/json

                
{
  "description" : "...",
  "description2" : "...",
  "unitCnr" : "...",
  "amount" : 12345.0,
  "nettoPrice" : 12345.0,
  "costBearingUnitId" : 12345,
  "taxDescriptionId" : 12345
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "orderId" : 12345,
  "orderCnr" : "...",
  "orderPositionId" : 12345,
  "amount" : 12345.0
}

GET /api/v1/order/{orderid}/position

Die Liste der Positionen für den angegeben Auftrag ermitteln

Request Parameters
name type description constraints
orderid path ist die Auftrag-Id für die die Positionen ermittelt werden sollen int
limit query ist die maximale Anzahl von zu liefernden Positionsdaten. Default 50 int
startIndex query ist der Index ab dem die Positionen geliefert werden sollen int
userid query ist der beim Logon ermittelte "token"  
Response Body
media type data type description
application/json array of OrderpositionEntry (JSON)
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/order/{orderid}/position
Content-Type: */*
Accept: application/json

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

                
[ {
  "positionNr" : 12345,
  "amount" : 12345.0,
  "unitCnr" : "...",
  "itemCnr" : "...",
  "description" : "...",
  "price" : 12345.0,
  "status" : "...",
  "id" : 12345
} ]

GET /api/v1/order/{orderid}/settlementofhours

Request Parameters
name type description constraints
orderid path int
userid query  
Response Body
media type data type description
application/json SettlementOfHoursEntry (JSON)
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/order/{orderid}/settlementofhours
Content-Type: */*
Accept: application/json

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

                
{
  "name" : "...",
  "mimeType" : "...",
  "content" : "...",
  "description" : "...",
  "lastPagePng" : "...",
  "serialNumber" : 12345,
  "id" : 12345
}

POST /api/v1/order/{orderid}/settlementofhours

Request Body
media type data type
application/json SettlementOfHoursSignatureEntry (JSON)
application/json SettlementOfHoursSignatureEntry (JSON)
application/xml;charset=UTF-8 object

Example

Request
POST /api/v1/order/{orderid}/settlementofhours
Content-Type: application/json

                
{
  "userId" : "...",
  "remark" : "...",
  "pdfContent" : "...",
  "signatureContent" : "...",
  "signatureMs" : 12345,
  "orderId" : 12345,
  "signatureType" : "...",
  "serialNumber" : 12345,
  "signerName" : "...",
  "id" : 12345
}
Response
HTTP/1.1 201 Created

POST /api/v1/order/{orderid}/sortbyitemnumber

Die Positionen eines Auftrags aufsteigend nach Artikelnummer sortieren

Der Auftrag muss im Status ANGELEGT sein.

Request Parameters
name type description constraints
orderid path ist die Id des zu sortierenden Auftrags int
userid query ist der beim Logon ermittelte "token"  
Response Body
media type data type description
application/json OrderSortedEntry (JSON) Information zur Sortierung
application/json OrderSortedEntry (JSON)
application/xml;charset=UTF-8 object

Example

Request
POST /api/v1/order/{orderid}/sortbyitemnumber
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "sorted" : true,
  "id" : 12345
}

POST /api/v1/order/{orderid}/textblock

Eine Textbaustein-Position zu einem Auftrag hinzufügen

Der Auftrag muss im Status ANGELEGT sein.

Es können auch Textbausteine verwendet werden, die Bilder enthalten

Bei auf Texten basierende Textbausteinen kann die localeCnr angegeben werden. Wird sie nicht angegeben, wird der Textbaustein mit der Locale des angemeldeten Benutzers verwendet. Der Textbaustein muss in dieser Locale existieren.

Request Parameters
name type description constraints
orderid path ist die Id des Auftrags int
userid query ist der beim Logon ermittelte "token"  
Request Body
media type data type description
application/json CreateOrderTextblockPositionEntry (JSON) die hinzuzufügenden Textbausteinposition
application/json CreateOrderTextblockPositionEntry (JSON)
application/xml;charset=UTF-8 object
Response Body
media type data type description
application/json CreatedOrderPositionEntry (JSON) die neu erzeugte Auftragsposition
application/xml;charset=UTF-8 object

Example

Request
POST /api/v1/order/{orderid}/textblock
Content-Type: application/json
Accept: application/json

                
{
  "textblockId" : 12345,
  "textblockCnr" : "...",
  "localeCnr" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "orderId" : 12345,
  "orderCnr" : "...",
  "orderPositionId" : 12345,
  "amount" : 12345.0
}

POST /api/v1/order/{orderid}/textposition

Eine Texteingabe-Position zu einem Auftrag hinzufügen

Der Auftrag muss im Status ANGELEGT sein.

Request Parameters
name type description constraints
orderid path ist die Id des Auftrags int
userid query ist der beim Logon ermittelte "token"  
Request Body
media type data type description
application/json CreateOrderTextPositionEntry (JSON) die hinzuzufügenden Textposition
application/json CreateOrderTextPositionEntry (JSON)
application/xml;charset=UTF-8 object
Response Body
media type data type description
application/json CreatedOrderPositionEntry (JSON) die neu erzeugte Auftragsposition
application/xml;charset=UTF-8 object

Example

Request
POST /api/v1/order/{orderid}/textposition
Content-Type: application/json
Accept: application/json

                
{
  "text" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "orderId" : 12345,
  "orderCnr" : "...",
  "orderPositionId" : 12345,
  "amount" : 12345.0
}

PUT /api/v1/order/{orderid}/itemposition/{positionid}

Ändert die angegebene Auftragsposition auf eine Identposition

Der Auftrag muss im Status ANGELEGT sein.

Unterscheiden sich die Positionsarten der bereits bestehenden Position und der abzuändernden, so wird prinzipiell eine neue Position angelegt.

Auch wenn es sich bei der bestehenden Position um eine Artikelposition handelt, kann nicht davon ausgegangen werden, dass die Id der neuen Position die gleiche bleibt. Wird mit der Id der Position weitergearbeitet, ist die im Response enthaltende orderPositionId zu verwenden.

Request Parameters
name type description constraints
orderid path ist die Id des Auftrags int
positionid path ist die abzuändernde Auftragsposition int
userid query ist der beim Logon ermittelte "token"  
Request Body
media type data type description
application/json CreateOrderItemPositionEntry (JSON) die neue/abgeänderte Identposition
application/json CreateOrderItemPositionEntry (JSON)
application/xml;charset=UTF-8 object
Response Body
media type data type description
application/json CreatedOrderPositionEntry (JSON) die geänderte Auftragsposition
application/xml;charset=UTF-8 object

Example

Request
PUT /api/v1/order/{orderid}/itemposition/{positionid}
Content-Type: application/json
Accept: application/json

                
{
  "itemId" : 12345,
  "amount" : 12345.0,
  "itemCnr" : "...",
  "costBearingUnitId" : 12345
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "orderId" : 12345,
  "orderCnr" : "...",
  "orderPositionId" : 12345,
  "amount" : 12345.0
}

PUT /api/v1/order/{orderid}/manualitemposition/{positionid}

Ändert die angegebene Auftragsposition auf eine Handeingabeposition

Der Auftrag muss im Status ANGELEGT sein.

Unterscheiden sich die Positionsarten der bereits bestehenden Position und der abzuändernden, so wird prinzipiell eine neue Position angelegt.

Auch wenn es sich bei der bestehenden Position um eine Handeingabeposition handelt, kann nicht davon ausgegangen werden, dass die Id der neuen Position die gleiche bleibt. Wird mit der Id der Position weitergearbeitet, ist die im Response enthaltende orderPositionId zu verwenden.

Request Parameters
name type description constraints
orderid path ist die Id des Auftrags int
positionid path ist die abzuändernde Auftragsposition int
userid query ist der beim Logon ermittelte "token"  
Request Body
media type data type description
application/json CreateOrderManualItemPositionEntry (JSON) die neue/abgeänderte Handeingabeposition
application/json CreateOrderManualItemPositionEntry (JSON)
application/xml;charset=UTF-8 object
Response Body
media type data type description
application/json CreatedOrderPositionEntry (JSON) die geänderte Auftragsposition
application/xml;charset=UTF-8 object

Example

Request
PUT /api/v1/order/{orderid}/manualitemposition/{positionid}
Content-Type: application/json
Accept: application/json

                
{
  "description" : "...",
  "description2" : "...",
  "unitCnr" : "...",
  "amount" : 12345.0,
  "nettoPrice" : 12345.0,
  "costBearingUnitId" : 12345,
  "taxDescriptionId" : 12345
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "orderId" : 12345,
  "orderCnr" : "...",
  "orderPositionId" : 12345,
  "amount" : 12345.0
}