Login
      Contents x
      /v23.1/PrePaymentRequests
      • 05 Jun 2024
      • 1 Minute to read
      • Contributors
      • Print
      • Dark
        Light
      • PDF
      Contents

      /v23.1/PrePaymentRequests

      • Updated on 05 Jun 2024
      • 1 Minute to read
      • Contributors
      • Print
      • Dark
        Light
      • PDF
      Article summary

      Get
      /v23.1/PrePaymentRequests
      Security
      HTTP
      Type Bearer

      Please enter a valid token

      Query parameters
      StoreId
      integer (int32)
      PrePaymentRequestNumber
      integer (int32)
      CustomerId
      integer (int32)
      SaleOrderId
      integer (int32)
      UserId
      integer (int32)
      ProductId
      integer (int32)
      IsPaidOnly
      string
      Valid values[ "All", "Yes", "No" ]
      PrePaymentsAssigned
      string
      Valid values[ "All", "Yes", "No" ]
      PspAssignedOnly
      string
      Valid values[ "All", "Yes", "No" ]
      Status
      string
      Valid values[ "NotSpecified", "New", "Completed", "Failed" ]
      Offset
      integer (int32)
      RecordCount
      integer (int32)
      ItemId
      integer (int32)
      IncludeItemId
      integer (int32)
      ExcludeItemId
      integer (int32)
      ModifiedSinceDateTime
      string (date-time)
      Responses
      200

      Success

      Array of object
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      companyId
      integer (int32)
      storeId
      integer (int32)
      prePaymentRequestNumber
      integer (int32)
      paymentServiceProviderId
      integer (int32)
      prePaymentId
      integer (int32)
      customerId
      integer (int32)
      saleOrderId
      integer (int32)
      userId
      integer (int32)
      productId
      integer (int32)
      toBePaid
      number (double)
      note
      string
      exportLog
      string
      reference
      string
      status
      string
      Valid values[ "NotSpecified", "New", "Completed", "Failed" ]
      isPaid
      boolean
      Default"False"
      paid
      number (double)
      saleOrderNumber
      integer (int32)
      saleOrderDescription
      string
      saleOrderReference
      string
      customerNumber
      integer (int64)
      customerName
      string
      Array of object
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      companyId
      integer (int32)
      storeId
      integer (int32)
      prePaymentRequestNumber
      integer (int32)
      paymentServiceProviderId
      integer (int32)
      prePaymentId
      integer (int32)
      customerId
      integer (int32)
      saleOrderId
      integer (int32)
      userId
      integer (int32)
      productId
      integer (int32)
      toBePaid
      number (double)
      note
      string
      exportLog
      string
      reference
      string
      status
      string
      Valid values[ "NotSpecified", "New", "Completed", "Failed" ]
      isPaid
      boolean
      Default"False"
      paid
      number (double)
      saleOrderNumber
      integer (int32)
      saleOrderDescription
      string
      saleOrderReference
      string
      customerNumber
      integer (int64)
      customerName
      string
      Array of object
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      companyId
      integer (int32)
      storeId
      integer (int32)
      prePaymentRequestNumber
      integer (int32)
      paymentServiceProviderId
      integer (int32)
      prePaymentId
      integer (int32)
      customerId
      integer (int32)
      saleOrderId
      integer (int32)
      userId
      integer (int32)
      productId
      integer (int32)
      toBePaid
      number (double)
      note
      string
      exportLog
      string
      reference
      string
      status
      string
      Valid values[ "NotSpecified", "New", "Completed", "Failed" ]
      isPaid
      boolean
      Default"False"
      paid
      number (double)
      saleOrderNumber
      integer (int32)
      saleOrderDescription
      string
      saleOrderReference
      string
      customerNumber
      integer (int64)
      customerName
      string
      401

      Unauthorized

      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      403

      Forbidden

      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      404

      Not Found

      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      Was this article helpful?
      What's Next
      Change password!
      Changing your password will log you out immediately. Use the new password to log back in.
      Change profile
      Success!
      First name must have atleast 2 characters. Numbers and special characters are not allowed.
      Last name must have atleast 1 characters. Numbers and special characters are not allowed.
      Enter a valid email
      Enter a valid password
      Your profile has been successfully updated.
      Logout