Proper Docs home page
Search...
⌘K
Support
Platform
Platform
Search...
Navigation
Payouts
The payout object
Documentation
API reference
API reference
Introduction
Authentication
Errors
Logs
Pagination
Versioning
Resources
Tenancies
Leases
Bills
Pending bills
Payments
Payouts
The payout object
GET
List payouts
Recurring bill items
One time bill items
Transactions
Products
Contacts
Rent adjustment
Categories
On this page
Attributes
Payouts
The payout object
Payouts are the result of payments and a fee to Proper. To reconcile your bank use the
bankStatement
field.
Attributes
id
string
The unique identifier for the payout
payoutReason
string
The reason for the payout. Can be either Payment or Refund
payoutDate
date
The date the payout was made
net
object
The net amount of the payout
Show child attributes
currency
string
The currency code for the net amount (e.g., “DKK”)
amount
number
The amount of the net amount (e.g., 100.00)
fees
object
The fees subtracted from the payout
Show child attributes
currency
string
The currency code for the fees amount (e.g., “DKK”)
amount
number
The amount of the fees amount (e.g., 100.00)
gross
object
The gross amount of the payout
Show child attributes
currency
string
The currency code for the gross amount (e.g., “DKK”)
amount
number
The amount of the gross amount (e.g., 100.00)
bankStatement
string
The bank statement reference for the payout
List payments
List payouts
Assistant
Responses are generated using AI and may contain mistakes.