| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| GET | /articles/payments | Query payment logs | Query payment logs |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.API.ServiceModel.Db;
namespace BokaMera.API.ServiceModel.Db
{
public partial class ArticleType
: BaseModel
{
public virtual int ArticleTypeId { get; set; }
[Required]
public virtual string ArticleTypeName { get; set; }
public virtual string ArticleTypeDescription { get; set; }
}
public partial class BaseModel
{
}
public partial class Currency
: BaseModel
{
[Required]
public virtual string Name { get; set; }
[Required]
public virtual string CurrencySign { get; set; }
[Required]
public virtual bool Active { get; set; }
public virtual DateTimeOffset? ModifiedDate { get; set; }
[Required]
public virtual string Id { get; set; }
}
public partial class PaymentLog
: BaseModel
{
[References(typeof(BokaMera.API.ServiceModel.Db.Currency))]
public virtual string CurrencyId { get; set; }
public virtual Currency CurrencyInfo { get; set; }
[Required]
public virtual Guid CompanyId { get; set; }
public virtual int Id { get; set; }
[Required]
public virtual string InternalReferenceId { get; set; }
[Required]
public virtual int ArticleTypeId { get; set; }
public virtual string PaymentReferenceId { get; set; }
public virtual int? PaymentProviderId { get; set; }
public virtual string OrderItemReferenceId { get; set; }
public virtual double? Amount { get; set; }
public virtual decimal? VAT { get; set; }
public virtual double? AmountCredited { get; set; }
public virtual string Comments { get; set; }
[Required]
public virtual DateTime Created { get; set; }
[Required]
public virtual DateTime Updated { get; set; }
public virtual DateTimeOffset? ModifiedDate { get; set; }
}
}
namespace BokaMera.API.ServiceModel.Dtos
{
public partial class AccessKeyTypeResponse
{
public virtual int Id { get; set; }
public virtual string KeyType { get; set; }
public virtual string Description { get; set; }
}
public partial class CurrencyInfoResponse
{
///<summary>
///The currency id
///</summary>
[ApiMember(Description="The currency id")]
public virtual string Id { get; set; }
///<summary>
///The currency id
///</summary>
[ApiMember(Description="The currency id")]
public virtual string Name { get; set; }
///<summary>
///The currency id
///</summary>
[ApiMember(Description="The currency id")]
public virtual string CurrencySign { get; set; }
}
[ValidateRequest("IsAuthenticated")]
public partial class PaymentLogQuery
: QueryDb<PaymentLog, PaymentLogQueryResponse>, ICompany
{
///<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.")]
public virtual Guid? CompanyId { 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")]
public virtual DateTime? CreatedFrom { 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")]
public virtual DateTime? CreatedTo { 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)]
public virtual int? ArticleTypeId { get; set; }
///<summary>
///
///</summary>
[ApiMember(Description="")]
public virtual bool IncludeArticleType { get; set; }
}
public partial class PaymentLogQueryResponse
{
///<summary>
///The payment log id
///</summary>
[ApiMember(Description="The payment log id")]
public virtual int Id { 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.")]
public virtual int InternalReference { get; set; }
///<summary>
///The payment reference id
///</summary>
[ApiMember(Description="The payment reference id")]
public virtual string PaymentReferenceId { get; set; }
///<summary>
///The payment order item reference id
///</summary>
[ApiMember(Description="The payment order item reference id")]
public virtual string OrderItemReferenceId { get; set; }
///<summary>
///The payment reference id
///</summary>
[ApiMember(Description="The payment reference id")]
public virtual int? PaymentProviderId { get; set; }
///<summary>
///The payment amount
///</summary>
[ApiMember(Description="The payment amount")]
public virtual double Amount { get; set; }
///<summary>
///The article type
///</summary>
[ApiMember(Description="The article type")]
public virtual ArticleType ArticleType { get; set; }
///<summary>
///The payment VAT in percent
///</summary>
[ApiMember(Description="The payment VAT in percent")]
public virtual decimal VAT { get; set; }
///<summary>
///The payment amount that is credited
///</summary>
[ApiMember(Description="The payment amount that is credited")]
public virtual double AmountCredited { get; set; }
///<summary>
///The payment currency id
///</summary>
[ApiMember(Description="The payment currency id")]
public virtual string CurrencyId { get; set; }
///<summary>
///The payment currency info
///</summary>
[ApiMember(Description="The payment currency info")]
public virtual CurrencyInfoResponse CurrencyInfo { 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")]
public virtual string Comments { get; set; }
///<summary>
///The date when the payment items was created
///</summary>
[ApiMember(Description="The date when the payment items was created")]
public virtual DateTime Created { get; set; }
///<summary>
///The date when the payment items were updated.
///</summary>
[ApiMember(Description="The date when the payment items were updated.")]
public virtual DateTime Updated { get; set; }
}
}
namespace ServiceStack
{
[DataContract]
public partial class 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)]
public virtual int? Skip { 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)]
public virtual int? Take { 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)]
public virtual string OrderBy { 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)]
public virtual string OrderByDesc { 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)]
public virtual string Include { get; set; }
[DataMember(Order=6)]
public virtual string Fields { get; set; }
[DataMember(Order=7)]
public virtual Dictionary<string, string> Meta { get; set; }
}
public partial class QueryDb<From, Into>
: QueryBase
{
}
[DataContract]
public partial class QueryResponse<T>
{
[DataMember(Order=1)]
public virtual int Offset { get; set; }
[DataMember(Order=2)]
public virtual int Total { get; set; }
[DataMember(Order=3)]
public virtual List<AccessKeyTypeResponse> Results { get; set; }
[DataMember(Order=4)]
public virtual Dictionary<string, string> Meta { get; set; }
[DataMember(Order=5)]
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
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 /articles/payments HTTP/1.1 Host: api.bokamera.se Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfPaymentLogQueryResponseWg5EthtI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Offset>0</Offset>
<Total>0</Total>
<Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<d2p1:PaymentLogQueryResponse>
<d2p1:Amount>0</d2p1:Amount>
<d2p1:AmountCredited>0</d2p1:AmountCredited>
<d2p1:ArticleType xmlns:d4p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db">
<d4p1:ArticleTypeDescription>String</d4p1:ArticleTypeDescription>
<d4p1:ArticleTypeId>0</d4p1:ArticleTypeId>
<d4p1:ArticleTypeName>String</d4p1:ArticleTypeName>
</d2p1:ArticleType>
<d2p1:Comments>String</d2p1:Comments>
<d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
<d2p1:CurrencyId>String</d2p1:CurrencyId>
<d2p1:CurrencyInfo>
<d2p1:CurrencySign>String</d2p1:CurrencySign>
<d2p1:Id>String</d2p1:Id>
<d2p1:Name>String</d2p1:Name>
</d2p1:CurrencyInfo>
<d2p1:Id>0</d2p1:Id>
<d2p1:InternalReference>0</d2p1:InternalReference>
<d2p1:OrderItemReferenceId>String</d2p1:OrderItemReferenceId>
<d2p1:PaymentProviderId>0</d2p1:PaymentProviderId>
<d2p1:PaymentReferenceId>String</d2p1:PaymentReferenceId>
<d2p1:Updated>0001-01-01T00:00:00</d2p1:Updated>
<d2p1:VAT>0</d2p1:VAT>
</d2p1:PaymentLogQueryResponse>
</Results>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<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>
</Meta>
</ResponseError>
</Errors>
<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>
</Meta>
</ResponseStatus>
</QueryResponseOfPaymentLogQueryResponseWg5EthtI>