TicketUserServices

GiftCardLedgerRequest

**Requires Authentication**
Requires any of the roles:	Admin, TeamAdmin	Requires the permission:	ReadData

The following routes are available for this service:
GET	/GiftCard/Ledger/{GiftCardId}

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GiftCardSummary:
    id: Optional[int] = None
    gift_card_type_id: Optional[int] = None
    code_last4: Optional[str] = None
    scope: Optional[str] = None
    scope_owner_id: Optional[int] = None
    currency: Optional[str] = None
    initial_value_minor: Optional[int] = None
    current_balance_minor: Optional[int] = None
    status: Optional[str] = None
    activated_at: Optional[datetime.datetime] = None
    expires_at: Optional[datetime.datetime] = None
    created_at: Optional[datetime.datetime] = None
    buyer_name: Optional[str] = None
    buyer_email: Optional[str] = None
    buyer_phone: Optional[str] = None
    payment_id: Optional[str] = None
    payment_method_id: Optional[str] = None
    purchase_payment_reference: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GiftCardTransaction:
    id: Optional[int] = None
    gift_card_id: Optional[int] = None
    kind: Optional[str] = None
    amount_minor: Optional[int] = None
    status: Optional[str] = None
    hold_expires_at: Optional[datetime.datetime] = None
    related_hold_id: Optional[int] = None
    order_payment_reference: Optional[str] = None
    event_id: Optional[int] = None
    owner_id: Optional[int] = None
    idempotency_key: Optional[str] = None
    created_at: Optional[datetime.datetime] = None
    note: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GiftCardLedgerResult:
    card: Optional[GiftCardSummary] = None
    transactions: Optional[List[GiftCardTransaction]] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GiftCardLedgerRequest:
    gift_card_id: Optional[int] = None

Python GiftCardLedgerRequest DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /GiftCard/Ledger/{GiftCardId} HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"card":{"id":0,"giftCardTypeId":0,"codeLast4":"String","scope":"String","scopeOwnerId":0,"currency":"String","initialValueMinor":0,"currentBalanceMinor":0,"status":"String","activatedAt":"0001-01-01T00:00:00.0000000","expiresAt":"0001-01-01T00:00:00.0000000","createdAt":"0001-01-01T00:00:00.0000000","buyerName":"String","buyerEmail":"String","buyerPhone":"String","paymentId":"String","paymentMethodId":"String","purchasePaymentReference":"String"},"transactions":[{"id":0,"giftCardId":0,"kind":"String","amountMinor":0,"status":"String","holdExpiresAt":"0001-01-01T00:00:00.0000000","relatedHoldId":0,"orderPaymentReference":"String","eventId":0,"ownerId":0,"idempotencyKey":"String","createdAt":"0001-01-01T00:00:00.0000000","note":"String"}],"statusCode":0,"message":"String"}