CRcrunchtime
Vendor Payment Service

getVendorPaymentByPage

Retrieve vendor payment details by page number.

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

Query parameters

checkDatestring

Date of the check in format DD-MMM-YY for the payment. (Example: 13-MAR-24)

checkNumberstring

Check number for the payment.

discountGLCodestring

GL discount code for the payment.

invoiceNumberstring

The invoice number for the payment.

locationCodestring

The Code that identifies the Location in Crunchtime. Required if vendorCode, transactionNumber, invoiceNumber, checkNumber, checkDate, and discountGLCode not provided.

minutesSinceUpdateinteger

The number of minutes since a payment record was last updated. Use to set how far back to search.

pageNumberinteger

Retrieve one or more records by pageNumber. Use to retrieve data in smaller chunks. If left blank, the default is 1.

transactionNumberstring

The transaction number for the payment.

vendorCodestring

Vendor code receiving payment.

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

hasNextboolean
totalPagesinteger

Example response

{
  "vendorPaymentDetails": [
    {
      "vendorPaymentDetailDetails": [
        {
          "checkAmount": 140,
          "checkDate": "03/13/2024",
          "checkNumber": "paythis",
          "discountAmount": -36.6,
          "invoiceAllocationAmount": 13.5,
          "locationCode": "000122",
          "transactionNumber": "vo-10050"
        }
      ]
    }
  ]
}

Changes

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