---
title: "getAllPbisByPageV2"
method: GET
path: "/pbi/v2/getPbisByPage"
tags: ["Pbi Service"]
---

# getAllPbisByPageV2

`GET /pbi/v2/getPbisByPage`

## 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/getPbisByPage`
- Auth: none declared. Required headers: `authenticationtoken`, `password`, `sitename`, `userid`

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

## Query parameters

- `invoiceDate` string, required
- `invoiceNumber` string
- `locationCode` string, required
- `pageNumber` integer
- `pageSize` integer
- `includeNull` boolean

## Headers

- `authenticationtoken` string, required
- `password` string, required
- `sitename` string, required
- `userid` string, required
- `X-B3-TraceId` string

## Response `200`

Success

- PbiBatchResponseDto: PbiBatchResponseDto description
  - `hasNext` boolean
  - `pbiDetails` PbiDetailsGet[]
    - `pbiDetailDetails` PbiDetailDto[]
      - `category` string, required: Must match an existing Category in Enterprise Manager.
      - `detailAmount` number, required: Total value of this item row.
      - `detailMemo` string: Description of the product delivered or service performed.
      - `glNumber` string: Must match an existing GL Number in Enterprise Manager.
      - `microcategory` string, required: Must match an existing Microcategory in Enterprise Manager. Required if “Link GL to” Preference is “Microcategory”
      - `subcategory` string, required: Must match an existing Subcategory in Enterprise Manager. Required if “Link GL to” Preference is “Subcategory” or “Microcategory”
    - `pbiHeaderDetails` PbiHeaderDtoGet: PbiHeaderDtoGet description
      - `checkNumber` string: Check Number used to pay the invoice.
      - `deliveryDate` string, date, required: Date the product was delivered or service performed.
      - `invoiceDate` string, date, required: Date the vendor issued the invoice.
      - `invoiceNumber` string, required: Invoice Number from the vendor's invoice.
      - `invoiceTotal` number, required: Total value for the entire invoice.
      - `locationCode` string: Code or Name for the Location. Must match an active Location in Enterprise Manager.
      - `vendorCode` string, required: Must match a Location Export Code, Export Code, or Code for an active Vendor in Enterprise Manager.
      - `transactionStatus` integer: Indicates the transaction status: 7 for Awaiting Reconcile, 3 for Reconciled, 4 for Cancelled, and 12 for Awaiting Allocation.
      - `postInventoryScheduledDate` string: Post Date for Purchase by Invoice transaction
      - `reconcileDate` string: Date the invoice was reconciled
  - `totalPages` integer

## Other responses

- `400`: Validation Error
- `401`: Authorization
- `404`: pbi not found
- `429`: Too Many Requests
- `500`: Unexpected Error
- `503`: System under maintenance
- `504`: Timeout

---

[API](https://skmtc.dev/crunchtime/apis/inventory-labor.md) - [All operations](https://skmtc.dev/crunchtime/apis/inventory-labor/llms.txt) - [OpenAPI document](https://skmtc.dev/crunchtime/apis/inventory-labor/revisions/fff247a87cc9?raw)
