Yardi Billing and Payments API
Operations for managing resident transactions, charges, payments, credits, and billing data. Accessed via the ItfResidentTransactions20 web service interface.
Yardi Billing and Payments API is one of 12 APIs that Yardi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Billing and Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, and an API reference.
This API exposes 4 operations across 4 paths, and defines 7 schemas. It is described by OpenAPI 3.1.0, at version 20.0.
Requests are made against a single base URL, https://{server}.yardi.com/{clientUrl}/webservices.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Yardi Billing and Payments API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (soapAuth).
By default, every request must be authenticated.
soapAuth— SOAP authentication using UserName, Password, and ServerName parameters passed within the SOAP request body. Credentials are provided by the Yardi Standard Int…
Paths & Operations 4
Across 4 paths, the API surfaces 4 operations — 4 POST. Each is listed below with its method, path, parameters, and response codes.
Operations for managing resident transactions, charges, payments, credits, and billing data. Accessed via the ItfResidentTransactions20 web service interface.
Schemas 7
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are GetBudgetDataRequest (10 properties), GetResidentTransactionsByChargeDateRequest (10 properties), GetResidentTransactionsRequest (10 properties), ImportResidentTransactionsRequest (9 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Yardi 11
Other APIs Yardi publishes across the network.