Billiecart API

SearchAllPaymentsRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
GET	/payments

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class SearchAllPaymentsRequest : SearchOperationTenanted<SearchAllPaymentsResponse>()
{
    var status:String? = null
}

open class SearchOperationTenanted<TResponse> : SearchOperationUnTenanted<TResponse>(), ITenantedRequest
{
    var organisationId:String? = null
}

open class SearchOperationUnTenanted<TResponse> : GetOperationUnTenanted<TResponse>(), IHasSearchOptions
{
    var distinct:String? = null
    var limit:Int? = null
    var offset:Int? = null
    var sort:String? = null
    var filter:String? = null
    var search:String? = null
}

open class GetOperationUnTenanted<TResponse> : IHasGetOptions, IGet
{
    var embed:String? = null
}

open class SearchAllPaymentsResponse : SearchOperationResponse()
{
    var responseStatus:ResponseStatus? = null
    var payments:ArrayList<SearchAllPayment> = ArrayList<SearchAllPayment>()
}

open class SearchOperationResponse
{
    var metadata:SearchMetadata? = null
}

open class SearchMetadata
{
    var total:Int? = null
    var limit:Int? = null
    var offset:Int? = null
    var sort:Sorting? = null
    var filter:Filtering? = null
}

open class Sorting
{
    @SerializedName("by") var By:String? = null
    var direction:SortDirection? = null
}

enum class SortDirection
{
    Ascending,
    Descending,
}

open class Filtering
{
    var fields:ArrayList<String> = ArrayList<String>()
    var search:String? = null
}

open class SearchAllPayment : IIdentifiableResource
{
    var amount:BigDecimal? = null
    var budgetCategory:String? = null
    var status:String? = null
    var customerFirstName:String? = null
    var customerLastName:String? = null
    var toAccount:BankAccount? = null
    var id:String? = null
}

open class BankAccount
{
    var bsbNumber:String? = null
    var accountNumber:String? = null
}

Kotlin SearchAllPaymentsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /payments HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"payments":[{"amount":0,"budgetCategory":"String","status":"String","customerFirstName":"String","customerLastName":"String","toAccount":{"bsbNumber":"String","accountNumber":"String"},"id":"String"}],"metadata":{"total":0,"limit":0,"offset":0,"sort":{"by":"String","direction":"Ascending"},"filter":{"fields":["String"],"search":"String"}}}