---
title: "getVendorPaymentByPage"
method: GET
path: "/vendorpayment/v1/getVendorPaymentByPage"
tags: ["Vendor Payment Service"]
---

# getVendorPaymentByPage

`GET /vendorpayment/v1/getVendorPaymentByPage`

## Request

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

Retrieve vendor payment details by page number.

## Query parameters

- `checkDate` string
- `checkNumber` string
- `discountGLCode` string
- `invoiceNumber` string
- `locationCode` string
- `minutesSinceUpdate` integer
- `pageNumber` integer
- `transactionNumber` string
- `vendorCode` string
- `pageSize` integer
- `includeNull` boolean

## Headers

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

## Response `200`

Success

- VendorPaymentBatchResponseDto: VendorPaymentBatchResponseDto description
  - `hasNext` boolean
  - `totalPages` integer
  - `vendorPaymentDetails` VendorPaymentDetails[]
    - `vendorPaymentDetailDetails` VendorPaymentDetailsDto[]
      - `checkAmount` number: "checkAmount" from Vendor Payment.
      - `checkDate` string, required: "checkDate" from Vendor Payment
      - `checkNumber` string, required: "checkNumber" from Vendor Payment
      - `discountAmount` number, required: "discountAmount" from Vendor Payment.
      - `discountGLCode` string, required: "discountGLCode" from Vendor Payment
      - `invoiceAllocationAmount` number: "invoiceAllocationAmount" from Vendor Payment.
      - `invoiceNumber` string, required: "invoiceNumber" from Vendor Payment
      - `locationCode` string: "locationCode" from Vendor Payment
      - `transactionNumber` string: "transactionNumber" from Vendor Payment
      - `vendorCode` string, required: "vendorCode" from Vendor Payment

## Other responses

- `400`: Validation Error
- `401`: Authorization
- `404`: vendor payment 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)