getPurchaseOrdersByPage
Retrieves all vendor orders with the accompanying information by page number.
Query parameters
Retrieve orders with actual delivery date equal to this date or earlier (optional). Must be entered together with the start date and the range between the start and end must be no more than 31 days.
Retrieve orders with actual delivery date equal to this date or later (optional). Must be entered together with the start date and the range between the start and end must be no more than 31 days.
Retrieve orders with expected delivery date equal to this date or earlier (optional). Must be entered together with the start date and the range between the start and end must be no more than 31 days.
Retrieve orders with expected delivery date equal to this date or later (optional). Must be entered together with the start date and the range between the start and end must be no more than 31 days.
show order details or not. Default to False, if not provided.
Retrieve orders with invoice date equal to this date or earlier (optional). Must be entered together with the start date and the range between the start and end must be no more than 31 days.
Retrieve orders with invoice date equal to this date or later (optional). Must be entered together with the start date and the range between the start and end must be no more than 31 days.
The Code that identifies the Location in Crunchtime.
Retrieve orders with create date equal to this date or earlier (optional). Must be entered together with the start date and the range between the start and end must be no more than 31 days.
Retrieve orders with create date equal to this date or later (optional). Must be entered together with the start date and the range between the start and end must be no more than 31 days.
The type of order to retrieve (optional; case sensitive)
Retrieve one or more records by pageNumber. \n Use to retrieve data in smaller chunks. \n If left blank, the default is 1.
Retrieve orders with post date equal this date (optional)
Retrieve orders where the product number in the details is exactly equal to the provided value (optional).
The system-assigned PO# of the order to retrieve (optional; case sensitive)
Retrieve orders with reconcile date equal to this date or earlier (optional). Must be entered together with the start date and the range between the start and end must be no more than 31 days.
Retrieve orders with reconcile date equal to this date or later (optional). Must be entered together with the start date and the range between the start and end must be no more than 31 days.
Retrieve orders with inventory type status (New Order (Not sent) [1], Submitted [2], Confirmation of Receipt [6], Confirmation of Terms [7], Consolidated [8], Reconciled [3], Cancelled [4]) equal to this number (optional)
Retrieve orders with submit date equal to this date or earlier (optional). Must be entered together with the start date and the range between the start and end must be no more than 31 days.
Retrieve orders with submit date equal to this date or later (optional). Must be entered together with the start date and the range between the start and end must be no more than 31 days.
Retrieve orders where the traceability code in the details is exactly equal to the value provided (optional).
The Code number for the vendor's orders to retrieve (optional; case sensitive)"
The vendor's Invoice # for the order to retrieve (optional; case sensitive)
Retrieve orders where the vendor product name in the details contains the provided value. The name must be at least 3 characters long (optional).
Retrieve orders where the vendor product number in the details is exactly equal to the provided value (optional).
Number of items to display per page.
The number of minutes since a record was last updated. Use to set how far back to search. Must be more than 0 and less than 10080 (7 days). Can be standalone parameter.
Specifies the field used to sort the Purchase Orders. Default is 'lastUpdated' if not provided (Optional)
Specifies the sort direction for Purchase Orders: ascending (ASC) or descending (DESC). Default is ASC if not specified (Optional)
Specify 'true' to output null data elements.
Headers
Secure token for API authentication.
Password for the Crunchtime Application User.
Crunchtime site identifier. (test or production)
"User ID for the Crunchtime Application User.
Optional trace identifier for troubleshooting.
Response
Success
Example response
{
"purchaseOrderDetails": [
{
"actualDeliveryDate": "05/25/2021",
"adjustInvoicePrices": true,
"apBatchNumber": "APBATCH123",
"approvalDate": "06/23/2021",
"approvalDateUTC": "06/23/2021",
"approvalRequiredFlag": true,
"autoOrderFlag": true,
"autoOrderTransmitFlag": true,
"confirmAnticipatedShipDate": "06/23/2021",
"confirmAnticipatedShipDateUTC": "06/23/2021",
"confirmDate": "05/25/2021",
"confirmReceiptDate": "05/25/2021",
"confirmReceiptFlag": true,
"confirmTermsAlert": true,
"confirmTermsFlag": true,
"consumptionDays": 30,
"corporateCurrency": "USD",
"createDate": "05/25/2021 08:11:18",
"createDateUTC": "05/25/2021 08:11:18",
"createdByOcr": true,
"createdByReconciler": true,
"ctxConfirmReceiptUser": "user@mail.com",
"ctxConfirmUser": "user@mail.com",
"ctxInvoiceUser": "user@mail.com",
"deliverToLocationCode": "LOC456",
"details": [
{
"actualBidContractConv": 1,
"actualBidContractPrice": 12,
"addVendorCode": "VEND123",
"approvePriceAlertFlag": true,
"cnvConfirmToInventory": 1,
"cnvEntryToInventory": 1,
"cnvReconcileToInventory": 1,
"completeTaxRate": 20,
"confirmTermsQuantityAlert": true,
"creditValue": 18,
"expirationDate": "12/27/2021",
"expirationDateUTC": "12/27/2021",
"manufacturerNumber": "MAN123",
"marketName": "MarketX",
"minDaysOnHand": 3,
"poLineNumber": 1,
"priceCaptureDate": "12/27/2021",
"priceCaptureDateUTC": "12/27/2021",
"priceConfirmation": 40,
"priceEntry": 45,
"priceInvoice": 35,
"priceInvoiceOriginal": 3.25,
"priceReconcile": 30,
"priceRemediationFlag": true,
"priceUsed": 25,
"productBrand": "Nestle",
"productNumber": "TBPE3-3",
"projectedConsumption": 2,
"qualitativeJudgement": "SHELF LIFE",
"quantityConfirm": 75,
"quantityConfirmForInv": 70,
"quantityEntry": 85,
"quantityEntryForInv": 80,
"quantityInvoice": 65,
"quantityInvoiceForInv": 60,
"quantityMoForInv": 100,
"quantityReconcile": 55,
"quantityReconcileForInv": 50,
"quantitySuggestedForInv": 90,
"referenceLineNumber": 456,
"referenceNumber": "REF123",
"restricted": true,
"splitFlag": true,
"storageCode": "DT1462",
"subConversionFactor": 1.5,
"subPackage": "G",
"subProductName": "Pineapples",
"taxCode": "VAT",
"temperature": 5.5,
"traceabilityCode": "BFCA179A152023213",
"traceabilityCodeSource": "FoodTraceability, Inc. 123 Main Street Anytown, PA 12345 (222) 123-4567",
"vendorPackage": "G",
"vendorPackageOrder": "G",
"vendorPortalDetailExists": true,
"vendorPortalSubExists": true,
"vendorProductName": "VendorProduct",
"vendorProductNumber": "TBPE3-3",
"vpOriginalReconcilePrice": 4,
"vpOriginalReconcileQuantity": 6
}
],
"disputeDate": "06/23/2021",
"disputeDateTime": "06/23/2021 08:48:58",
"disputeDateTimeUTC": "06/23/2021 08:48:58",
"disputeDateUTC": "06/23/2021",
"electronicInvoiceDate": "06/23/2021",
"electronicInvoiceDateUTC": "06/23/2021",
"electronicInvoiceFlag": true,
"entryDate": "05/25/2021 08:11:18",
"entryDateUTC": "05/25/2021 08:11:18",
"expectedDeliveryDate": "05/25/2021",
"finalReconcileDate": "06/23/2021 08:48:58",
"finalReconcileDateUTC": "06/23/2021 08:48:58",
"invoiceDate": "05/25/2021",
"invoiceTotal": 3.25,
"locCorpCurrencyRatio": 1,
"locationCode": "LOC123",
"locationCurrency": "USD",
"marketName": "MarketX",
"message": "Simple message for order",
"misc2Amount": 5,
"orderType": "VO",
"orderUnitSelected": "I",
"postDate": "12/27/2021",
"reconcileDate": "06/23/2021 08:48:58",
"reconcileDateUTC": "06/23/2021 08:48:58",
"referenceNumber": "DT-7772",
"remediateDate": "06/23/2021",
"remediateDateUTC": "06/23/2021",
"remediationDate": "06/23/2021",
"remediationDateUTC": "06/23/2021",
"shippingAmount": 20,
"status": 3,
"submitDate": "05/25/2021 08:11:20",
"submitDateUTC": "05/25/2021 08:11:20",
"taxAmount": 1,
"taxGlNumber": "TAX123",
"transactionNumber": "vo-98637",
"venLocCurrencyRatio": 1,
"vendorCode": "DT-445",
"vendorCurrency": "USD",
"vendorPortalOrderExists": true
}
]
}