TicketUserServices

<back to all web services

DonationPayoutMarkRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequired permission:Tickets.Add
The following routes are available for this service:
POST/donations/payout/mark
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 DonationPayoutRow:
    id: Optional[int] = None
    donation_id: Optional[int] = None
    owner_id: Optional[int] = None
    owner_card_id: Optional[int] = None
    payment_method_id: Optional[str] = None
    payment_reference: Optional[str] = None
    amount: Optional[Decimal] = None
    txn_percent: Optional[Decimal] = None
    payout_amount: Optional[Decimal] = None
    mark_paid_reference: Optional[str] = None
    source: Optional[str] = None
    note: Optional[str] = None
    created_u_t_c: Optional[datetime.datetime] = None
    created_by: Optional[str] = None
    donation_paid_u_t_c: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DonationPayoutBatchResult:
    rows: Optional[List[DonationPayoutRow]] = None
    count: Optional[int] = None
    donation_amount: Optional[int] = None
    payout_amount: Optional[Decimal] = None
    payout_amount_isk: Optional[int] = None
    already_paid_count: Optional[int] = None
    replayed: Optional[bool] = None
    mark_paid_reference: Optional[str] = None
    owner_id: Optional[int] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DonationPayoutMarkRequest:
    owner_id: Optional[int] = None
    mark_paid_reference: Optional[str] = None
    cutoff_u_t_c: Optional[datetime.datetime] = None
    txn_percent_by_method: Optional[Dict[str, Decimal]] = None
    default_txn_percent: Optional[Decimal] = None
    created_by: Optional[str] = None

Python DonationPayoutMarkRequest 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.

POST /donations/payout/mark HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ownerId":0,"markPaidReference":"String","cutoffUTC":"0001-01-01T00:00:00.0000000","txnPercentByMethod":{"String":0},"defaultTxnPercent":0,"createdBy":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"rows":[{"id":0,"donationId":0,"ownerId":0,"ownerCardId":0,"paymentMethodId":"String","paymentReference":"String","amount":0,"txnPercent":0,"payoutAmount":0,"markPaidReference":"String","source":"String","note":"String","createdUTC":"0001-01-01T00:00:00.0000000","createdBy":"String","donationPaidUTC":"0001-01-01T00:00:00.0000000"}],"count":0,"donationAmount":0,"payoutAmount":0,"payoutAmountIsk":0,"alreadyPaidCount":0,"replayed":false,"markPaidReference":"String","ownerId":0,"statusCode":0,"message":"String"}