POST api/Documents/Orders

Request Information

URI Parameters

None.

Body Parameters

OrderDocument
NameDescriptionTypeAdditional information
LotDescription

string

None.

LotReference

string

None.

ContractType

integer

None.

AwardedOrg

ExternOrgDTO

None.

MaxOrderAmount

decimal number

None.

StartDate

date

None.

EndDate

date

None.

NotificationDate

date

None.

OrderDescription

string

None.

Department

string

None.

UserName

string

None.

DeadlineDate

date

None.

Locations

Collection of LocationDTO

None.

OrderLines

Collection of OrderLine

None.

TotalExcl

decimal number

None.

TotalVat

decimal number

None.

TotalIncl

decimal number

None.

NbDecimals

integer

None.

ExtraColsCandidates

string

None.

ExtraColsContractingAuth

string

None.

InnerTemplateFileName

string

None.

LangCode

string

None.

CountryCode

string

None.

User

UserWithDepartment

None.

Request Formats

application/json, text/json

Sample:
{
  "LotDescription": "sample string 1",
  "LotReference": "sample string 2",
  "ContractType": 3,
  "AwardedOrg": {
    "VATNr": "sample string 1",
    "City": "sample string 2",
    "StreetName": "sample string 3",
    "HouseNumber": "sample string 4",
    "Zip": "sample string 5",
    "Country": "sample string 6",
    "latitude": 1.1,
    "longitude": 1.1,
    "X": 1.1,
    "Y": 1.1,
    "Id": "b856ee1b-8abd-4551-8e66-14ff6ab36e91",
    "Description": "sample string 8",
    "CrmId": 9,
    "IsArchived": true
  },
  "MaxOrderAmount": 4.0,
  "StartDate": "2017-10-16T22:10:48.6342932+00:00",
  "EndDate": "2017-10-16T22:10:48.6342932+00:00",
  "NotificationDate": "2017-10-16T22:10:48.6342932+00:00",
  "OrderDescription": "sample string 5",
  "Department": "sample string 6",
  "UserName": "sample string 7",
  "DeadlineDate": "2017-10-16T22:10:48.6342932+00:00",
  "Locations": [
    {
      "City": "sample string 1",
      "StreetName": "sample string 2",
      "HouseNumber": "sample string 3",
      "Zip": "sample string 4",
      "Country": "sample string 5",
      "latitude": 1.1,
      "longitude": 1.1,
      "X": 1.1,
      "Y": 1.1,
      "Id": "202baaa9-813b-4977-8673-a83a61b40e92",
      "Description": "sample string 7",
      "CrmId": 8,
      "IsArchived": true
    },
    {
      "City": "sample string 1",
      "StreetName": "sample string 2",
      "HouseNumber": "sample string 3",
      "Zip": "sample string 4",
      "Country": "sample string 5",
      "latitude": 1.1,
      "longitude": 1.1,
      "X": 1.1,
      "Y": 1.1,
      "Id": "202baaa9-813b-4977-8673-a83a61b40e92",
      "Description": "sample string 7",
      "CrmId": 8,
      "IsArchived": true
    }
  ],
  "OrderLines": [
    {
      "post": {
        "Reference": "sample string 1",
        "PostNr": 2,
        "PosNr": 3,
        "VATPercentage": 4.1,
        "UnitPrice": 5.0,
        "UOM": "sample string 6",
        "ExtraColsCandidates": "sample string 7",
        "ExtraColsContractingAuth": "sample string 8",
        "QuantityType": 1,
        "Id": "a68c36e2-1263-457a-aedb-9a5b9311cb4f",
        "Description": "sample string 10",
        "CrmId": 11,
        "IsArchived": true
      },
      "partPost": {
        "AwQuantity": 1.0,
        "PostID": "c34a3c72-4dd5-456c-ab0e-f10a60e64a9f",
        "Id": "cd6ff630-f239-478c-ba34-2c3bf97cbf71",
        "Description": "sample string 4",
        "CrmId": 5,
        "IsArchived": true
      },
      "orderPost": {
        "Quantity": 1.0,
        "PostID": "2eefa79b-3216-45d2-8a9f-23585a401013",
        "Id": "60698887-0239-408f-bd58-1aa0d57b7d3b",
        "Description": "sample string 4",
        "CrmId": 5,
        "IsArchived": true
      },
      "qtyOthers": 1.0,
      "price": 5.0
    },
    {
      "post": {
        "Reference": "sample string 1",
        "PostNr": 2,
        "PosNr": 3,
        "VATPercentage": 4.1,
        "UnitPrice": 5.0,
        "UOM": "sample string 6",
        "ExtraColsCandidates": "sample string 7",
        "ExtraColsContractingAuth": "sample string 8",
        "QuantityType": 1,
        "Id": "a68c36e2-1263-457a-aedb-9a5b9311cb4f",
        "Description": "sample string 10",
        "CrmId": 11,
        "IsArchived": true
      },
      "partPost": {
        "AwQuantity": 1.0,
        "PostID": "c34a3c72-4dd5-456c-ab0e-f10a60e64a9f",
        "Id": "cd6ff630-f239-478c-ba34-2c3bf97cbf71",
        "Description": "sample string 4",
        "CrmId": 5,
        "IsArchived": true
      },
      "orderPost": {
        "Quantity": 1.0,
        "PostID": "2eefa79b-3216-45d2-8a9f-23585a401013",
        "Id": "60698887-0239-408f-bd58-1aa0d57b7d3b",
        "Description": "sample string 4",
        "CrmId": 5,
        "IsArchived": true
      },
      "qtyOthers": 1.0,
      "price": 5.0
    }
  ],
  "TotalExcl": 8.0,
  "TotalVat": 9.0,
  "TotalIncl": 10.0,
  "NbDecimals": 11,
  "ExtraColsCandidates": "sample string 12",
  "ExtraColsContractingAuth": "sample string 13",
  "InnerTemplateFileName": "3p_orders_sample string 14.doc",
  "LangCode": "sample string 14",
  "CountryCode": "sample string 15",
  "User": {
    "DepartmentName": "sample string 1",
    "FullNameWDep": "sample string 3 sample string 4 (sample string 1)",
    "Id": "sample string 2",
    "Country": "BE",
    "Language": "NL",
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "FullName": "sample string 3 sample string 4",
    "Email": "sample string 5",
    "DepartmentID": "20db8528-521f-44ec-89a0-62041303f9c6",
    "CrmId": 6,
    "CrmUserId": 7,
    "Is3PUser": true,
    "IsWorkman": true,
    "IsExtern": true,
    "Roles": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DocumentCreationInfo
NameDescriptionTypeAdditional information
Url

string

None.

Id

globally unique identifier

None.

Description

string

None.

CrmId

integer

None.

IsArchived

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Url": "sample string 1",
  "Id": "7a697bab-ce91-4bce-ac9b-01ff7ae9b360",
  "Description": "sample string 3",
  "CrmId": 4,
  "IsArchived": true
}