v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB

Purchase Order Service

getAllPurchaseOrders

Retrieves all vendor orders with the accompanying information.

get/purchaseorder/v1/getAllPurchaseOrders

Query parameters

actualDeliveryDateEndstring

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.

actualDeliveryDateStartstring

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.

expectedDeliveryDateEndstring

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.

expectedDeliveryDateStartstring

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.

includeDetailsboolean

show order details or not. Default to False, if not provided. Including details is available only if the purchase order number or the vendor invoice number are entered.

invoiceDateEndstring

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.

invoiceDateStartstring

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.

locationCodestring

The Code that identifies the Location in Crunchtime.

orderDateEndstring

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.

orderDateStartstring

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.

orderTypestring

The type of order to retrieve (optional; case sensitive)

postDatestring

Retrieve orders with post date equal this date (optional)

productNumberstring

Retrieve orders where the product number in the details is exactly equal to the provided value (optional).

purchaseOrderNumberstring

The system-assigned PO# of the order to retrieve (optional; case sensitive)

reconcileDateEndstring

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.

reconcileDateStartstring

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.

status'1' | '2' | '6' | '7' | '8' | '3' | '4'

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)

submitDateEndstring

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.

submitDateStartstring

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.

traceabilityCodestring

Retrieve orders where the traceability code in the details is exactly equal to the value provided (optional).

vendorCodestring

The Code number for the vendor's orders to retrieve (optional; case sensitive)

vendorInvoiceNumberstring

The vendor's Invoice # for the order to retrieve (optional; case sensitive)

vendorProductNamestring

Retrieve orders where the vendor product name in the details contains the provided value. The name must be at least 3 characters long (optional).

vendorProductNumberstring

Retrieve orders where the vendor product number in the details is exactly equal to the provided value (optional).

minutesSinceUpdateinteger

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)

sortOrder'ASC' | 'DESC'

Specifies the sort direction for Purchase Orders: ascending (ASC) or descending (DESC). Default is ASC if not specified (Optional)

includeNullboolean

Specify 'true' to output null data elements.

Headers

authenticationtokenstring required

Secure token for API authentication.

passwordstring required

Password for the Crunchtime Application User.

sitenamestring required

Crunchtime site identifier. (test or production)

useridstring required

User ID for the Crunchtime Application User

X-B3-TraceIdstring

Optional trace identifier for troubleshooting.

Response

Success

accountNumberstring

Receiving location's specific account number with the vendor

actualDeliveryDatestring

Actual Delivery Date

adjustInvoicePricesboolean

Indicates if invoice prices will be adjusted based on vendor setting at the time of invoice

apBatchNumberstring

AP Batch Number

approvalDatestring

Date an order was approved

approvalDateUTCstring

Date an order was approved UTC

approvalRequiredFlagboolean

Indicates whether the vendor order requires approval because of a price/quantity discrepancy

approvalUserstring

User that approved an order

autoOrderFlagboolean

Indicates whether the order was created by Auto-Order

autoOrderTransmitFlagboolean

Indicates whether the autoorder has been successfully transmitted

checkNumberstring

Check Number (COD)

confirmAnticipatedShipDatestring

Confirm Anticipated Ship Date

confirmAnticipatedShipDateUTCstring

Confirm Anticipated Ship Date UTC

confirmDatestring

Date Confirmed Terms for order

confirmReceiptDatestring

Date Confirmed Receipt for order

confirmReceiptFlagboolean

Indicates that a Vendor Order Confirm Receipt has been received for the Vendor Order

confirmReceiptTrackingNumstring

Vendor’s tracking number for the Vendor Order

confirmReceiptUserstring

User who confirmed receipt

confirmTermsAlertboolean

Indicates whether an alert (price or quantity) was identified during the confirm terms process

confirmTermsFlagboolean

Indicates when a confirm terms file is successfully processed

confirmUserstring

User who confirmed Terms for order

consumptionDaysnumber double

Number of days of consumption

corporateCurrencystring

Corporate Currency

createDatestring

Create Date

createDateUTCstring

Create Date UTC

createdByOcrboolean

Indicates whether the order was created by OCR

createdByReconcilerboolean

Indicates whether the order was created by Reconciler Mobile application

ctxConfirmReceiptUserstring

CTX user email that acknowledged the order

ctxConfirmUserstring

CTX user email that confirmed the order

ctxInvoiceUserstring

CTX user email that invoiced the order

deliverToLocationCodestring

Deliver to Location Code

disputeDatestring

The date that the Vendor Order is rejected by the vendor

disputeDateTimestring

Dispute DateTime

disputeDateTimeUTCstring

Dispute DateTime UTC

disputeDateUTCstring

The date that the Vendor Order is rejected by the vendor UTC

doNotTransmitFlagboolean

The user submitted the order without transmitting it

electronicInvoiceDatestring

Electronic Invoice Date

electronicInvoiceDateUTCstring

Electronic Invoice Date UTC

electronicInvoiceFlagboolean

Was Electronic Invoice received

entryDatestring

Date order originally created

entryDateUTCstring

Date order originally created UTC

entryUserstring

User who originally created order

expectedDeliveryDatestring

Expected Delivery Date

finalReconcileDatestring

Date/time of final reconciliation of warehoused order

finalReconcileDateUTCstring

Date/time of final reconciliation of warehoused order UTC

finalReconcileUserstring

User performing final reconciliation of warehoused order

invoiceDatestring

Invoice Date

invoiceNumberstring

Invoice Number

invoiceTotalnumber double

Invoice Total

locCorpCurrencyRationumber double

Conversion from Vendor Base Currency to Location Base Currency

locationCodestring

Location Code

locationCurrencystring

Location Currency

marketNamestring

Market Name

messagestring

Vendor Order Message

misc1Amountnumber double

Amount entered for "Misc. 1" at Vendor Order Reconcile

misc1GlNumberstring

General Ledger number selected for "Misc. 1" at Vendor Order Reconcile

misc2Amountnumber double

Amount entered for "Misc. 2" at Vendor Order Reconcile

misc2GlNumberstring

General Ledger number selected for "Misc. 2" at Vendor Order Reconcile

orderTypestring

Vendor Order Type

orderUnitSelectedstring

I/V. 'I' = Order in Inventory Units, 'V' = Order in Vendor Units

postDatestring

Post Date

receivedWithoutInvoiceFlagboolean

Indicate whether the vendor order has been Physically Received

reconcileDatestring

Date order Reconciled

reconcileDateUTCstring

Date order Reconciled UTC

reconcileUserstring

User who reconciled order

referenceNumberstring

Reference Number

remediateDatestring

Remediate Date

remediateDateUTCstring

Remediate Date UTC

remediateUserstring

Remediate User

remediationDatestring

The date the corporate user changes the vendor order

remediationDateUTCstring

The date the corporate user changes the vendor order UTC

remediationFlagboolean

Indicates when the Vendor Order requires remediation from the corporate office

remediationUserstring

User that updated vendor order.

shippingAmountnumber double

Amount entered for "Freight/Shipping" at Vendor Order Reconcile

shippingGlNumberstring

Tax General Ledger Number selected for "Freight/Shipping"

statusinteger

Inventory Type Status

submitDatestring

Date order submitted

submitDateUTCstring

Date order submitted UTC

submitUserstring

User who submitted order

taxAmountnumber double

Amount entered for "Tax" at Vendor Order Reconcile

taxGlNumberstring

Tax General Ledger Number

transactionNumberstring

Transaction Number

userMatchAlertFlagboolean

Indicates whether the same user submitted and reconciled a non e-invoice order

venLocCurrencyRationumber double

Vendor to Location Currency Ratio

vendorCodestring

Vendor Code

vendorCurrencystring

Vendor Currency

vendorPortalOrderExistsboolean

Vendor Portal Order Exists

vpInvoiceFlagboolean

Indicates that the vendor order was invoiced via the vendor portal

Example response

[
  {
    "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
  }
]