GET api/v1/purchaseorder/{purchaseOrderNumber}

Search a purchase order by purchase order number

Request Information

URI Parameters

Name	Description	Type	Additional information
purchaseOrderNumber		integer	Required

Body Parameters

None.

Response Information

Resource Description

PurchaseOrderInformationV1

Name	Type	Additional information
IdentifierV1	PurchaseOrderIdentifierV1	None.
SupplierName	string	None.
AdditionalCostCurrency	string	None.
AdditionalCostText	string	None.
BelongsToOrdersString	string	None.
BuyingPriceTotal	decimal number	None.
ClosingDate	date	None.
CurrencyFactor	decimal number	None.
FooterText	string	None.
HeaderText	string	None.
IncomingDate	date	None.
InternOrderNotice	string	None.
IsCanceled	boolean	None.
IsComplete	boolean	None.
IsDirectDispatch	boolean	None.
IsStockOrder	boolean	None.
Notice	string	None.
OrderDate	date	None.
OwnOrderNumber	string	None.
SendingOutDate	date	None.
SupplierCreditorNumber	integer	None.
SupplierDate	date	None.
SupplierInvoiceNumber	string	None.
WishDeliveryDate	date	None.
CurrencyName	string	None.
DispatchType	LocalizedItem	None.
DeliveryTerm	LocalizedItem	None.
PaymentModes	Collection of PaymentInformationV1	None.
PurchaseOrderPositions	Collection of PurchaseOrderPositionItem	None.
PostAddress	ComplexAddressV1	None.
DispatchAddress	ComplexAddressV1	None.
SalesOrderNumbers	string	None.

Response Formats

application/json, text/json

Sample:

{
  "IdentifierV1": null,
  "SupplierName": "sample string 1",
  "AdditionalCostCurrency": "sample string 2",
  "AdditionalCostText": "sample string 3",
  "BelongsToOrdersString": "sample string 4",
  "BuyingPriceTotal": 5.0,
  "ClosingDate": "2024-04-28T04:52:44.2768501+00:00",
  "CurrencyFactor": 6.0,
  "FooterText": "sample string 7",
  "HeaderText": "sample string 8",
  "IncomingDate": "2024-04-28T04:52:44.2768501+00:00",
  "InternOrderNotice": "sample string 9",
  "IsCanceled": true,
  "IsComplete": true,
  "IsDirectDispatch": true,
  "IsStockOrder": true,
  "Notice": "sample string 14",
  "OrderDate": "2024-04-28T04:52:44.2768501+00:00",
  "OwnOrderNumber": "sample string 16",
  "SendingOutDate": "2024-04-28T04:52:44.2768501+00:00",
  "SupplierCreditorNumber": 17,
  "SupplierDate": "2024-04-28T04:52:44.2768501+00:00",
  "SupplierInvoiceNumber": "sample string 18",
  "WishDeliveryDate": "2024-04-28T04:52:44.2768501+00:00",
  "CurrencyName": "sample string 20",
  "DispatchType": {
    "Show": "sample string 1",
    "Description": "sample string 2",
    "Texts": [
      {
        "Show": "sample string 1",
        "Description": "sample string 2",
        "Language": "sample string 3"
      },
      {
        "Show": "sample string 1",
        "Description": "sample string 2",
        "Language": "sample string 3"
      }
    ]
  },
  "DeliveryTerm": {
    "Show": "sample string 1",
    "Description": "sample string 2",
    "Texts": [
      {
        "Show": "sample string 1",
        "Description": "sample string 2",
        "Language": "sample string 3"
      },
      {
        "Show": "sample string 1",
        "Description": "sample string 2",
        "Language": "sample string 3"
      }
    ]
  },
  "PaymentModes": [
    {
      "Show": "sample string 1",
      "Description": "sample string 2",
      "Days": 64,
      "Skonto": 64,
      "Deposit": 5.0,
      "Texts": [
        {
          "Show": "sample string 1",
          "Description": "sample string 2",
          "Language": "sample string 3"
        },
        {
          "Show": "sample string 1",
          "Description": "sample string 2",
          "Language": "sample string 3"
        }
      ]
    },
    {
      "Show": "sample string 1",
      "Description": "sample string 2",
      "Days": 64,
      "Skonto": 64,
      "Deposit": 5.0,
      "Texts": [
        {
          "Show": "sample string 1",
          "Description": "sample string 2",
          "Language": "sample string 3"
        },
        {
          "Show": "sample string 1",
          "Description": "sample string 2",
          "Language": "sample string 3"
        }
      ]
    }
  ],
  "PurchaseOrderPositions": [
    {
      "PurchaseOrderBetterments": [
        {
          "ArticleOrderNumber": "sample string 1",
          "ArticleName": "sample string 2",
          "ArticleDescription": "sample string 3",
          "ArticleOrderText": "sample string 4",
          "OrderedQuantityAmount": 5.0,
          "OrderedQuantityUnit": "sample string 6"
        },
        {
          "ArticleOrderNumber": "sample string 1",
          "ArticleName": "sample string 2",
          "ArticleDescription": "sample string 3",
          "ArticleOrderText": "sample string 4",
          "OrderedQuantityAmount": 5.0,
          "OrderedQuantityUnit": "sample string 6"
        }
      ],
      "PurchaseOrderPositionReasons": [
        {
          "IndentNumber": 1,
          "IndentCustomerName": "sample string 2",
          "IndentPositionIdentifier": "e35f19a9-a512-4496-87a2-d86dc13d0876",
          "IndentNumberFull": "sample string 3",
          "OrderedQuantityAmount": 4.0,
          "OrderedQuantityUnit": "sample string 5",
          "OrderedQuantityExtraAmount": 6.0,
          "OrderedQuantityExtraUnit": "sample string 7"
        },
        {
          "IndentNumber": 1,
          "IndentCustomerName": "sample string 2",
          "IndentPositionIdentifier": "e35f19a9-a512-4496-87a2-d86dc13d0876",
          "IndentNumberFull": "sample string 3",
          "OrderedQuantityAmount": 4.0,
          "OrderedQuantityUnit": "sample string 5",
          "OrderedQuantityExtraAmount": 6.0,
          "OrderedQuantityExtraUnit": "sample string 7"
        }
      ],
      "OrderedQuantity": 1.0,
      "OrderedQuantityAmount": 2.0,
      "OrderedQuantityUnit": "sample string 3",
      "ArticleOrderNumber": "sample string 4",
      "ArticleName": "sample string 5",
      "ColorName": "sample string 8",
      "SizeName": "sample string 9",
      "Option1Name": "sample string 8",
      "Option2Name": "sample string 9",
      "EarlyDeliveryDate": "2024-04-28T04:52:44.2768501+00:00",
      "LatestDeliveryDate": "2024-04-28T04:52:44.2768501+00:00",
      "BuyingPriceTotal": 12.0,
      "BuyingPricePosition": 13.0,
      "ArticleOrderText": "sample string 14"
    },
    {
      "PurchaseOrderBetterments": [
        {
          "ArticleOrderNumber": "sample string 1",
          "ArticleName": "sample string 2",
          "ArticleDescription": "sample string 3",
          "ArticleOrderText": "sample string 4",
          "OrderedQuantityAmount": 5.0,
          "OrderedQuantityUnit": "sample string 6"
        },
        {
          "ArticleOrderNumber": "sample string 1",
          "ArticleName": "sample string 2",
          "ArticleDescription": "sample string 3",
          "ArticleOrderText": "sample string 4",
          "OrderedQuantityAmount": 5.0,
          "OrderedQuantityUnit": "sample string 6"
        }
      ],
      "PurchaseOrderPositionReasons": [
        {
          "IndentNumber": 1,
          "IndentCustomerName": "sample string 2",
          "IndentPositionIdentifier": "e35f19a9-a512-4496-87a2-d86dc13d0876",
          "IndentNumberFull": "sample string 3",
          "OrderedQuantityAmount": 4.0,
          "OrderedQuantityUnit": "sample string 5",
          "OrderedQuantityExtraAmount": 6.0,
          "OrderedQuantityExtraUnit": "sample string 7"
        },
        {
          "IndentNumber": 1,
          "IndentCustomerName": "sample string 2",
          "IndentPositionIdentifier": "e35f19a9-a512-4496-87a2-d86dc13d0876",
          "IndentNumberFull": "sample string 3",
          "OrderedQuantityAmount": 4.0,
          "OrderedQuantityUnit": "sample string 5",
          "OrderedQuantityExtraAmount": 6.0,
          "OrderedQuantityExtraUnit": "sample string 7"
        }
      ],
      "OrderedQuantity": 1.0,
      "OrderedQuantityAmount": 2.0,
      "OrderedQuantityUnit": "sample string 3",
      "ArticleOrderNumber": "sample string 4",
      "ArticleName": "sample string 5",
      "ColorName": "sample string 8",
      "SizeName": "sample string 9",
      "Option1Name": "sample string 8",
      "Option2Name": "sample string 9",
      "EarlyDeliveryDate": "2024-04-28T04:52:44.2768501+00:00",
      "LatestDeliveryDate": "2024-04-28T04:52:44.2768501+00:00",
      "BuyingPriceTotal": 12.0,
      "BuyingPricePosition": 13.0,
      "ArticleOrderText": "sample string 14"
    }
  ],
  "PostAddress": {
    "Name": "sample string 1",
    "NameAffex": "sample string 2",
    "Street": "sample string 3",
    "Line1": "sample string 4",
    "Line2": "sample string 5",
    "Line3": "sample string 6",
    "PostCode": "sample string 7",
    "City": "sample string 8",
    "CountryName": "sample string 9",
    "CountryIso": "sample string 10",
    "AddressType": "sample string 11",
    "Salutation": "sample string 12",
    "FirstName": "sample string 13",
    "LastName": "sample string 14",
    "Mail": "sample string 15",
    "Gender": "sample string 16",
    "SalesTax": "sample string 17",
    "DeliveryNotice": "sample string 18"
  },
  "DispatchAddress": {
    "Name": "sample string 1",
    "NameAffex": "sample string 2",
    "Street": "sample string 3",
    "Line1": "sample string 4",
    "Line2": "sample string 5",
    "Line3": "sample string 6",
    "PostCode": "sample string 7",
    "City": "sample string 8",
    "CountryName": "sample string 9",
    "CountryIso": "sample string 10",
    "AddressType": "sample string 11",
    "Salutation": "sample string 12",
    "FirstName": "sample string 13",
    "LastName": "sample string 14",
    "Mail": "sample string 15",
    "Gender": "sample string 16",
    "SalesTax": "sample string 17",
    "DeliveryNotice": "sample string 18"
  },
  "SalesOrderNumbers": "sample string 21"
}

application/xml, text/xml

Sample:

<PurchaseOrderInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://promotionaloffice.promidata.com/2012/08/08">
  <AdditionalCostCurrency>sample string 2</AdditionalCostCurrency>
  <AdditionalCostText>sample string 3</AdditionalCostText>
  <BelongsToOrdersString>sample string 4</BelongsToOrdersString>
  <BuyingPriceTotal>5</BuyingPriceTotal>
  <ClosingDate>2024-04-28T04:52:44.2768501+00:00</ClosingDate>
  <CurrencyFactor>6</CurrencyFactor>
  <CurrencyName>sample string 20</CurrencyName>
  <DeliveryTerm>
    <Description>sample string 2</Description>
    <Show>sample string 1</Show>
    <Texts>
      <LocalizationItem>
        <Description>sample string 2</Description>
        <Language>sample string 3</Language>
        <Show>sample string 1</Show>
      </LocalizationItem>
      <LocalizationItem>
        <Description>sample string 2</Description>
        <Language>sample string 3</Language>
        <Show>sample string 1</Show>
      </LocalizationItem>
    </Texts>
  </DeliveryTerm>
  <DispatchAddress>
    <AddressType>sample string 11</AddressType>
    <City>sample string 8</City>
    <CountryIso>sample string 10</CountryIso>
    <CountryName>sample string 9</CountryName>
    <DeliveryNotice>sample string 18</DeliveryNotice>
    <FirstName>sample string 13</FirstName>
    <Gender>sample string 16</Gender>
    <LastName>sample string 14</LastName>
    <Line1>sample string 4</Line1>
    <Line2>sample string 5</Line2>
    <Line3>sample string 6</Line3>
    <Mail>sample string 15</Mail>
    <Name>sample string 1</Name>
    <NameAffex>sample string 2</NameAffex>
    <PostCode>sample string 7</PostCode>
    <SalesTax>sample string 17</SalesTax>
    <Salutation>sample string 12</Salutation>
    <Street>sample string 3</Street>
  </DispatchAddress>
  <DispatchType>
    <Description>sample string 2</Description>
    <Show>sample string 1</Show>
    <Texts>
      <LocalizationItem>
        <Description>sample string 2</Description>
        <Language>sample string 3</Language>
        <Show>sample string 1</Show>
      </LocalizationItem>
      <LocalizationItem>
        <Description>sample string 2</Description>
        <Language>sample string 3</Language>
        <Show>sample string 1</Show>
      </LocalizationItem>
    </Texts>
  </DispatchType>
  <FooterText>sample string 7</FooterText>
  <HeaderText>sample string 8</HeaderText>
  <IdentifierV1 i:nil="true" />
  <IncomingDate>2024-04-28T04:52:44.2768501+00:00</IncomingDate>
  <InternOrderNotice>sample string 9</InternOrderNotice>
  <IsCanceled>true</IsCanceled>
  <IsComplete>true</IsComplete>
  <IsDirectDispatch>true</IsDirectDispatch>
  <IsStockOrder>true</IsStockOrder>
  <Notice>sample string 14</Notice>
  <OrderDate>2024-04-28T04:52:44.2768501+00:00</OrderDate>
  <OwnOrderNumber>sample string 16</OwnOrderNumber>
  <PaymentModes>
    <PaymentInformation>
      <Days>64</Days>
      <Deposit>5</Deposit>
      <Description>sample string 2</Description>
      <Show>sample string 1</Show>
      <Skonto>64</Skonto>
      <Texts>
        <LocalizationItem>
          <Description>sample string 2</Description>
          <Language>sample string 3</Language>
          <Show>sample string 1</Show>
        </LocalizationItem>
        <LocalizationItem>
          <Description>sample string 2</Description>
          <Language>sample string 3</Language>
          <Show>sample string 1</Show>
        </LocalizationItem>
      </Texts>
    </PaymentInformation>
    <PaymentInformation>
      <Days>64</Days>
      <Deposit>5</Deposit>
      <Description>sample string 2</Description>
      <Show>sample string 1</Show>
      <Skonto>64</Skonto>
      <Texts>
        <LocalizationItem>
          <Description>sample string 2</Description>
          <Language>sample string 3</Language>
          <Show>sample string 1</Show>
        </LocalizationItem>
        <LocalizationItem>
          <Description>sample string 2</Description>
          <Language>sample string 3</Language>
          <Show>sample string 1</Show>
        </LocalizationItem>
      </Texts>
    </PaymentInformation>
  </PaymentModes>
  <PostAddress>
    <AddressType>sample string 11</AddressType>
    <City>sample string 8</City>
    <CountryIso>sample string 10</CountryIso>
    <CountryName>sample string 9</CountryName>
    <DeliveryNotice>sample string 18</DeliveryNotice>
    <FirstName>sample string 13</FirstName>
    <Gender>sample string 16</Gender>
    <LastName>sample string 14</LastName>
    <Line1>sample string 4</Line1>
    <Line2>sample string 5</Line2>
    <Line3>sample string 6</Line3>
    <Mail>sample string 15</Mail>
    <Name>sample string 1</Name>
    <NameAffex>sample string 2</NameAffex>
    <PostCode>sample string 7</PostCode>
    <SalesTax>sample string 17</SalesTax>
    <Salutation>sample string 12</Salutation>
    <Street>sample string 3</Street>
  </PostAddress>
  <PurchaseOrderPositions>
    <PurchaseOrderPositionItem>
      <ArticleName>sample string 5</ArticleName>
      <ArticleOrderNumber>sample string 4</ArticleOrderNumber>
      <ArticleOrderText>sample string 14</ArticleOrderText>
      <BuyingPricePosition>13</BuyingPricePosition>
      <BuyingPriceTotal>12</BuyingPriceTotal>
      <ColorName>sample string 8</ColorName>
      <EarlyDeliveryDate>2024-04-28T04:52:44.2768501+00:00</EarlyDeliveryDate>
      <LatestDeliveryDate>2024-04-28T04:52:44.2768501+00:00</LatestDeliveryDate>
      <Option1Name>sample string 8</Option1Name>
      <Option2Name>sample string 9</Option2Name>
      <OrderedQuantity>1</OrderedQuantity>
      <OrderedQuantityAmount>2</OrderedQuantityAmount>
      <OrderedQuantityUnit>sample string 3</OrderedQuantityUnit>
      <PurchaseOrderBetterments>
        <PurchaseOrderBettermentItem>
          <ArticleDescription>sample string 3</ArticleDescription>
          <ArticleName>sample string 2</ArticleName>
          <ArticleOrderNumber>sample string 1</ArticleOrderNumber>
          <ArticleOrderText>sample string 4</ArticleOrderText>
          <OrderedQuantityAmount>5</OrderedQuantityAmount>
          <OrderedQuantityUnit>sample string 6</OrderedQuantityUnit>
        </PurchaseOrderBettermentItem>
        <PurchaseOrderBettermentItem>
          <ArticleDescription>sample string 3</ArticleDescription>
          <ArticleName>sample string 2</ArticleName>
          <ArticleOrderNumber>sample string 1</ArticleOrderNumber>
          <ArticleOrderText>sample string 4</ArticleOrderText>
          <OrderedQuantityAmount>5</OrderedQuantityAmount>
          <OrderedQuantityUnit>sample string 6</OrderedQuantityUnit>
        </PurchaseOrderBettermentItem>
      </PurchaseOrderBetterments>
      <PurchaseOrderPositionReasons>
        <PurchaseOrderPositionReason>
          <IndentCustomerName>sample string 2</IndentCustomerName>
          <IndentNumber>1</IndentNumber>
          <IndentNumberFull>sample string 3</IndentNumberFull>
          <IndentPositionIdentifier>e35f19a9-a512-4496-87a2-d86dc13d0876</IndentPositionIdentifier>
          <OrderedQuantityAmount>4</OrderedQuantityAmount>
          <OrderedQuantityExtraAmount>6</OrderedQuantityExtraAmount>
          <OrderedQuantityExtraUnit>sample string 7</OrderedQuantityExtraUnit>
          <OrderedQuantityUnit>sample string 5</OrderedQuantityUnit>
        </PurchaseOrderPositionReason>
        <PurchaseOrderPositionReason>
          <IndentCustomerName>sample string 2</IndentCustomerName>
          <IndentNumber>1</IndentNumber>
          <IndentNumberFull>sample string 3</IndentNumberFull>
          <IndentPositionIdentifier>e35f19a9-a512-4496-87a2-d86dc13d0876</IndentPositionIdentifier>
          <OrderedQuantityAmount>4</OrderedQuantityAmount>
          <OrderedQuantityExtraAmount>6</OrderedQuantityExtraAmount>
          <OrderedQuantityExtraUnit>sample string 7</OrderedQuantityExtraUnit>
          <OrderedQuantityUnit>sample string 5</OrderedQuantityUnit>
        </PurchaseOrderPositionReason>
      </PurchaseOrderPositionReasons>
      <SizeName>sample string 9</SizeName>
    </PurchaseOrderPositionItem>
    <PurchaseOrderPositionItem>
      <ArticleName>sample string 5</ArticleName>
      <ArticleOrderNumber>sample string 4</ArticleOrderNumber>
      <ArticleOrderText>sample string 14</ArticleOrderText>
      <BuyingPricePosition>13</BuyingPricePosition>
      <BuyingPriceTotal>12</BuyingPriceTotal>
      <ColorName>sample string 8</ColorName>
      <EarlyDeliveryDate>2024-04-28T04:52:44.2768501+00:00</EarlyDeliveryDate>
      <LatestDeliveryDate>2024-04-28T04:52:44.2768501+00:00</LatestDeliveryDate>
      <Option1Name>sample string 8</Option1Name>
      <Option2Name>sample string 9</Option2Name>
      <OrderedQuantity>1</OrderedQuantity>
      <OrderedQuantityAmount>2</OrderedQuantityAmount>
      <OrderedQuantityUnit>sample string 3</OrderedQuantityUnit>
      <PurchaseOrderBetterments>
        <PurchaseOrderBettermentItem>
          <ArticleDescription>sample string 3</ArticleDescription>
          <ArticleName>sample string 2</ArticleName>
          <ArticleOrderNumber>sample string 1</ArticleOrderNumber>
          <ArticleOrderText>sample string 4</ArticleOrderText>
          <OrderedQuantityAmount>5</OrderedQuantityAmount>
          <OrderedQuantityUnit>sample string 6</OrderedQuantityUnit>
        </PurchaseOrderBettermentItem>
        <PurchaseOrderBettermentItem>
          <ArticleDescription>sample string 3</ArticleDescription>
          <ArticleName>sample string 2</ArticleName>
          <ArticleOrderNumber>sample string 1</ArticleOrderNumber>
          <ArticleOrderText>sample string 4</ArticleOrderText>
          <OrderedQuantityAmount>5</OrderedQuantityAmount>
          <OrderedQuantityUnit>sample string 6</OrderedQuantityUnit>
        </PurchaseOrderBettermentItem>
      </PurchaseOrderBetterments>
      <PurchaseOrderPositionReasons>
        <PurchaseOrderPositionReason>
          <IndentCustomerName>sample string 2</IndentCustomerName>
          <IndentNumber>1</IndentNumber>
          <IndentNumberFull>sample string 3</IndentNumberFull>
          <IndentPositionIdentifier>e35f19a9-a512-4496-87a2-d86dc13d0876</IndentPositionIdentifier>
          <OrderedQuantityAmount>4</OrderedQuantityAmount>
          <OrderedQuantityExtraAmount>6</OrderedQuantityExtraAmount>
          <OrderedQuantityExtraUnit>sample string 7</OrderedQuantityExtraUnit>
          <OrderedQuantityUnit>sample string 5</OrderedQuantityUnit>
        </PurchaseOrderPositionReason>
        <PurchaseOrderPositionReason>
          <IndentCustomerName>sample string 2</IndentCustomerName>
          <IndentNumber>1</IndentNumber>
          <IndentNumberFull>sample string 3</IndentNumberFull>
          <IndentPositionIdentifier>e35f19a9-a512-4496-87a2-d86dc13d0876</IndentPositionIdentifier>
          <OrderedQuantityAmount>4</OrderedQuantityAmount>
          <OrderedQuantityExtraAmount>6</OrderedQuantityExtraAmount>
          <OrderedQuantityExtraUnit>sample string 7</OrderedQuantityExtraUnit>
          <OrderedQuantityUnit>sample string 5</OrderedQuantityUnit>
        </PurchaseOrderPositionReason>
      </PurchaseOrderPositionReasons>
      <SizeName>sample string 9</SizeName>
    </PurchaseOrderPositionItem>
  </PurchaseOrderPositions>
  <SalesOrderNumbers>sample string 21</SalesOrderNumbers>
  <SendingOutDate>2024-04-28T04:52:44.2768501+00:00</SendingOutDate>
  <SupplierCreditorNumber>17</SupplierCreditorNumber>
  <SupplierDate>2024-04-28T04:52:44.2768501+00:00</SupplierDate>
  <SupplierInvoiceNumber>sample string 18</SupplierInvoiceNumber>
  <SupplierName>sample string 1</SupplierName>
  <WishDeliveryDate>2024-04-28T04:52:44.2768501+00:00</WishDeliveryDate>
</PurchaseOrderInformation>