| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| GET | /articles/payments | Query payment logs | Query payment logs |
|---|
namespace BokaMera.API.ServiceModel.Db
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type BaseModel() =
class end
[<AllowNullLiteral>]
type ArticleType() =
inherit BaseModel()
member val ArticleTypeId:Int32 = new Int32() with get,set
[<Required>]
member val ArticleTypeName:String = null with get,set
member val ArticleTypeDescription:String = null with get,set
[<AllowNullLiteral>]
type CurrencyInfoResponse() =
///<summary>
///The currency id
///</summary>
[<ApiMember(Description="The currency id")>]
member val Id:String = null with get,set
///<summary>
///The currency id
///</summary>
[<ApiMember(Description="The currency id")>]
member val Name:String = null with get,set
///<summary>
///The currency id
///</summary>
[<ApiMember(Description="The currency id")>]
member val CurrencySign:String = null with get,set
[<AllowNullLiteral>]
type PaymentLogQueryResponse() =
///<summary>
///The payment log id
///</summary>
[<ApiMember(Description="The payment log id")>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///The internal reference id, could be reference to a booking, rebate code, gift card etc.
///</summary>
[<ApiMember(Description="The internal reference id, could be reference to a booking, rebate code, gift card etc.")>]
member val InternalReference:Int32 = new Int32() with get,set
///<summary>
///The payment reference id
///</summary>
[<ApiMember(Description="The payment reference id")>]
member val PaymentReferenceId:String = null with get,set
///<summary>
///The payment order item reference id
///</summary>
[<ApiMember(Description="The payment order item reference id")>]
member val OrderItemReferenceId:String = null with get,set
///<summary>
///The payment reference id
///</summary>
[<ApiMember(Description="The payment reference id")>]
member val PaymentProviderId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///The payment amount
///</summary>
[<ApiMember(Description="The payment amount")>]
member val Amount:Double = new Double() with get,set
///<summary>
///The article type
///</summary>
[<ApiMember(Description="The article type")>]
member val ArticleType:ArticleType = null with get,set
///<summary>
///The payment VAT in percent
///</summary>
[<ApiMember(Description="The payment VAT in percent")>]
member val VAT:Decimal = new Decimal() with get,set
///<summary>
///The payment amount that is credited
///</summary>
[<ApiMember(Description="The payment amount that is credited")>]
member val AmountCredited:Double = new Double() with get,set
///<summary>
///The payment currency id
///</summary>
[<ApiMember(Description="The payment currency id")>]
member val CurrencyId:String = null with get,set
///<summary>
///The payment currency info
///</summary>
[<ApiMember(Description="The payment currency info")>]
member val CurrencyInfo:CurrencyInfoResponse = null with get,set
///<summary>
///Comments that could be added to the event log item
///</summary>
[<ApiMember(Description="Comments that could be added to the event log item")>]
member val Comments:String = null with get,set
///<summary>
///The date when the payment items was created
///</summary>
[<ApiMember(Description="The date when the payment items was created")>]
member val Created:DateTime = new DateTime() with get,set
///<summary>
///The date when the payment items were updated.
///</summary>
[<ApiMember(Description="The date when the payment items were updated.")>]
member val Updated:DateTime = new DateTime() with get,set
[<AllowNullLiteral>]
type Currency() =
inherit BaseModel()
[<Required>]
member val Name:String = null with get,set
[<Required>]
member val CurrencySign:String = null with get,set
[<Required>]
member val Active:Boolean = new Boolean() with get,set
member val ModifiedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
[<Required>]
member val Id:String = null with get,set
[<AllowNullLiteral>]
type PaymentLog() =
inherit BaseModel()
[<References(typeof<Currency>)>]
member val CurrencyId:String = null with get,set
member val CurrencyInfo:Currency = null with get,set
[<Required>]
member val CompanyId:Guid = new Guid() with get,set
member val Id:Int32 = new Int32() with get,set
[<Required>]
member val InternalReferenceId:String = null with get,set
[<Required>]
member val ArticleTypeId:Int32 = new Int32() with get,set
member val PaymentReferenceId:String = null with get,set
member val PaymentProviderId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val OrderItemReferenceId:String = null with get,set
member val Amount:Nullable<Double> = new Nullable<Double>() with get,set
member val VAT:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val AmountCredited:Nullable<Double> = new Nullable<Double>() with get,set
member val Comments:String = null with get,set
[<Required>]
member val Created:DateTime = new DateTime() with get,set
[<Required>]
member val Updated:DateTime = new DateTime() with get,set
member val ModifiedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type QueryBase() =
///<summary>
///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>
///</summary>
[<DataMember(Order=1)>]
member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///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>
///</summary>
[<DataMember(Order=2)>]
member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///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>
///</summary>
[<DataMember(Order=3)>]
member val OrderBy:String = null with get,set
///<summary>
///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>
///</summary>
[<DataMember(Order=4)>]
member val OrderByDesc:String = null with get,set
///<summary>
///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>
///</summary>
[<DataMember(Order=5)>]
member val Include:String = null with get,set
[<DataMember(Order=6)>]
member val Fields:String = null with get,set
[<DataMember(Order=7)>]
member val Meta:Dictionary<String, String> = null with get,set
[<AllowNullLiteral>]
type QueryDb<From, Into>() =
inherit QueryBase()
[<ValidateRequest(Validator="IsAuthenticated")>]
[<AllowNullLiteral>]
type PaymentLogQuery() =
inherit QueryDb<PaymentLog, PaymentLogQueryResponse>()
///<summary>
///The company id, if empty will use the company id for the user you are logged in with.
///</summary>
[<ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")>]
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///Start of interval to query for payments when they where created. UTC+0 and parameter as defined by date-time - RFC3339
///</summary>
[<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")>]
member val CreatedFrom:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///End of interval to query for payments when they where created. UTC+0 and parameter as defined by date-time - RFC3339
///</summary>
[<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")>]
member val CreatedTo:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///Article type (Could be Service, rebate code types, etc..
///</summary>
[<ApiMember(Description="Article type (Could be Service, rebate code types, etc..", IsRequired=true)>]
member val ArticleTypeId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///
///</summary>
[<ApiMember(Description="")>]
member val IncludeArticleType:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type AccessKeyTypeResponse() =
member val Id:Int32 = new Int32() with get,set
member val KeyType:String = null with get,set
member val Description:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type QueryResponse<T>() =
[<DataMember(Order=1)>]
member val Offset:Int32 = new Int32() with get,set
[<DataMember(Order=2)>]
member val Total:Int32 = new Int32() with get,set
[<DataMember(Order=3)>]
member val Results:ResizeArray<AccessKeyTypeResponse> = null with get,set
[<DataMember(Order=4)>]
member val Meta:Dictionary<String, String> = null with get,set
[<DataMember(Order=5)>]
member val ResponseStatus:ResponseStatus = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}