CRcrunchtime
Pbi Service

getAllPbisV2

Retrieve a list of all <glossary:PBI>s.

get/pbi/v2/getAllPbis

Request

  • Base URL
    //webservices-test.net-chef.com (relative, and the document’s source URL is not known)
  • URL
    //webservices-test.net-chef.com/pbi/v2/getAllPbis
  • Auth
    none declared. Required headers: authenticationtoken, password, sitename, userid

Query parameters

invoiceDatestring required

Invoice Date to retrieve in format DD-MMM-YY.

invoiceNumberstring

Invoice number to retrieve.

locationCodestring required

The Code that identifies the Location in Crunchtime.

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

Example response

[
  {
    "pbiDetailDetails": [
      {
        "category": "NON-FOOD",
        "detailAmount": 15,
        "detailMemo": "Purchased Cleaning Supplies",
        "microcategory": "PAPER TOWELS",
        "subcategory": "PAPER GOODS"
      }
    ],
    "pbiHeaderDetails": {
      "checkNumber": "1701",
      "deliveryDate": "12/14/2025",
      "invoiceDate": "12/14/2025",
      "invoiceNumber": "74656",
      "invoiceTotal": 15,
      "locationCode": "100122",
      "vendorCode": "100700",
      "postInventoryScheduledDate": "12/14/2025",
      "reconcileDate": "12/14/2025"
    }
  }
]

Changes

No recorded changes to this operation across all 2 revisions of this API.