Purchase Orders

Purchase Order API

Purchase Orders – GET PurchaseOrders

Where DynamxMFG® is the point of truth for Purchase Orders, third party applications can use the following APIs to GET Purchase Orders records.

Info
https://{SUBDOMAIN}.totalcontrolpro.com/inventoryApi/api/integration/PurchaseOrders
Calling the Purchase Order API GET request without optional parameters will return all of the created purchase orders in the format below.

  1. [
  2.   {
  3.     "id": 30,
  4.     "referenceNo": "P25",
  5.     "supplierName": "Supp1",
  6.     "supplierRef": "Supp1",
  7.     "supplierContactRef": null,
  8.     "supplierContact": null,
  9.     "deliveryType": null,
  10.     "carriageValue": 0,
  11.     "vat": 0.2,
  12.     "notes": null,
  13.     "createdBy": "p@p.com",
  14.     "status": "Completed",
  15.     "statusId": 4,
  16.     "created": "2022-12-19T15:49:26.4623571Z",
  17.     "completed": "2022-12-19T15:49:49.1956578Z",
  18.     "lines": [
  19.       {
  20.         "id": 29,
  21.         "stockItemCode": "TIC1",
  22.         "stockItemDescription": "Test Item Component 1",
  23.         "orderedQty": 100,
  24.         "type": "Component",
  25.         "price": 0,
  26.         "discount": 0,
  27.         "bookInData": [
  28.           {
  29.             "date": "2022-12-19T15:49:49.229127Z",
  30.             "quantity": 100
  31.           }
  32.         ]
  33.       }
  34.     ]
  35.   }
  36. ]

lastUpdated Parameter

The GET Purchase Orders API has an optional parameter to get all of the new, or updated purchase orders from a specified point in time onwards.

The parameter “lastUpdated” date is in the format YYYY-MM-DDThh:mm:ss

https://{SUBDOMAIN}.totalcontrolpro.com/inventoryApi/api/integration/PurchaseOrders?lastUpdated=2023-01-04T08%3A15%3A30-05%3A00

Status, StatusID - the order status and status ID (as an integer) can be used by third party integrators to control whether or not to add Purchase Order to their 3rd party system.

BookInData - allows the status of a purchase order to be identified and establish whether it is fully booked in.



    • Related Articles

    • Sales Orders API

      Sales Order Creation – POST SalesOrders New Sales Orders can be created in DynamxMFG® from third party applications using the Sales Order Creation API. This POST API call enables Sales Orders to be create against customers using the Customer ...
    • Suppliers API

      Suppliers – GET Where DynamxMFG® is the point of truth for suppliers, third party applications can use the following APIs to GET Supplier information held, including Supplier Contacts and Addresses. This API can be used to retrieve the suppliers that ...
    • Customers API

      Customers – POST API Customer information can be inserted into DynamxMFG®. Updating Customer Record data; This API can be used both to INSERT and UPDATE Customer record data in DynamxMFG®. This API can be used to update the Customer without updating ...
    • Intro, Keys & Swagger

      Introduction TotalControlPro provide specific APIs across DynamxMFG® to allow entry-level direct 3rd party integration. These public APIs are designed for clients who wish to connect directly to the DynamxMFG® platform using custom and/or 3rd party ...