NOTE: Based on customer feedback regarding confusing functionality, the AI Search feature has been disabled. The excellent Keyword search continues to function normally. The Aspire team strives to optimizes the platform search tools to provide the best customer experience possible.

/Payments

  • Published on Aug 26, 2025
  • 1 minute(s) read
Prev Next
Get
/Payments
Security
HTTP
Type bearer

Bearer Authorization Token

Query parameters
$select
string
$filter
string
$expand
string
$orderby
string
$skip
string
$top
string
$pageNumber
string
$limit
string
api-version
string
Responses
200
Array of object
object
PaymentID
integer (int32)
CompanyID
integer (int32) | null
CompanyName
string | null
Min length0
Max length100
ContactID
integer (int32) | null
ContactName
string | null
Min length0
Max length101
BranchID
integer (int32) | null
BranchName
string | null
Min length0
Max length50
BankDepositID
integer (int32) | null
PaymentType
string | null
Min length0
Max length20
PaymentReference
string | null
Min length0
Max length50
PaymentAmount
number (decimal) | null
PaymentDate
string (date-time) | null
CreatedDateTime
string (date-time) | null
CreatedByUserID
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
PaymentNote
string | null
Min length0
Max length2147483647
PaymentCategoryID
integer (int32) | null
PaymentCategoryName
string | null
Min length0
Max length50
CreditMemoNumber
integer (int32) | null
PropertyID
integer (int32) | null
OpportunityID
integer (int32) | null
DivisionID
integer (int32) | null
DivisionName
string | null
Min length0
Max length50
SaleAmount
number (decimal) | null
TaxJurisdictionID
integer (int32) | null
TaxJurisdictionName
string | null
Min length0
Max length50
TaxAmount
number (decimal) | null
TaxableAmount
number (decimal) | null
LastModifiedByUserID
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedDateTime
string (date-time) | null
ElectronicPaymentID
integer (int32) | null
BillingAddressID
integer (int32) | null
EmailStatus
string | null
Min length0
Max length20
IsExpense
boolean
PaymentAllocations
Array of object (AspireCloud.Domain.Tenant.Payments.ODataModel.PaymentAllocation) | null
object
PaymentAllocationID
integer (int32)
InvoiceID
integer (int32) | null
Amount
number (double) | null
CreatedByUserID
integer (int32) | null
CreatedByUserName
string | null
CreatedDateTime
string (date-time) | null
InvoiceNumber
integer (int32) | null