Requires the role: | manager |
GET | /payments |
---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class SearchAllPaymentsRequest extends SearchOperationTenanted<SearchAllPaymentsResponse>
{
public String status = null;
public String getStatus() { return status; }
public SearchAllPaymentsRequest setStatus(String value) { this.status = value; return this; }
}
public static class SearchOperationTenanted<TResponse> extends SearchOperationUnTenanted<TResponse> implements ITenantedRequest
{
public String organisationId = null;
public String getOrganisationId() { return organisationId; }
public SearchOperationTenanted<TResponse> setOrganisationId(String value) { this.organisationId = value; return this; }
}
public static class SearchOperationUnTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements IHasSearchOptions
{
public String distinct = null;
public Integer limit = null;
public Integer offset = null;
public String sort = null;
public String filter = null;
public String search = null;
public String getDistinct() { return distinct; }
public SearchOperationUnTenanted<TResponse> setDistinct(String value) { this.distinct = value; return this; }
public Integer getLimit() { return limit; }
public SearchOperationUnTenanted<TResponse> setLimit(Integer value) { this.limit = value; return this; }
public Integer getOffset() { return offset; }
public SearchOperationUnTenanted<TResponse> setOffset(Integer value) { this.offset = value; return this; }
public String getSort() { return sort; }
public SearchOperationUnTenanted<TResponse> setSort(String value) { this.sort = value; return this; }
public String getFilter() { return filter; }
public SearchOperationUnTenanted<TResponse> setFilter(String value) { this.filter = value; return this; }
public String getSearch() { return search; }
public SearchOperationUnTenanted<TResponse> setSearch(String value) { this.search = value; return this; }
}
public static class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
{
public String embed = null;
public String getEmbed() { return embed; }
public GetOperationUnTenanted<TResponse> setEmbed(String value) { this.embed = value; return this; }
}
public static class SearchAllPaymentsResponse extends SearchOperationResponse
{
public ResponseStatus responseStatus = null;
public ArrayList<SearchAllPayment> payments = null;
public ResponseStatus getResponseStatus() { return responseStatus; }
public SearchAllPaymentsResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
public ArrayList<SearchAllPayment> getPayments() { return payments; }
public SearchAllPaymentsResponse setPayments(ArrayList<SearchAllPayment> value) { this.payments = value; return this; }
}
public static class SearchOperationResponse
{
public SearchMetadata metadata = null;
public SearchMetadata getMetadata() { return metadata; }
public SearchOperationResponse setMetadata(SearchMetadata value) { this.metadata = value; return this; }
}
public static class SearchMetadata
{
public Integer total = null;
public Integer limit = null;
public Integer offset = null;
public Sorting sort = null;
public Filtering filter = null;
public Integer getTotal() { return total; }
public SearchMetadata setTotal(Integer value) { this.total = value; return this; }
public Integer getLimit() { return limit; }
public SearchMetadata setLimit(Integer value) { this.limit = value; return this; }
public Integer getOffset() { return offset; }
public SearchMetadata setOffset(Integer value) { this.offset = value; return this; }
public Sorting getSort() { return sort; }
public SearchMetadata setSort(Sorting value) { this.sort = value; return this; }
public Filtering getFilter() { return filter; }
public SearchMetadata setFilter(Filtering value) { this.filter = value; return this; }
}
public static class Sorting
{
public String by = null;
public SortDirection direction = null;
public String getBy() { return by; }
public Sorting setBy(String value) { this.by = value; return this; }
public SortDirection getDirection() { return direction; }
public Sorting setDirection(SortDirection value) { this.direction = value; return this; }
}
public static enum SortDirection
{
Ascending,
Descending;
}
public static class Filtering
{
public ArrayList<String> fields = null;
public String search = null;
public ArrayList<String> getFields() { return fields; }
public Filtering setFields(ArrayList<String> value) { this.fields = value; return this; }
public String getSearch() { return search; }
public Filtering setSearch(String value) { this.search = value; return this; }
}
public static class SearchAllPayment implements IIdentifiableResource
{
public BigDecimal amount = null;
public String budgetCategory = null;
public String status = null;
public String customerFirstName = null;
public String customerLastName = null;
public BankAccount toAccount = null;
public String id = null;
public BigDecimal getAmount() { return amount; }
public SearchAllPayment setAmount(BigDecimal value) { this.amount = value; return this; }
public String getBudgetCategory() { return budgetCategory; }
public SearchAllPayment setBudgetCategory(String value) { this.budgetCategory = value; return this; }
public String getStatus() { return status; }
public SearchAllPayment setStatus(String value) { this.status = value; return this; }
public String getCustomerFirstName() { return customerFirstName; }
public SearchAllPayment setCustomerFirstName(String value) { this.customerFirstName = value; return this; }
public String getCustomerLastName() { return customerLastName; }
public SearchAllPayment setCustomerLastName(String value) { this.customerLastName = value; return this; }
public BankAccount getToAccount() { return toAccount; }
public SearchAllPayment setToAccount(BankAccount value) { this.toAccount = value; return this; }
public String getId() { return id; }
public SearchAllPayment setId(String value) { this.id = value; return this; }
}
public static class BankAccount
{
public String bsbNumber = null;
public String accountNumber = null;
public String getBsbNumber() { return bsbNumber; }
public BankAccount setBsbNumber(String value) { this.bsbNumber = value; return this; }
public String getAccountNumber() { return accountNumber; }
public BankAccount setAccountNumber(String value) { this.accountNumber = value; return this; }
}
}
Java SearchAllPaymentsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <SearchAllPaymentsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Payments"> <Metadata xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations"> <d2p1:Filter> <d2p1:Fields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>String</d4p1:string> </d2p1:Fields> <d2p1:Search>String</d2p1:Search> </d2p1:Filter> <d2p1:Limit>0</d2p1:Limit> <d2p1:Offset>0</d2p1:Offset> <d2p1:Sort> <d2p1:By>String</d2p1:By> <d2p1:Direction>Ascending</d2p1:Direction> </d2p1:Sort> <d2p1:Total>0</d2p1:Total> </Metadata> <Payments xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources"> <d2p1:SearchAllPayment> <d2p1:Amount>0</d2p1:Amount> <d2p1:BudgetCategory>String</d2p1:BudgetCategory> <d2p1:CustomerFirstName>String</d2p1:CustomerFirstName> <d2p1:CustomerLastName>String</d2p1:CustomerLastName> <d2p1:Id>String</d2p1:Id> <d2p1:Status>String</d2p1:Status> <d2p1:ToAccount> <d2p1:AccountNumber>String</d2p1:AccountNumber> <d2p1:BsbNumber>String</d2p1:BsbNumber> </d2p1:ToAccount> </d2p1:SearchAllPayment> </Payments> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> </SearchAllPaymentsResponse>