PUT api/PaymentReconciliation?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}

Process payment reconciliation Process payments against AR transactions, with a returned list of items if transaction is not in correct period

Request Information

URI Parameters

NameDescriptionTypeAdditional information
VendorID

string

Required

VendorPassword

string

Required

APIGUID

string

Required

Body Parameters

Payment information to reconcile

Collection of ARAccountReconciliation
NameDescriptionTypeAdditional information
paymentId

string

None.

payout

payout

None.

amount

decimal number

None.

created

date

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "paymentId": "sample string 1",
    "payout": {
      "id": "sample string 1",
      "status": "sample string 2",
      "arrival": "2024-09-19T12:21:50.9739667-05:00",
      "bankAccount": {
        "name": "sample string 1",
        "lastFour": "sample string 2"
      },
      "amount": 4.0,
      "created": "2024-09-19T12:21:50.9739667-05:00"
    },
    "amount": 2.0,
    "created": "2024-09-19T12:21:50.9739667-05:00"
  },
  {
    "paymentId": "sample string 1",
    "payout": {
      "id": "sample string 1",
      "status": "sample string 2",
      "arrival": "2024-09-19T12:21:50.9739667-05:00",
      "bankAccount": {
        "name": "sample string 1",
        "lastFour": "sample string 2"
      },
      "amount": 4.0,
      "created": "2024-09-19T12:21:50.9739667-05:00"
    },
    "amount": 2.0,
    "created": "2024-09-19T12:21:50.9739667-05:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfARAccountReconciliation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VMSRXChange.DataClassesAccountsReceivable">
  <ARAccountReconciliation>
    <amount>2</amount>
    <created>2024-09-19T12:21:50.9739667-05:00</created>
    <paymentId>sample string 1</paymentId>
    <payout>
      <amount>4</amount>
      <arrival>2024-09-19T12:21:50.9739667-05:00</arrival>
      <bankAccount>
        <lastFour>sample string 2</lastFour>
        <name>sample string 1</name>
      </bankAccount>
      <created>2024-09-19T12:21:50.9739667-05:00</created>
      <id>sample string 1</id>
      <status>sample string 2</status>
    </payout>
  </ARAccountReconciliation>
  <ARAccountReconciliation>
    <amount>2</amount>
    <created>2024-09-19T12:21:50.9739667-05:00</created>
    <paymentId>sample string 1</paymentId>
    <payout>
      <amount>4</amount>
      <arrival>2024-09-19T12:21:50.9739667-05:00</arrival>
      <bankAccount>
        <lastFour>sample string 2</lastFour>
        <name>sample string 1</name>
      </bankAccount>
      <created>2024-09-19T12:21:50.9739667-05:00</created>
      <id>sample string 1</id>
      <status>sample string 2</status>
    </payout>
  </ARAccountReconciliation>
</ArrayOfARAccountReconciliation>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.