TicketUserServices

<back to all web services

WeeklyPayoutPreviewRequest

Requires Authentication
Requires any of the roles:Admin, Admin
The following routes are available for this service:
POST/payouts/weekly/preview
GET POST/payouts/weekly/sheet
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 WeeklyPayoutPreviewRow:
    event_id: Optional[int] = None
    event_name: Optional[str] = None
    time_of_event: Optional[datetime.datetime] = None
    deild: Optional[str] = None
    event_owner_name: Optional[str] = None
    event_owner_id: Optional[int] = None
    team_number: Optional[str] = None
    kennitala: Optional[str] = None
    bank_account: Optional[str] = None
    bank_gender: Optional[str] = None
    gross_amount: Optional[int] = None
    amount: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WeeklyPayoutMissingBank:
    event_owner_name: Optional[str] = None
    event_owner_id: Optional[int] = None
    team_number: Optional[str] = None
    event_id: Optional[int] = None
    event_name: Optional[str] = None
    time_of_event: Optional[datetime.datetime] = None
    deild: Optional[str] = None
    amount: Optional[int] = None
    reason: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WeeklyPayoutPreviewResult:
    run_date: Optional[datetime.datetime] = None
    window_from_inclusive: Optional[datetime.datetime] = None
    window_to_inclusive: Optional[datetime.datetime] = None
    sheet_title: Optional[str] = None
    total_amount: Optional[int] = None
    row_count: Optional[int] = None
    rows: Optional[List[WeeklyPayoutPreviewRow]] = None
    missing_bank_info: Optional[List[WeeklyPayoutMissingBank]] = None
    skipped: Optional[List[WeeklyPayoutMissingBank]] = None
    sheet_csv: Optional[str] = None
    missing_bank_csv: Optional[str] = None
    si080_preview: Optional[str] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WeeklyPayoutPreviewRequest:
    as_of: Optional[datetime.datetime] = None
    from_: Optional[datetime.datetime] = field(metadata=config(field_name='from'), default=None)
    to: Optional[datetime.datetime] = None

Python WeeklyPayoutPreviewRequest 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 /payouts/weekly/preview HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"asOf":"0001-01-01T00:00:00.0000000","from":"0001-01-01T00:00:00.0000000","to":"0001-01-01T00:00:00.0000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"runDate":"0001-01-01T00:00:00.0000000","windowFromInclusive":"0001-01-01T00:00:00.0000000","windowToInclusive":"0001-01-01T00:00:00.0000000","sheetTitle":"String","totalAmount":0,"rowCount":0,"rows":[{"eventId":0,"eventName":"String","timeOfEvent":"0001-01-01T00:00:00.0000000","deild":"String","eventOwnerName":"String","eventOwnerId":0,"teamNumber":"String","kennitala":"String","bankAccount":"String","bankGender":"String","grossAmount":0,"amount":0}],"missingBankInfo":[{"eventOwnerName":"String","eventOwnerId":0,"teamNumber":"String","eventId":0,"eventName":"String","timeOfEvent":"0001-01-01T00:00:00.0000000","deild":"String","amount":0,"reason":"String"}],"skipped":[{"eventOwnerName":"String","eventOwnerId":0,"teamNumber":"String","eventId":0,"eventName":"String","timeOfEvent":"0001-01-01T00:00:00.0000000","deild":"String","amount":0,"reason":"String"}],"sheetCsv":"String","missingBankCsv":"String","si080Preview":"String","statusCode":0,"message":"String"}