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
// @ts-nocheck

// @DataContract
export class QueryBase
{
    // @DataMember(Order=1)
    public Skip?: number;

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

    // @DataMember(Order=3)
    public OrderBy?: string;

    // @DataMember(Order=4)
    public OrderByDesc?: string;

    // @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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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"}}}