POST 17.0/app/paymentruns/checkstatementundo

Description

Checks if a statement can be undone by validating its associated transactions and returns any errors or conflicts.

URI Parameters

None.

Contains the statement ID, contact ID, property ID, and bank account ID to validate.

Name Description Type Additional information
ContactId

integer

None.

PropertyId

integer

None.

BankAccountId

integer

None.

application/json, text/json

Sample:
{
  "contactId": 1,
  "propertyId": 2,
  "bankAccountId": 3
}

application/xml, text/xml

Sample:
<CheckStatementRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ContactId>1</ContactId>
  <PropertyId>2</PropertyId>
  <BankAccountId>3</BankAccountId>
</CheckStatementRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

List of statement items with validation errors, or empty list if the statement can be undone.

Collection of StatementCheckItem
Name Description Type Additional information
TransactionId

integer

None.

Date

date

None.

ContactId

integer

None.

Contact

string

None.

PropertyId

integer

None.

Property

string

None.

Description

string

None.

Amount

decimal number

None.

Info

string

None.

application/json, text/json

Sample:
[
  {
    "transactionId": 1,
    "date": "2026-04-27T16:20",
    "contactId": 3,
    "contact": "sample string 4",
    "propertyId": 5,
    "property": "sample string 6",
    "description": "sample string 7",
    "amount": 8.0,
    "info": "sample string 9"
  },
  {
    "transactionId": 1,
    "date": "2026-04-27T16:20",
    "contactId": 3,
    "contact": "sample string 4",
    "propertyId": 5,
    "property": "sample string 6",
    "description": "sample string 7",
    "amount": 8.0,
    "info": "sample string 9"
  }
]

application/xml, text/xml

Sample:
<ArrayOfStatementCheckItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <StatementCheckItem>
    <TransactionId>1</TransactionId>
    <Date>2026-04-27T16:20:01.6091034+01:00</Date>
    <ContactId>3</ContactId>
    <Contact>sample string 4</Contact>
    <PropertyId>5</PropertyId>
    <Property>sample string 6</Property>
    <Description>sample string 7</Description>
    <Amount>8</Amount>
    <Info>sample string 9</Info>
  </StatementCheckItem>
  <StatementCheckItem>
    <TransactionId>1</TransactionId>
    <Date>2026-04-27T16:20:01.6091034+01:00</Date>
    <ContactId>3</ContactId>
    <Contact>sample string 4</Contact>
    <PropertyId>5</PropertyId>
    <Property>sample string 6</Property>
    <Description>sample string 7</Description>
    <Amount>8</Amount>
    <Info>sample string 9</Info>
  </StatementCheckItem>
</ArrayOfStatementCheckItem>