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

POST /payouts/weekly/preview HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<WeeklyPayoutPreviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <AsOf>0001-01-01T00:00:00</AsOf>
  <From>0001-01-01T00:00:00</From>
  <To>0001-01-01T00:00:00</To>
</WeeklyPayoutPreviewRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WeeklyPayoutPreviewResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Message>String</Message>
  <MissingBankCsv>String</MissingBankCsv>
  <MissingBankInfo>
    <WeeklyPayoutMissingBank>
      <Amount>0</Amount>
      <Deild>String</Deild>
      <EventId>0</EventId>
      <EventName>String</EventName>
      <EventOwnerId>0</EventOwnerId>
      <EventOwnerName>String</EventOwnerName>
      <Reason>String</Reason>
      <TeamNumber>String</TeamNumber>
      <TimeOfEvent>0001-01-01T00:00:00</TimeOfEvent>
    </WeeklyPayoutMissingBank>
  </MissingBankInfo>
  <RowCount>0</RowCount>
  <Rows>
    <WeeklyPayoutPreviewRow>
      <Amount>0</Amount>
      <BankAccount>String</BankAccount>
      <BankGender>String</BankGender>
      <Deild>String</Deild>
      <EventId>0</EventId>
      <EventName>String</EventName>
      <EventOwnerId>0</EventOwnerId>
      <EventOwnerName>String</EventOwnerName>
      <GrossAmount>0</GrossAmount>
      <Kennitala>String</Kennitala>
      <TeamNumber>String</TeamNumber>
      <TimeOfEvent>0001-01-01T00:00:00</TimeOfEvent>
    </WeeklyPayoutPreviewRow>
  </Rows>
  <RunDate>0001-01-01T00:00:00</RunDate>
  <SheetCsv>String</SheetCsv>
  <SheetTitle>String</SheetTitle>
  <Si080Preview>String</Si080Preview>
  <Skipped>
    <WeeklyPayoutMissingBank>
      <Amount>0</Amount>
      <Deild>String</Deild>
      <EventId>0</EventId>
      <EventName>String</EventName>
      <EventOwnerId>0</EventOwnerId>
      <EventOwnerName>String</EventOwnerName>
      <Reason>String</Reason>
      <TeamNumber>String</TeamNumber>
      <TimeOfEvent>0001-01-01T00:00:00</TimeOfEvent>
    </WeeklyPayoutMissingBank>
  </Skipped>
  <StatusCode>0</StatusCode>
  <TotalAmount>0</TotalAmount>
  <WindowFromInclusive>0001-01-01T00:00:00</WindowFromInclusive>
  <WindowToInclusive>0001-01-01T00:00:00</WindowToInclusive>
</WeeklyPayoutPreviewResult>