| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| GET | /articles/payments | Query payment logs | Query payment logs |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;
public class dtos
{
@ValidateRequest(Validator="IsAuthenticated")
public static class PaymentLogQuery extends QueryDb<PaymentLog, PaymentLogQueryResponse> implements ICompany
{
/**
* The company id, if empty will use the company id for the user you are logged in with.
*/
@ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
public UUID CompanyId = null;
/**
* Start of interval to query for payments when they where created. UTC+0 and parameter as defined by date-time - RFC3339
*/
@ApiMember(DataType="dateTime", Description="Start of interval to query for payments when they where created. UTC+0 and parameter as defined by date-time - RFC3339", ParameterType="query")
public Date CreatedFrom = null;
/**
* End of interval to query for payments when they where created. UTC+0 and parameter as defined by date-time - RFC3339
*/
@ApiMember(DataType="dateTime", Description="End of interval to query for payments when they where created. UTC+0 and parameter as defined by date-time - RFC3339", ParameterType="query")
public Date CreatedTo = null;
/**
* Article type (Could be Service, rebate code types, etc..
*/
@ApiMember(Description="Article type (Could be Service, rebate code types, etc..", IsRequired=true)
public Integer ArticleTypeId = null;
/**
*
*/
@ApiMember(Description="")
public Boolean IncludeArticleType = null;
public UUID getCompanyId() { return CompanyId; }
public PaymentLogQuery setCompanyId(UUID value) { this.CompanyId = value; return this; }
public Date getCreatedFrom() { return CreatedFrom; }
public PaymentLogQuery setCreatedFrom(Date value) { this.CreatedFrom = value; return this; }
public Date getCreatedTo() { return CreatedTo; }
public PaymentLogQuery setCreatedTo(Date value) { this.CreatedTo = value; return this; }
public Integer getArticleTypeId() { return ArticleTypeId; }
public PaymentLogQuery setArticleTypeId(Integer value) { this.ArticleTypeId = value; return this; }
public Boolean isIncludeArticleType() { return IncludeArticleType; }
public PaymentLogQuery setIncludeArticleType(Boolean value) { this.IncludeArticleType = value; return this; }
}
public static class QueryDb<From, Into> extends QueryBase
{
}
@DataContract
public static class QueryBase
{
/**
* Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code>
*/
@DataMember(Order=1)
public Integer Skip = null;
/**
* Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code>
*/
@DataMember(Order=2)
public Integer Take = null;
/**
* Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code>
*/
@DataMember(Order=3)
public String OrderBy = null;
/**
* Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code>
*/
@DataMember(Order=4)
public String OrderByDesc = null;
/**
* Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code>
*/
@DataMember(Order=5)
public String Include = null;
@DataMember(Order=6)
public String Fields = null;
@DataMember(Order=7)
public HashMap<String,String> Meta = null;
public Integer getSkip() { return Skip; }
public QueryBase setSkip(Integer value) { this.Skip = value; return this; }
public Integer getTake() { return Take; }
public QueryBase setTake(Integer value) { this.Take = value; return this; }
public String getOrderBy() { return OrderBy; }
public QueryBase setOrderBy(String value) { this.OrderBy = value; return this; }
public String getOrderByDesc() { return OrderByDesc; }
public QueryBase setOrderByDesc(String value) { this.OrderByDesc = value; return this; }
public String getInclude() { return Include; }
public QueryBase setInclude(String value) { this.Include = value; return this; }
public String getFields() { return Fields; }
public QueryBase setFields(String value) { this.Fields = value; return this; }
public HashMap<String,String> getMeta() { return Meta; }
public QueryBase setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
}
public static class PaymentLog extends BaseModel
{
@References(Type=Currency.class)
public String CurrencyId = null;
public Currency CurrencyInfo = null;
@Required()
public UUID CompanyId = null;
public Integer Id = null;
@Required()
public String InternalReferenceId = null;
@Required()
public Integer ArticleTypeId = null;
public String PaymentReferenceId = null;
public Integer PaymentProviderId = null;
public String OrderItemReferenceId = null;
public Double Amount = null;
public BigDecimal VAT = null;
public Double AmountCredited = null;
public String Comments = null;
@Required()
public Date Created = null;
@Required()
public Date Updated = null;
public Date ModifiedDate = null;
public String getCurrencyId() { return CurrencyId; }
public PaymentLog setCurrencyId(String value) { this.CurrencyId = value; return this; }
public Currency getCurrencyInfo() { return CurrencyInfo; }
public PaymentLog setCurrencyInfo(Currency value) { this.CurrencyInfo = value; return this; }
public UUID getCompanyId() { return CompanyId; }
public PaymentLog setCompanyId(UUID value) { this.CompanyId = value; return this; }
public Integer getId() { return Id; }
public PaymentLog setId(Integer value) { this.Id = value; return this; }
public String getInternalReferenceId() { return InternalReferenceId; }
public PaymentLog setInternalReferenceId(String value) { this.InternalReferenceId = value; return this; }
public Integer getArticleTypeId() { return ArticleTypeId; }
public PaymentLog setArticleTypeId(Integer value) { this.ArticleTypeId = value; return this; }
public String getPaymentReferenceId() { return PaymentReferenceId; }
public PaymentLog setPaymentReferenceId(String value) { this.PaymentReferenceId = value; return this; }
public Integer getPaymentProviderId() { return PaymentProviderId; }
public PaymentLog setPaymentProviderId(Integer value) { this.PaymentProviderId = value; return this; }
public String getOrderItemReferenceId() { return OrderItemReferenceId; }
public PaymentLog setOrderItemReferenceId(String value) { this.OrderItemReferenceId = value; return this; }
public Double getAmount() { return Amount; }
public PaymentLog setAmount(Double value) { this.Amount = value; return this; }
public BigDecimal getVat() { return VAT; }
public PaymentLog setVat(BigDecimal value) { this.VAT = value; return this; }
public Double getAmountCredited() { return AmountCredited; }
public PaymentLog setAmountCredited(Double value) { this.AmountCredited = value; return this; }
public String getComments() { return Comments; }
public PaymentLog setComments(String value) { this.Comments = value; return this; }
public Date getCreated() { return Created; }
public PaymentLog setCreated(Date value) { this.Created = value; return this; }
public Date getUpdated() { return Updated; }
public PaymentLog setUpdated(Date value) { this.Updated = value; return this; }
public Date getModifiedDate() { return ModifiedDate; }
public PaymentLog setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
}
public static class BaseModel
{
}
public static class Currency extends BaseModel
{
@Required()
public String Name = null;
@Required()
public String CurrencySign = null;
@Required()
public Boolean Active = null;
public Date ModifiedDate = null;
@Required()
public String Id = null;
public String getName() { return Name; }
public Currency setName(String value) { this.Name = value; return this; }
public String getCurrencySign() { return CurrencySign; }
public Currency setCurrencySign(String value) { this.CurrencySign = value; return this; }
public Boolean isActive() { return Active; }
public Currency setActive(Boolean value) { this.Active = value; return this; }
public Date getModifiedDate() { return ModifiedDate; }
public Currency setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
public String getId() { return Id; }
public Currency setId(String value) { this.Id = value; return this; }
}
public static class PaymentLogQueryResponse
{
/**
* The payment log id
*/
@ApiMember(Description="The payment log id")
public Integer Id = null;
/**
* The internal reference id, could be reference to a booking, rebate code, gift card etc.
*/
@ApiMember(Description="The internal reference id, could be reference to a booking, rebate code, gift card etc.")
public Integer InternalReference = null;
/**
* The payment reference id
*/
@ApiMember(Description="The payment reference id")
public String PaymentReferenceId = null;
/**
* The payment order item reference id
*/
@ApiMember(Description="The payment order item reference id")
public String OrderItemReferenceId = null;
/**
* The payment reference id
*/
@ApiMember(Description="The payment reference id")
public Integer PaymentProviderId = null;
/**
* The payment amount
*/
@ApiMember(Description="The payment amount")
public Double Amount = null;
/**
* The article type
*/
@ApiMember(Description="The article type")
public ArticleType ArticleType = null;
/**
* The payment VAT in percent
*/
@ApiMember(Description="The payment VAT in percent")
public BigDecimal VAT = null;
/**
* The payment amount that is credited
*/
@ApiMember(Description="The payment amount that is credited")
public Double AmountCredited = null;
/**
* The payment currency id
*/
@ApiMember(Description="The payment currency id")
public String CurrencyId = null;
/**
* The payment currency info
*/
@ApiMember(Description="The payment currency info")
public CurrencyInfoResponse CurrencyInfo = null;
/**
* Comments that could be added to the event log item
*/
@ApiMember(Description="Comments that could be added to the event log item")
public String Comments = null;
/**
* The date when the payment items was created
*/
@ApiMember(Description="The date when the payment items was created")
public Date Created = null;
/**
* The date when the payment items were updated.
*/
@ApiMember(Description="The date when the payment items were updated.")
public Date Updated = null;
public Integer getId() { return Id; }
public PaymentLogQueryResponse setId(Integer value) { this.Id = value; return this; }
public Integer getInternalReference() { return InternalReference; }
public PaymentLogQueryResponse setInternalReference(Integer value) { this.InternalReference = value; return this; }
public String getPaymentReferenceId() { return PaymentReferenceId; }
public PaymentLogQueryResponse setPaymentReferenceId(String value) { this.PaymentReferenceId = value; return this; }
public String getOrderItemReferenceId() { return OrderItemReferenceId; }
public PaymentLogQueryResponse setOrderItemReferenceId(String value) { this.OrderItemReferenceId = value; return this; }
public Integer getPaymentProviderId() { return PaymentProviderId; }
public PaymentLogQueryResponse setPaymentProviderId(Integer value) { this.PaymentProviderId = value; return this; }
public Double getAmount() { return Amount; }
public PaymentLogQueryResponse setAmount(Double value) { this.Amount = value; return this; }
public ArticleType getArticleType() { return ArticleType; }
public PaymentLogQueryResponse setArticleType(ArticleType value) { this.ArticleType = value; return this; }
public BigDecimal getVat() { return VAT; }
public PaymentLogQueryResponse setVat(BigDecimal value) { this.VAT = value; return this; }
public Double getAmountCredited() { return AmountCredited; }
public PaymentLogQueryResponse setAmountCredited(Double value) { this.AmountCredited = value; return this; }
public String getCurrencyId() { return CurrencyId; }
public PaymentLogQueryResponse setCurrencyId(String value) { this.CurrencyId = value; return this; }
public CurrencyInfoResponse getCurrencyInfo() { return CurrencyInfo; }
public PaymentLogQueryResponse setCurrencyInfo(CurrencyInfoResponse value) { this.CurrencyInfo = value; return this; }
public String getComments() { return Comments; }
public PaymentLogQueryResponse setComments(String value) { this.Comments = value; return this; }
public Date getCreated() { return Created; }
public PaymentLogQueryResponse setCreated(Date value) { this.Created = value; return this; }
public Date getUpdated() { return Updated; }
public PaymentLogQueryResponse setUpdated(Date value) { this.Updated = value; return this; }
}
public static class ArticleType extends BaseModel
{
public Integer ArticleTypeId = null;
@Required()
public String ArticleTypeName = null;
public String ArticleTypeDescription = null;
public Integer getArticleTypeId() { return ArticleTypeId; }
public ArticleType setArticleTypeId(Integer value) { this.ArticleTypeId = value; return this; }
public String getArticleTypeName() { return ArticleTypeName; }
public ArticleType setArticleTypeName(String value) { this.ArticleTypeName = value; return this; }
public String getArticleTypeDescription() { return ArticleTypeDescription; }
public ArticleType setArticleTypeDescription(String value) { this.ArticleTypeDescription = value; return this; }
}
public static class CurrencyInfoResponse
{
/**
* The currency id
*/
@ApiMember(Description="The currency id")
public String Id = null;
/**
* The currency id
*/
@ApiMember(Description="The currency id")
public String Name = null;
/**
* The currency id
*/
@ApiMember(Description="The currency id")
public String CurrencySign = null;
public String getId() { return Id; }
public CurrencyInfoResponse setId(String value) { this.Id = value; return this; }
public String getName() { return Name; }
public CurrencyInfoResponse setName(String value) { this.Name = value; return this; }
public String getCurrencySign() { return CurrencySign; }
public CurrencyInfoResponse setCurrencySign(String value) { this.CurrencySign = value; return this; }
}
@DataContract
public static class QueryResponse<T>
{
@DataMember(Order=1)
public Integer Offset = null;
@DataMember(Order=2)
public Integer Total = null;
@DataMember(Order=3)
public ArrayList<AccessKeyTypeResponse> Results = null;
@DataMember(Order=4)
public HashMap<String,String> Meta = null;
@DataMember(Order=5)
public ResponseStatus ResponseStatus = null;
public Integer getOffset() { return Offset; }
public QueryResponse<T> setOffset(Integer value) { this.Offset = value; return this; }
public Integer getTotal() { return Total; }
public QueryResponse<T> setTotal(Integer value) { this.Total = value; return this; }
public ArrayList<AccessKeyTypeResponse> getResults() { return Results; }
public QueryResponse<T> setResults(ArrayList<AccessKeyTypeResponse> value) { this.Results = value; return this; }
public HashMap<String,String> getMeta() { return Meta; }
public QueryResponse<T> setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public QueryResponse<T> setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class AccessKeyTypeResponse
{
public Integer Id = null;
public String KeyType = null;
public String Description = null;
public Integer getId() { return Id; }
public AccessKeyTypeResponse setId(Integer value) { this.Id = value; return this; }
public String getKeyType() { return KeyType; }
public AccessKeyTypeResponse setKeyType(String value) { this.KeyType = value; return this; }
public String getDescription() { return Description; }
public AccessKeyTypeResponse setDescription(String value) { this.Description = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /articles/payments HTTP/1.1 Host: api.bokamera.se Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"Id":0,"InternalReference":0,"PaymentReferenceId":"String","OrderItemReferenceId":"String","PaymentProviderId":0,"Amount":0,"ArticleType":{"ArticleTypeId":0,"ArticleTypeName":"String","ArticleTypeDescription":"String"},"VAT":0,"AmountCredited":0,"CurrencyId":"String","CurrencyInfo":{"Id":"String","Name":"String","CurrencySign":"String"},"Comments":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}