GET HelenaOraclePayment/GetHelenaOraclePendingPayments?paymentState={paymentState}

Gets the list of pending payments to post into Oracle

Request Information

URI Parameters

Name	Description	Type	Additional Information
paymentState	Optional parameter to filter the results. The default will return results ready to be posted into Oracle	string	Default value is string.Empty

Body Parameters

Response Information

Resource Description

Gets the list of pending payments to post into Oracle

AgvHelenaOraclePaymentGet

Name	Description	Type
Status	0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful.	string
Message	Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know.	string
ErrorList	List of errors from the API	Collection of string
WarningList	List of warnings from the API	Collection of string
Count	Number of results returned	string
Data	List of properties and values returned for each pending payment that matches the request	Collection of ClsHelenaScheduledPayment

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "WarningList": [
    "sample string 1",
    "sample string 2"
  ],
  "Count": "2",
  "Data": [
    {
      "PaymentGuid": "d90ed259-b089-4d79-80c9-13889b9c0e30",
      "PaymentProcessorReferenceNumber": "sample string 2",
      "PaymentNumber": "sample string 3",
      "RemittanceAmount": 4.0,
      "CheckDate": null,
      "CustomerNumber": "sample string 6",
      "PaymentMethod": "sample string 7",
      "PaymentState": "sample string 8",
      "Comments": "sample string 9",
      "PaymentResponseDetails": [
        {
          "Invoice": "sample string 1",
          "TransactionGuid": "0222df0c-0e9d-41f0-8427-d97dfda42972",
          "AmountApplied": 2.0,
          "DiscountAmount": 3.0
        },
        {
          "Invoice": "sample string 1",
          "TransactionGuid": "0222df0c-0e9d-41f0-8427-d97dfda42972",
          "AmountApplied": 2.0,
          "DiscountAmount": 3.0
        }
      ]
    },
    {
      "PaymentGuid": "d90ed259-b089-4d79-80c9-13889b9c0e30",
      "PaymentProcessorReferenceNumber": "sample string 2",
      "PaymentNumber": "sample string 3",
      "RemittanceAmount": 4.0,
      "CheckDate": null,
      "CustomerNumber": "sample string 6",
      "PaymentMethod": "sample string 7",
      "PaymentState": "sample string 8",
      "Comments": "sample string 9",
      "PaymentResponseDetails": [
        {
          "Invoice": "sample string 1",
          "TransactionGuid": "0222df0c-0e9d-41f0-8427-d97dfda42972",
          "AmountApplied": 2.0,
          "DiscountAmount": 3.0
        },
        {
          "Invoice": "sample string 1",
          "TransactionGuid": "0222df0c-0e9d-41f0-8427-d97dfda42972",
          "AmountApplied": 2.0,
          "DiscountAmount": 3.0
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<AgvHelenaOraclePaymentGet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Custom.Helena">
  <Data>
    <ClsHelenaScheduledPayment>
      <CheckDate i:nil="true" />
      <Comments>sample string 9</Comments>
      <CustomerNumber>sample string 6</CustomerNumber>
      <PaymentGuid>d90ed259-b089-4d79-80c9-13889b9c0e30</PaymentGuid>
      <PaymentMethod>sample string 7</PaymentMethod>
      <PaymentNumber>sample string 3</PaymentNumber>
      <PaymentProcessorReferenceNumber>sample string 2</PaymentProcessorReferenceNumber>
      <PaymentResponseDetails>
        <HelenaScheduledPaymentDetails>
          <AmountApplied>2</AmountApplied>
          <DiscountAmount>3</DiscountAmount>
          <Invoice>sample string 1</Invoice>
          <TransactionGuid>0222df0c-0e9d-41f0-8427-d97dfda42972</TransactionGuid>
        </HelenaScheduledPaymentDetails>
        <HelenaScheduledPaymentDetails>
          <AmountApplied>2</AmountApplied>
          <DiscountAmount>3</DiscountAmount>
          <Invoice>sample string 1</Invoice>
          <TransactionGuid>0222df0c-0e9d-41f0-8427-d97dfda42972</TransactionGuid>
        </HelenaScheduledPaymentDetails>
      </PaymentResponseDetails>
      <PaymentState>sample string 8</PaymentState>
      <RemittanceAmount>4</RemittanceAmount>
    </ClsHelenaScheduledPayment>
    <ClsHelenaScheduledPayment>
      <CheckDate i:nil="true" />
      <Comments>sample string 9</Comments>
      <CustomerNumber>sample string 6</CustomerNumber>
      <PaymentGuid>d90ed259-b089-4d79-80c9-13889b9c0e30</PaymentGuid>
      <PaymentMethod>sample string 7</PaymentMethod>
      <PaymentNumber>sample string 3</PaymentNumber>
      <PaymentProcessorReferenceNumber>sample string 2</PaymentProcessorReferenceNumber>
      <PaymentResponseDetails>
        <HelenaScheduledPaymentDetails>
          <AmountApplied>2</AmountApplied>
          <DiscountAmount>3</DiscountAmount>
          <Invoice>sample string 1</Invoice>
          <TransactionGuid>0222df0c-0e9d-41f0-8427-d97dfda42972</TransactionGuid>
        </HelenaScheduledPaymentDetails>
        <HelenaScheduledPaymentDetails>
          <AmountApplied>2</AmountApplied>
          <DiscountAmount>3</DiscountAmount>
          <Invoice>sample string 1</Invoice>
          <TransactionGuid>0222df0c-0e9d-41f0-8427-d97dfda42972</TransactionGuid>
        </HelenaScheduledPaymentDetails>
      </PaymentResponseDetails>
      <PaymentState>sample string 8</PaymentState>
      <RemittanceAmount>4</RemittanceAmount>
    </ClsHelenaScheduledPayment>
  </Data>
  <ErrorList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorList>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
  <WarningList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WarningList>
</AgvHelenaOraclePaymentGet>