Pbi Service
getAllPbisByPageV2
Retrieve a list of all <glossary:PBI>s from a specific page.
get/pbi/v2/getPbisByPage
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.
pageNumberinteger
Retrieve one or more records by pageNumber. Use to retrieve data in smaller chunks. If left blank, the default is 1.
pageSizeinteger
Number of items to display per page.
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
{
"pbiDetails": [
{
"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"
}
}
]
}