Purchase Order Module

PurchaseOrders

GET purchaseorders

Returns a list of ALL Purchase Orders. Can be filtered with an OData style query string.

GET purchaseorders/{purchaseOrderPK}

Returns the Purchase Order with the specified PK value.

Parameters
  • purchaseOrderPK (FromUri): The PK value of the requested Purchase Order.

POST purchaseorders

Creates one or more Purchase Orders in the system with the details specified in the request body. Required: VendorRef

Parameters
  • newPurchaseOrders (FromBody): An Array of Purchase Orders to be created.

PUT purchaseorders/{purchaseOrderPK}

Updates the specified Purchase Order with the details specified in the request body.

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order to be updated.
  • updatedViewModel (FromBody): Updated details of the Purchase Order.

PUT purchaseorders

Updates one or more Purchase Orders in the system with the details specified in the request body.

Parameters
  • updViews (FromBody): A collection of Purchase Orders to be updated.

PurchaseOrderStatusUpdates

GET PurchaseOrders/{purchaseOrderPK}/StatusUpdates

Returns the Status Updates for a specific Purchase Order.

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.

PurchaseOrderLineItems

GET PurchaseOrderLineItems

Returns a list of ALL Purchase Order Line Items. Can be filtered with an OData style query string.

GET PurchaseOrderLineItems/{lineItemPK}?purchaseOrderPK={purchaseOrderPK}

Returns the Line Item with the specified PK value.

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.
  • lineItemPK (FromUri): The PK value of the requested Line Item.

GET PurchaseOrderLineItems?purchaseOrderPK={purchaseOrderPK}

Returns the Line Items for a specific Purchase Order.

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.

POST PurchaseOrderLineItems?purchaseOrderPK={purchaseOrderPK}

Creates one or more Purchase Order Line Items in the system with the details specified in the request body. Required: PurchaserOrderPK, LineItemNo, PartRef

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.
  • newLineItems (FromBody): An Array of Purchase Order Line Items to be created.

PUT PurchaseOrderLineItems/{lineItemPK}?purchaseOrderPK={purchaseOrderPK}

Updates the specified Line Item with the details specified in the request body. Required: PurchaseOrderPK

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.
  • lineItemPK (FromUri): The PK value of the Line Item to be updated.
  • updatedViewModel (FromBody): Updated details of the Line Item.

PUT PurchaseOrderLineItems

Updates one or more Purchase Order Lineitems in the system with the details specified in the request body.

Parameters
  • updViews (FromBody): A collection of Purchase Order Lineitems to be updated.

GET PurchaseOrders/{purchaseOrderPK}/LineItems/{lineItemPK}

Returns the Line Item with the specified PK value.

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.
  • lineItemPK (FromUri): The PK value of the requested Line Item.

GET PurchaseOrders/{purchaseOrderPK}/LineItems

Returns the Line Items for a specific Purchase Order.

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.

POST PurchaseOrders/{purchaseOrderPK}/LineItems

Creates one or more Purchase Order Line Items in the system with the details specified in the request body. Required: PurchaserOrderPK, LineItemNo, PartRef

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.
  • newLineItems (FromBody): An Array of Purchase Order Line Items to be created.

PUT PurchaseOrders/{purchaseOrderPK}/LineItems/{lineItemPK}

Updates the specified Line Item with the details specified in the request body. Required: PurchaseOrderPK

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.
  • lineItemPK (FromUri): The PK value of the Line Item to be updated.
  • updatedViewModel (FromBody): Updated details of the Line Item.

Invoices

GET Invoices

Returns a list of ALL Invoices. Can be filtered with an OData style query string.

GET Invoices/{invoicePK}?purchaseOrderPK={purchaseOrderPK}

Returns the Invoice with the specified PK value.

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.
  • invoicePK (FromUri): The PK value of the requested Invoice.

GET Invoices?purchaseOrderPK={purchaseOrderPK}

Returns the Invoices for a specific Purchase Order.

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.

POST Invoices?purchaseOrderPK={purchaseOrderPK}

Creates one or more Purchase Order Invoices in the system with the details specified in the request body. Required: PurchaseOrderPK

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.
  • newInvoices (FromBody): An Array of Purchase Order Invoices to be created.

PUT Invoices/{invoicePK}?purchaseOrderPK={purchaseOrderPK}

Updates the specified Invoice with the details specified in the request body. Required: PurchaseOrderPK

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.
  • invoicePK (FromUri): The PK value of the Invoice to be updated.
  • updatedViewModel (FromBody): Updated details of the Invoice.

PUT Invoices

Updates one or more Invoices in the system with the details specified in the request body.

Parameters
  • updViews (FromBody): A collection of Invoices to be updated.

GET PurchaseOrders/{purchaseOrderPK}/Invoices/{invoicePK}

Returns the Invoice with the specified PK value.

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.
  • invoicePK (FromUri): The PK value of the requested Invoice.

GET PurchaseOrders/{purchaseOrderPK}/Invoices

Returns the Invoices for a specific Purchase Order.

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.

POST PurchaseOrders/{purchaseOrderPK}/Invoices

Creates one or more Purchase Order Invoices in the system with the details specified in the request body. Required: PurchaseOrderPK

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.
  • newInvoices (FromBody): An Array of Purchase Order Invoices to be created.

PUT PurchaseOrders/{purchaseOrderPK}/Invoices/{invoicePK}

Updates the specified Invoice with the details specified in the request body. Required: PurchaseOrderPK

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.
  • invoicePK (FromUri): The PK value of the Invoice to be updated.
  • updatedViewModel (FromBody): Updated details of the Invoice.

Receipts

GET Receipts

Returns a list of ALL Receipts. Can be filtered with an OData style query string.

GET Receipts/{receiptPK}?purchaseOrderPK={purchaseOrderPK}

Returns the Receipt with the specified PK value.

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.
  • receiptPK (FromUri): The PK value of the requested Receipt.

GET Receipts?purchaseOrderPK={purchaseOrderPK}

Returns the Receipts for a specific Purchase Order.

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.

POST Receipts?purchaseOrderPK={purchaseOrderPK}

Creates one or more Purchase Order Receipts in the system with the details specified in the request body. Required: PurchaseOrderPK

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.
  • newReceipts (FromBody): An Array of Purchase Order Receipts to be created.

PUT Receipts/{receiptPK}?purchaseOrderPK={purchaseOrderPK}

Updates the specified Receipt with the details specified in the request body. Required: PurchaseOrderPK

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.
  • receiptPK (FromUri): The PK value of the Receipt to be updated.
  • updatedViewModel (FromBody): Updated details of the Receipt.

PUT Receipts

Updates one or more Receipts in the system with the details specified in the request body.

Parameters
  • updViews (FromBody): A collection of Receipts to be updated.

GET PurchaseOrders/{purchaseOrderPK}/Receipts/{receiptPK}

Returns the Receipt with the specified PK value.

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.
  • receiptPK (FromUri): The PK value of the requested Receipt.

GET PurchaseOrders/{purchaseOrderPK}/Receipts

Returns the Receipts for a specific Purchase Order.

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.

POST PurchaseOrders/{purchaseOrderPK}/Receipts

Creates one or more Purchase Order Receipts in the system with the details specified in the request body. Required: PurchaseOrderPK

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.
  • newReceipts (FromBody): An Array of Purchase Order Receipts to be created.

PUT PurchaseOrders/{purchaseOrderPK}/Receipts/{receiptPK}

Updates the specified Receipt with the details specified in the request body. Required: PurchaseOrderPK

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.
  • receiptPK (FromUri): The PK value of the Receipt to be updated.
  • updatedViewModel (FromBody): Updated details of the Receipt.

ReceiptLineItems

GET ReceiptLineItems

Returns a list of ALL Receipts Line Items. Can be filtered with an OData style query string.

GET ReceiptLineItems/{lineItemPK}?purchaseOrderPK={purchaseOrderPK}&receiptPK={receiptPK}

Returns the Receipt Line Item with the specified PK value.

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.
  • receiptPK (FromUri): The PK value of the Receipt.
  • lineItemPK (FromUri): The PK value of the requested Line Item.

GET ReceiptLineItems?purchaseOrderPK={purchaseOrderPK}&receiptPK={receiptPK}

Returns the Line Items for a specific Purchase Order Receipt.

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.
  • receiptPK (FromUri): The PK value of the Receipt.

POST ReceiptLineItems?purchaseOrderPK={purchaseOrderPK}&receiptPK={receiptPK}

Creates one or more Receipts Line Items in the system with the details specified in the request body. Required: ReceiptPK, PurchaseOrderLineItemPK

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.
  • receiptPK (FromUri): The PK value of the Receipt.
  • newLineItems (FromBody): An Array of Purchase Order Receipt Lines to be created.

PUT ReceiptLineItems/{lineItemPK}?purchaseOrderPK={purchaseOrderPK}&receiptPK={receiptPK}

Updates the specified Receipt Line Item with the details specified in the request body. Required: ReceiptPK, PurchaseOrderLineItemPK

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.
  • receiptPK (FromUri): The PK value of the Receipt.
  • lineItemPK (FromUri): The PK value of the Line Item to be updated.
  • updatedViewModel (FromBody): Updated details of the Line Item.

PUT ReceiptLineItems

Updates one or more Receipt LineItems in the system with the details specified in the request body.

Parameters
  • updViews (FromBody): A collection of Receipt LineItems to be updated.

GET PurchaseOrders/{purchaseOrderPK}/Receipts/{receiptPK}/LineItems/{lineItemPK}

Returns the Receipt Line Item with the specified PK value.

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.
  • receiptPK (FromUri): The PK value of the Receipt.
  • lineItemPK (FromUri): The PK value of the requested Line Item.

GET PurchaseOrders/{purchaseOrderPK}/Receipts/{receiptPK}/LineItems

Returns the Line Items for a specific Purchase Order Receipt.

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.
  • receiptPK (FromUri): The PK value of the Receipt.

POST PurchaseOrders/{purchaseOrderPK}/Receipts/{receiptPK}/LineItems

Creates one or more Receipts Line Items in the system with the details specified in the request body. Required: ReceiptPK, PurchaseOrderLineItemPK

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.
  • receiptPK (FromUri): The PK value of the Receipt.
  • newLineItems (FromBody): An Array of Purchase Order Receipt Lines to be created.

PUT PurchaseOrders/{purchaseOrderPK}/Receipts/{receiptPK}/LineItems/{lineItemPK}

Updates the specified Receipt Line Item with the details specified in the request body. Required: ReceiptPK, PurchaseOrderLineItemPK

Parameters
  • purchaseOrderPK (FromUri): The PK value of the Purchase Order.
  • receiptPK (FromUri): The PK value of the Receipt.
  • lineItemPK (FromUri): The PK value of the Line Item to be updated.
  • updatedViewModel (FromBody): Updated details of the Line Item.