---
updatedAt: 2026-06-12T14:08:37.000Z
agentTools:
  projectIndex: https://developer.crunchtime.com/llms.txt
---

# getVendorPaymentByPage

Retrieve vendor payment details by page number.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "Swagger documentation supporting mobile development of Crunchtime.",
    "version": "2.99",
    "title": "Inventory & Labor",
    "termsOfService": "http://springfox.io",
    "contact": {
      "name": "Crunchtime Development Team",
      "url": "http://www.crunchtime.com",
      "email": "apiquestions@crunchtime.com"
    },
    "license": {
      "name": "Apache License Version 2.0",
      "url": "https://github.com/springfox/springfox/blob/master/LICENSE"
    }
  },
  "tags": [
    {
      "name": "Vendor Payment Service",
      "description": "The Vendor Payment service allows you to create and retrieve payment information that typically comes from an Accounts Payable system. The Post call will update reconciled Vendor Orders and Purchase by Invoice transactions with Check Number, Check Amount, Check Date and Check Amount Allocated to the Invoice (since the same check can be used for multiple invoices). When payment information has been processed, this will be indicated in the Vendor Order and/or Purchase by Invoice screens in Net-Chef, as well as in Crunchtime Xchange."
    }
  ],
  "paths": {
    "/vendorpayment/v1/getVendorPaymentByPage": {
      "get": {
        "tags": [
          "Vendor Payment Service"
        ],
        "summary": "getVendorPaymentByPage",
        "description": "Retrieve vendor payment details by page number.",
        "operationId": "getVendorPaymentByPageV1UsingGET",
        "parameters": [
          {
            "name": "authenticationtoken",
            "in": "header",
            "description": "Secure token for API authentication.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "checkDate",
            "in": "query",
            "description": "Date of the check in format DD-MMM-YY for the payment. (Example: 13-MAR-24)",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "checkNumber",
            "in": "query",
            "description": "Check number for the payment.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "discountGLCode",
            "in": "query",
            "description": "GL discount code for the payment.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "invoiceNumber",
            "in": "query",
            "description": "The invoice number for the payment.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "locationCode",
            "in": "query",
            "description": "The Code that identifies the Location in Crunchtime. \n Required if `vendorCode`, `transactionNumber`, `invoiceNumber`, `checkNumber`, `checkDate`, and `discountGLCode` not provided.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "minutesSinceUpdate",
            "in": "query",
            "description": "The number of minutes since a payment record was last updated. Use to set how far back to search.",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "pageNumber",
            "in": "query",
            "description": "Retrieve one or more records by `pageNumber`. \n Use to retrieve data in smaller chunks. \n If left blank, the default is `1`.",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 1
            }
          },
          {
            "name": "password",
            "in": "header",
            "description": "Password for the Crunchtime Application User.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sitename",
            "in": "header",
            "description": "Crunchtime site identifier. (test or production)",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "transactionNumber",
            "in": "query",
            "description": "The transaction number for the payment.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "userid",
            "in": "header",
            "description": "User ID for the Crunchtime Application User.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "vendorCode",
            "in": "query",
            "description": "Vendor code receiving payment.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "X-B3-TraceId",
            "in": "header",
            "description": "Optional trace identifier for troubleshooting.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "description": "Number of items to display per page.",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "includeNull",
            "in": "query",
            "description": "Specify 'true' to output null data elements.",
            "required": false,
            "allowEmptyValue": true,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/VendorPaymentBatchResponseDto"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VendorPaymentBatchResponseDto"
                }
              }
            }
          },
          "400": {
            "description": "Validation Error",
            "content": {
              "*/*": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ObjectError"
                  }
                }
              },
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ObjectError"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Authorization",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "404": {
            "description": "vendor payment not found",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected Error",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "503": {
            "description": "System under maintenance",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "504": {
            "description": "Timeout",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  },
  "externalDocs": {
    "description": "Crunchtime Developer Hub",
    "url": "https://developer.crunchtime.com/"
  },
  "servers": [
    {
      "url": "//webservices-test.net-chef.com"
    }
  ],
  "components": {
    "schemas": {
      "ObjectError": {
        "type": "object",
        "properties": {
          "arguments": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "code": {
            "type": "string"
          },
          "codes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "defaultMessage": {
            "type": "string"
          },
          "objectName": {
            "type": "string"
          }
        },
        "title": "ObjectError"
      },
      "VendorPaymentBatchResponseDto": {
        "type": "object",
        "properties": {
          "hasNext": {
            "type": "boolean"
          },
          "totalPages": {
            "type": "integer",
            "format": "int32"
          },
          "vendorPaymentDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/VendorPaymentDetails"
            }
          }
        },
        "title": "VendorPaymentBatchResponseDto",
        "description": "VendorPaymentBatchResponseDto description"
      },
      "VendorPaymentDetails": {
        "type": "object",
        "properties": {
          "vendorPaymentDetailDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/VendorPaymentDetailsDto"
            }
          }
        },
        "title": "VendorPaymentDetails",
        "description": "VendorPaymentDetails description"
      },
      "VendorPaymentDetailsDto": {
        "type": "object",
        "required": [
          "checkDate",
          "checkNumber",
          "discountAmount",
          "discountGLCode",
          "invoiceNumber",
          "vendorCode"
        ],
        "properties": {
          "checkAmount": {
            "type": "number",
            "example": 140,
            "description": "\"checkAmount\" from Vendor Payment."
          },
          "checkDate": {
            "type": "string",
            "example": "03/13/2024",
            "description": "\"checkDate\" from Vendor Payment"
          },
          "checkNumber": {
            "type": "string",
            "example": "paythis",
            "description": "\"checkNumber\" from Vendor Payment"
          },
          "discountAmount": {
            "type": "number",
            "example": -36.6,
            "description": "\"discountAmount\" from Vendor Payment."
          },
          "discountGLCode": {
            "type": "string",
            "example": 687501,
            "description": "\"discountGLCode\" from Vendor Payment"
          },
          "invoiceAllocationAmount": {
            "type": "number",
            "example": 13.5,
            "description": "\"invoiceAllocationAmount\" from Vendor Payment."
          },
          "invoiceNumber": {
            "type": "string",
            "example": 129,
            "description": "\"invoiceNumber\" from Vendor Payment"
          },
          "locationCode": {
            "type": "string",
            "example": "000122",
            "description": "\"locationCode\" from Vendor Payment"
          },
          "transactionNumber": {
            "type": "string",
            "example": "vo-10050",
            "description": "\"transactionNumber\" from Vendor Payment"
          },
          "vendorCode": {
            "type": "string",
            "example": 17,
            "description": "\"vendorCode\" from Vendor Payment"
          }
        },
        "title": "VendorPaymentDetailsDto",
        "description": "VendorPaymentDetailsDto description"
      }
    }
  }
}
```