API Docs for:
Show:

eb_PayOffOrders Class

Pay Off Orders class.

Methods

eb_PayOffOrders.cardPayment

(
  • cardDetails
  • orderId
)
Object

Parameters:

  • cardDetails Object

    CardDetails of company selected.

  • orderId String

    Order Id for order to be placed.

Returns:

Object:

jQuery promise object which when resolved returns order history data.

eb_PayOffOrders.domElement

(
  • domElement
)

Page DOM element.

Parameters:

  • domElement Object

    current DOM element.

eb_PayOffOrders.model

(
  • options
  • userContext
)

Pay Off Orders model responsible for all pay off orders operations.

Parameters:

  • options Any

    Object of pay off orders data.

    • ServicePath String

      Service URL.

    • SitePath String

      Site URL.

    • templatePath String

      HTML path.

    • domElement Object

      Pay Off Orders DOM element.

  • userContext Object

    eb_UserContext.model instance.

eb_PayOffOrders.outstandingOrderService

(
  • companyId
)
Object

This method is used to get order history data.

Parameters:

  • companyId String

    Selected company Id from dropdown

Returns:

Object:

jQuery promise object which when resolved returns unpaid order data.

eb_PayOffOrders.render

(
  • options
)
String

The service will return Pay Off Orders HTML.

Parameters:

  • options Any

    Array of required data.

    • templatePath String

      Pay Off Orders template URL.

Returns:

String:

Pay Off Orders HTML template.

Properties

eb_PayOffOrders.defaultErrorMessage

String

Default error message.

eb_PayOffOrders.errorResponses

Object

Globally defined error codes object for the control. Every error code should have boolean 'useServerMessage' attribute, which when true suggests we are showing service error message on the UI. If the 'useServerMessage' is defined as false, then provide another attribute 'frontEndMessage' with the error string which will be shown on UI. If 'useServerMessage' is false and 'frontEndMessage' is not defined, default error message will be shown. If service error response contains error code not defined in this object then default error message will be shown.

eb_PayOffOrders.getOutstandingOrders

String

Get outstanding orders service

eb_PayOffOrders.ServicePath

String

SOA path.

eb_PayOffOrders.SitePath

String

Site path. It would be set from configuration file.

eb_PayOffOrders.TemplatePath

String

Pay Off Orders template path.