GET api/Order/GetOrderProcessOverview?OrderYear={OrderYear}&OrderBook={OrderBook}&OrderNumber={OrderNumber}&IncludeProformaInvoices={IncludeProformaInvoices}&IncludeDispatches={IncludeDispatches}&IncludeInvoices={IncludeInvoices}&RequestType={RequestType}&Page={Page}&PageSize={PageSize}&RecordDtModifiedFrom={RecordDtModifiedFrom}

Request Information

URI Parameters

Name	Type	Additional information
OrderYear	integer	Required
OrderBook	string	Required
OrderNumber	integer	Required
IncludeProformaInvoices	boolean	None.
IncludeDispatches	boolean	None.
IncludeInvoices	boolean	None.
RequestType	sqRequestType	None.
Page	integer	None.
PageSize	integer	None.
RecordDtModifiedFrom	date	None.

Body Parameters

None.

Response Information

Resource Description

Collection of OrderProcessOverview

Name	Type	Additional information
OrderYear	integer	None.
OrderBook	string	None.
OrderNumber	integer	None.
OrderStatusDescription	string	None.
AttachmentID	string	None.
CancelledDate	date	None.
Order_ProformaInvoices	Order_ProformaInvoices	None.
Order_Dispatches	Order_Dispatches	None.
Order_Invoices	Order_Invoices	None.

Response Formats

application/xml, text/xml

Sample:

<ArrayOfOrderProcessOverview xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <OrderProcessOverview>
    <OrderYear>1</OrderYear>
    <OrderBook>sample string 2</OrderBook>
    <OrderNumber>3</OrderNumber>
    <OrderStatusDescription>sample string 4</OrderStatusDescription>
    <AttachmentID>sample string 5</AttachmentID>
    <CancelledDate>2024-05-01T06:48:53.5214601+02:00</CancelledDate>
    <Order_ProformaInvoices>
      <Order_ProformaInvoice>
        <ProformaInvoiceYear>1</ProformaInvoiceYear>
        <ProformaInvoiceBook>sample string 2</ProformaInvoiceBook>
        <ProformaInvoiceNumber>3</ProformaInvoiceNumber>
        <ProformaInvoiceStatusDescription>sample string 4</ProformaInvoiceStatusDescription>
        <AttachmentIDProformaInvoice>sample string 5</AttachmentIDProformaInvoice>
        <ProformaInvoicePaymentStatus>sample string 6</ProformaInvoicePaymentStatus>
      </Order_ProformaInvoice>
      <Order_ProformaInvoice>
        <ProformaInvoiceYear>1</ProformaInvoiceYear>
        <ProformaInvoiceBook>sample string 2</ProformaInvoiceBook>
        <ProformaInvoiceNumber>3</ProformaInvoiceNumber>
        <ProformaInvoiceStatusDescription>sample string 4</ProformaInvoiceStatusDescription>
        <AttachmentIDProformaInvoice>sample string 5</AttachmentIDProformaInvoice>
        <ProformaInvoicePaymentStatus>sample string 6</ProformaInvoicePaymentStatus>
      </Order_ProformaInvoice>
    </Order_ProformaInvoices>
    <Order_Dispatches>
      <Order_Dispatch>
        <DispatchYear>1</DispatchYear>
        <DispatchBook>sample string 2</DispatchBook>
        <DispatchNumber>3</DispatchNumber>
        <DispatchStatusDescription>sample string 4</DispatchStatusDescription>
        <AttachmentIDDispatch>sample string 5</AttachmentIDDispatch>
        <TrackingNumber>sample string 6</TrackingNumber>
      </Order_Dispatch>
      <Order_Dispatch>
        <DispatchYear>1</DispatchYear>
        <DispatchBook>sample string 2</DispatchBook>
        <DispatchNumber>3</DispatchNumber>
        <DispatchStatusDescription>sample string 4</DispatchStatusDescription>
        <AttachmentIDDispatch>sample string 5</AttachmentIDDispatch>
        <TrackingNumber>sample string 6</TrackingNumber>
      </Order_Dispatch>
    </Order_Dispatches>
    <Order_Invoices>
      <Order_Invoice>
        <InvoiceYear>1</InvoiceYear>
        <InvoiceBook>sample string 2</InvoiceBook>
        <InvoiceNumber>3</InvoiceNumber>
        <InvoiceStatusDescription>sample string 4</InvoiceStatusDescription>
        <AttachmentIDInvoice>sample string 5</AttachmentIDInvoice>
        <IDInvoiceNumber>sample string 6</IDInvoiceNumber>
      </Order_Invoice>
      <Order_Invoice>
        <InvoiceYear>1</InvoiceYear>
        <InvoiceBook>sample string 2</InvoiceBook>
        <InvoiceNumber>3</InvoiceNumber>
        <InvoiceStatusDescription>sample string 4</InvoiceStatusDescription>
        <AttachmentIDInvoice>sample string 5</AttachmentIDInvoice>
        <IDInvoiceNumber>sample string 6</IDInvoiceNumber>
      </Order_Invoice>
    </Order_Invoices>
  </OrderProcessOverview>
  <OrderProcessOverview>
    <OrderYear>1</OrderYear>
    <OrderBook>sample string 2</OrderBook>
    <OrderNumber>3</OrderNumber>
    <OrderStatusDescription>sample string 4</OrderStatusDescription>
    <AttachmentID>sample string 5</AttachmentID>
    <CancelledDate>2024-05-01T06:48:53.5214601+02:00</CancelledDate>
    <Order_ProformaInvoices>
      <Order_ProformaInvoice>
        <ProformaInvoiceYear>1</ProformaInvoiceYear>
        <ProformaInvoiceBook>sample string 2</ProformaInvoiceBook>
        <ProformaInvoiceNumber>3</ProformaInvoiceNumber>
        <ProformaInvoiceStatusDescription>sample string 4</ProformaInvoiceStatusDescription>
        <AttachmentIDProformaInvoice>sample string 5</AttachmentIDProformaInvoice>
        <ProformaInvoicePaymentStatus>sample string 6</ProformaInvoicePaymentStatus>
      </Order_ProformaInvoice>
      <Order_ProformaInvoice>
        <ProformaInvoiceYear>1</ProformaInvoiceYear>
        <ProformaInvoiceBook>sample string 2</ProformaInvoiceBook>
        <ProformaInvoiceNumber>3</ProformaInvoiceNumber>
        <ProformaInvoiceStatusDescription>sample string 4</ProformaInvoiceStatusDescription>
        <AttachmentIDProformaInvoice>sample string 5</AttachmentIDProformaInvoice>
        <ProformaInvoicePaymentStatus>sample string 6</ProformaInvoicePaymentStatus>
      </Order_ProformaInvoice>
    </Order_ProformaInvoices>
    <Order_Dispatches>
      <Order_Dispatch>
        <DispatchYear>1</DispatchYear>
        <DispatchBook>sample string 2</DispatchBook>
        <DispatchNumber>3</DispatchNumber>
        <DispatchStatusDescription>sample string 4</DispatchStatusDescription>
        <AttachmentIDDispatch>sample string 5</AttachmentIDDispatch>
        <TrackingNumber>sample string 6</TrackingNumber>
      </Order_Dispatch>
      <Order_Dispatch>
        <DispatchYear>1</DispatchYear>
        <DispatchBook>sample string 2</DispatchBook>
        <DispatchNumber>3</DispatchNumber>
        <DispatchStatusDescription>sample string 4</DispatchStatusDescription>
        <AttachmentIDDispatch>sample string 5</AttachmentIDDispatch>
        <TrackingNumber>sample string 6</TrackingNumber>
      </Order_Dispatch>
    </Order_Dispatches>
    <Order_Invoices>
      <Order_Invoice>
        <InvoiceYear>1</InvoiceYear>
        <InvoiceBook>sample string 2</InvoiceBook>
        <InvoiceNumber>3</InvoiceNumber>
        <InvoiceStatusDescription>sample string 4</InvoiceStatusDescription>
        <AttachmentIDInvoice>sample string 5</AttachmentIDInvoice>
        <IDInvoiceNumber>sample string 6</IDInvoiceNumber>
      </Order_Invoice>
      <Order_Invoice>
        <InvoiceYear>1</InvoiceYear>
        <InvoiceBook>sample string 2</InvoiceBook>
        <InvoiceNumber>3</InvoiceNumber>
        <InvoiceStatusDescription>sample string 4</InvoiceStatusDescription>
        <AttachmentIDInvoice>sample string 5</AttachmentIDInvoice>
        <IDInvoiceNumber>sample string 6</IDInvoiceNumber>
      </Order_Invoice>
    </Order_Invoices>
  </OrderProcessOverview>
</ArrayOfOrderProcessOverview>