v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB
Vendor Payment Service

getAllVendorPayment

Retrieve a list of Vendor Payment Details

get/vendorpayment/v1/getAllVendorPayment

Query parameters

checkDatestring

Date of the check in format DD-MMM-YY for the payment. (Example: 13-MAR-24) Required if locationCode, vendorCode, transactionNumber, invoiceNumber, checkNumber or discountGLCode not provided.

checkNumberstring

Check number for the payment. Required if locationCode, vendorCode, transactionNumber, invoiceNumber, checkDate, or discountGLCode not provided.

discountGLCodestring

GL discount code for the payment. Required if locationCode, vendorCode, transactionNumber, invoiceNumber, checkNumber, or checkDate not provided

invoiceNumberstring

The invoice number for the payment. Required if locationCode, vendorCode, transactionNumber, checkNumber, checkDate, or discountGLCode not provided.

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.

transactionNumberstring

The transaction number for the payment. Required if locationCode, vendorCode, invoiceNumber, checkNumber, checkDate, or discountGLCode not provided.

vendorCodestring

Vendor code receiving payment. Required if locationCode, transactionNumber, invoiceNumber, checkNumber, checkDate, or discountGLCode not provided.

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

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