| 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.*
@ValidateRequest(Validator="IsAuthenticated")
open class PaymentLogQuery : QueryDb<PaymentLog, PaymentLogQueryResponse>(), 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.")
override var CompanyId:UUID? = 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")
open var CreatedFrom:Date? = 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")
open var CreatedTo:Date? = null
/**
* Article type (Could be Service, rebate code types, etc..
*/
@ApiMember(Description="Article type (Could be Service, rebate code types, etc..", IsRequired=true)
open var ArticleTypeId:Int? = null
/**
*
*/
@ApiMember(Description="")
open var IncludeArticleType:Boolean? = null
}
open class QueryDb<From, Into> : QueryBase()
{
}
@DataContract
open 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)
open var Skip:Int? = 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)
open var Take:Int? = 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)
open var OrderBy:String? = 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)
open var OrderByDesc:String? = 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)
open var Include:String? = null
@DataMember(Order=6)
open var Fields:String? = null
@DataMember(Order=7)
open var Meta:HashMap<String,String>? = null
}
open class PaymentLog : BaseModel()
{
@References(Type=Currency::class)
open var CurrencyId:String? = null
open var CurrencyInfo:Currency? = null
@Required()
open var CompanyId:UUID? = null
open var Id:Int? = null
@Required()
open var InternalReferenceId:String? = null
@Required()
open var ArticleTypeId:Int? = null
open var PaymentReferenceId:String? = null
open var PaymentProviderId:Int? = null
open var OrderItemReferenceId:String? = null
open var Amount:Double? = null
open var VAT:BigDecimal? = null
open var AmountCredited:Double? = null
open var Comments:String? = null
@Required()
open var Created:Date? = null
@Required()
open var Updated:Date? = null
open var ModifiedDate:Date? = null
}
open class BaseModel
{
}
open class Currency : BaseModel()
{
@Required()
open var Name:String? = null
@Required()
open var CurrencySign:String? = null
@Required()
open var Active:Boolean? = null
open var ModifiedDate:Date? = null
@Required()
open var Id:String? = null
}
open class PaymentLogQueryResponse
{
/**
* The payment log id
*/
@ApiMember(Description="The payment log id")
open var Id:Int? = 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.")
open var InternalReference:Int? = null
/**
* The payment reference id
*/
@ApiMember(Description="The payment reference id")
open var PaymentReferenceId:String? = null
/**
* The payment order item reference id
*/
@ApiMember(Description="The payment order item reference id")
open var OrderItemReferenceId:String? = null
/**
* The payment reference id
*/
@ApiMember(Description="The payment reference id")
open var PaymentProviderId:Int? = null
/**
* The payment amount
*/
@ApiMember(Description="The payment amount")
open var Amount:Double? = null
/**
* The article type
*/
@ApiMember(Description="The article type")
open var ArticleType:ArticleType? = null
/**
* The payment VAT in percent
*/
@ApiMember(Description="The payment VAT in percent")
open var VAT:BigDecimal? = null
/**
* The payment amount that is credited
*/
@ApiMember(Description="The payment amount that is credited")
open var AmountCredited:Double? = null
/**
* The payment currency id
*/
@ApiMember(Description="The payment currency id")
open var CurrencyId:String? = null
/**
* The payment currency info
*/
@ApiMember(Description="The payment currency info")
open var CurrencyInfo:CurrencyInfoResponse? = null
/**
* Comments that could be added to the event log item
*/
@ApiMember(Description="Comments that could be added to the event log item")
open var Comments:String? = null
/**
* The date when the payment items was created
*/
@ApiMember(Description="The date when the payment items was created")
open var Created:Date? = null
/**
* The date when the payment items were updated.
*/
@ApiMember(Description="The date when the payment items were updated.")
open var Updated:Date? = null
}
open class ArticleType : BaseModel()
{
open var ArticleTypeId:Int? = null
@Required()
open var ArticleTypeName:String? = null
open var ArticleTypeDescription:String? = null
}
open class CurrencyInfoResponse
{
/**
* The currency id
*/
@ApiMember(Description="The currency id")
open var Id:String? = null
/**
* The currency id
*/
@ApiMember(Description="The currency id")
open var Name:String? = null
/**
* The currency id
*/
@ApiMember(Description="The currency id")
open var CurrencySign:String? = null
}
@DataContract
open class QueryResponse<T>
{
@DataMember(Order=1)
open var Offset:Int? = null
@DataMember(Order=2)
open var Total:Int? = null
@DataMember(Order=3)
open var Results:ArrayList<AccessKeyTypeResponse>? = null
@DataMember(Order=4)
open var Meta:HashMap<String,String>? = null
@DataMember(Order=5)
open var ResponseStatus:ResponseStatus? = null
}
open class AccessKeyTypeResponse
{
open var Id:Int? = null
open var KeyType:String? = null
open var Description:String? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}