BokaMera.API.Host

<back to all web services

PaymentLogQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
GET/articles/paymentsQuery payment logsQuery payment logs

// @DataContract
export class QueryBase
{
    /** @description 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 Skip?: number;

    /** @description 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 Take?: number;

    /** @description 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 OrderBy: string;

    /** @description 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 OrderByDesc: string;

    /** @description 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 Include: string;

    // @DataMember(Order=6)
    public Fields: string;

    // @DataMember(Order=7)
    public Meta: { [index:string]: string; };

    public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}

export class QueryDb<From, Into> extends QueryBase
{

    public constructor(init?: Partial<QueryDb<From, Into>>) { super(init); (Object as any).assign(this, init); }
}

export class BaseModel
{

    public constructor(init?: Partial<BaseModel>) { (Object as any).assign(this, init); }
}

export class ArticleType extends BaseModel
{
    public ArticleTypeId: number;
    // @Required()
    public ArticleTypeName: string;

    public ArticleTypeDescription: string;

    public constructor(init?: Partial<ArticleType>) { super(init); (Object as any).assign(this, init); }
}

export class CurrencyInfoResponse
{
    /** @description The currency id */
    // @ApiMember(Description="The currency id")
    public Id: string;

    /** @description The currency id */
    // @ApiMember(Description="The currency id")
    public Name: string;

    /** @description The currency id */
    // @ApiMember(Description="The currency id")
    public CurrencySign: string;

    public constructor(init?: Partial<CurrencyInfoResponse>) { (Object as any).assign(this, init); }
}

export class PaymentLogQueryResponse
{
    /** @description The payment log id */
    // @ApiMember(Description="The payment log id")
    public Id: number;

    /** @description 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 InternalReference: number;

    /** @description The payment reference id */
    // @ApiMember(Description="The payment reference id")
    public PaymentReferenceId: string;

    /** @description The payment order item reference id */
    // @ApiMember(Description="The payment order item reference id")
    public OrderItemReferenceId: string;

    /** @description The payment reference id */
    // @ApiMember(Description="The payment reference id")
    public PaymentProviderId?: number;

    /** @description The payment amount */
    // @ApiMember(Description="The payment amount")
    public Amount: number;

    /** @description The article type */
    // @ApiMember(Description="The article type")
    public ArticleType: ArticleType;

    /** @description The payment VAT in percent */
    // @ApiMember(Description="The payment VAT in percent")
    public VAT: number;

    /** @description The payment amount that is credited */
    // @ApiMember(Description="The payment amount that is credited")
    public AmountCredited: number;

    /** @description The payment currency id */
    // @ApiMember(Description="The payment currency id")
    public CurrencyId: string;

    /** @description The payment currency info */
    // @ApiMember(Description="The payment currency info")
    public CurrencyInfo: CurrencyInfoResponse;

    /** @description Comments that could be added to the event log item */
    // @ApiMember(Description="Comments that could be added to the event log item")
    public Comments: string;

    /** @description The date when the payment items was created */
    // @ApiMember(Description="The date when the payment items was created")
    public Created: string;

    /** @description The date when the payment items were updated. */
    // @ApiMember(Description="The date when the payment items were updated.")
    public Updated: string;

    public constructor(init?: Partial<PaymentLogQueryResponse>) { (Object as any).assign(this, init); }
}

export class Currency extends BaseModel
{
    // @Required()
    public Name: string;

    // @Required()
    public CurrencySign: string;

    // @Required()
    public Active: boolean;

    public ModifiedDate?: string;
    // @Required()
    public Id: string;

    public constructor(init?: Partial<Currency>) { super(init); (Object as any).assign(this, init); }
}

export class PaymentLog extends BaseModel
{
    // @References("typeof(BokaMera.API.ServiceModel.Db.Currency)")
    public CurrencyId: string;

    public CurrencyInfo: Currency;
    // @Required()
    public CompanyId: string;

    public Id: number;
    // @Required()
    public InternalReferenceId: string;

    // @Required()
    public ArticleTypeId: number;

    public PaymentReferenceId: string;
    public PaymentProviderId?: number;
    public OrderItemReferenceId: string;
    public Amount?: number;
    public VAT?: number;
    public AmountCredited?: number;
    public Comments: string;
    // @Required()
    public Created: string;

    // @Required()
    public Updated: string;

    public ModifiedDate?: string;

    public constructor(init?: Partial<PaymentLog>) { super(init); (Object as any).assign(this, init); }
}

// @ValidateRequest(Validator="IsAuthenticated")
export class PaymentLogQuery extends QueryDb<PaymentLog, PaymentLogQueryResponse> implements ICompany
{
    /** @description 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 CompanyId?: string;

    /** @description 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 CreatedFrom?: string;

    /** @description 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 CreatedTo?: string;

    /** @description Article type (Could be Service, rebate code types, etc.. */
    // @ApiMember(Description="Article type (Could be Service, rebate code types, etc..", IsRequired=true)
    public ArticleTypeId: number;

    /** @description  */
    // @ApiMember(Description="")
    public IncludeArticleType: boolean;

    public constructor(init?: Partial<PaymentLogQuery>) { super(init); (Object as any).assign(this, init); }
}

export class AccessKeyTypeResponse
{
    public Id: number;
    public KeyType: string;
    public Description: string;

    public constructor(init?: Partial<AccessKeyTypeResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class QueryResponse<T>
{
    // @DataMember(Order=1)
    public Offset: number;

    // @DataMember(Order=2)
    public Total: number;

    // @DataMember(Order=3)
    public Results: AccessKeyTypeResponse[];

    // @DataMember(Order=4)
    public Meta: { [index:string]: string; };

    // @DataMember(Order=5)
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<QueryResponse<T>>) { (Object as any).assign(this, init); }
}

TypeScript PaymentLogQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>