FIBUdataServiceStack

<back to all web services

PayPalListeRequest

The following routes are available for this service:
GET, POST/fibuscan/Onlinehandel/PayPalListe
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 TransactionAmount:
    currency_code: Optional[str] = None
    value: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FeeAmount:
    currency_code: Optional[str] = None
    value: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EndingBalance:
    currency_code: Optional[str] = None
    value: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AvailableBalance:
    currency_code: Optional[str] = None
    value: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TransactionInfo:
    paypal_account_id: Optional[str] = None
    transaction_id: Optional[str] = None
    transaction_event_code: Optional[str] = None
    transaction_initiation_date: datetime.datetime = datetime.datetime(1, 1, 1)
    transaction_updated_date: datetime.datetime = datetime.datetime(1, 1, 1)
    transaction_amount: Optional[TransactionAmount] = None
    fee_amount: Optional[FeeAmount] = None
    transaction_status: Optional[str] = None
    transaction_subject: Optional[str] = None
    ending_balance: Optional[EndingBalance] = None
    available_balance: Optional[AvailableBalance] = None
    invoice_id: Optional[str] = None
    custom_field: Optional[str] = None
    protection_eligibility: Optional[str] = None
    paypal_reference_id: Optional[str] = None
    paypal_reference_id_type: Optional[str] = None
    bank_reference_id: Optional[str] = None
    credit_term: Optional[str] = None
    transaction_note: Optional[str] = None
    payment_method_type: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PayerName:
    given_name: Optional[str] = None
    surname: Optional[str] = None
    alternate_full_name: Optional[str] = None
    middle_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PayerInfo:
    account_id: Optional[str] = None
    email_address: Optional[str] = None
    address_status: Optional[str] = None
    payer_status: Optional[str] = None
    payer_name: Optional[PayerName] = None
    country_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Address:
    line1: Optional[str] = None
    city: Optional[str] = None
    country_code: Optional[str] = None
    postal_code: Optional[str] = None
    address_line_1: Optional[str] = None
    admin_area_2: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ShippingInfo:
    name: Optional[str] = None
    address: Optional[Address] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ItemUnitPrice:
    currency_code: Optional[str] = None
    value: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ItemAmount:
    currency_code: Optional[str] = None
    value: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TotalItemAmount:
    currency_code: Optional[str] = None
    value: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BasicShippingAmount:
    currency_code: Optional[str] = None
    value: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ItemDetail:
    item_code: Optional[str] = None
    item_name: Optional[str] = None
    item_description: Optional[str] = None
    item_quantity: Optional[str] = None
    item_unit_price: Optional[ItemUnitPrice] = None
    item_amount: Optional[ItemAmount] = None
    total_item_amount: Optional[TotalItemAmount] = None
    basic_shipping_amount: Optional[BasicShippingAmount] = None
    invoice_number: Optional[str] = None
    tax_percentage: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CartInfo:
    item_details: Optional[List[ItemDetail]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StoreInfo:
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AuctionInfo:
    auction_site: Optional[str] = None
    auction_item_site: Optional[str] = None
    auction_buyer_id: Optional[str] = None
    auction_closing_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IncentiveInfo:
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TransactionDetail:
    transaction_info: Optional[TransactionInfo] = None
    payer_info: Optional[PayerInfo] = None
    shipping_info: Optional[ShippingInfo] = None
    cart_info: Optional[CartInfo] = None
    store_info: Optional[StoreInfo] = None
    auction_info: Optional[AuctionInfo] = None
    incentive_info: Optional[IncentiveInfo] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PayPalListeListeResponse:
    transaction_details: Optional[List[TransactionDetail]] = None
    pay_pal_json: Optional[List[str]] = None
    liste: Optional[List[List[OnlinehandelItem]]] = None
    neue_datei_i_d: Optional[int] = None


class Oem(IntEnum):
    FIBUDATA = 0
    SPECTRUM = 3


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PayPalListeRequest:
    oem: Optional[Oem] = None
    von_datum: Optional[datetime.datetime] = None
    bis_datum: Optional[datetime.datetime] = None
    bank_i_d: Optional[int] = None
    alle_neue_laden: bool = False
    pay_pal_client_i_d: Optional[str] = None
    pay_pal_secret: Optional[str] = None
    pay_pal_waehrung: Optional[str] = None
    onlinehande_datei_genieren: Optional[bool] = None

Python PayPalListeRequest 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 /fibuscan/Onlinehandel/PayPalListe HTTP/1.1 
Host: ws4.fibudata.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PayPalListeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FIBUdataServiceStack.ServiceModel.Messages">
  <AlleNeueLaden>false</AlleNeueLaden>
  <BankID>0</BankID>
  <BisDatum>0001-01-01T00:00:00</BisDatum>
  <OnlinehandeDateiGenieren>false</OnlinehandeDateiGenieren>
  <PayPalClientID>String</PayPalClientID>
  <PayPalSecret>String</PayPalSecret>
  <PayPalWaehrung>String</PayPalWaehrung>
  <VonDatum>0001-01-01T00:00:00</VonDatum>
  <oem>fibudata</oem>
</PayPalListeRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PayPalListeListeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FIBUdataServiceStack.ServiceModel.Messages">
  <Liste xmlns:d2p1="http://schemas.datacontract.org/2004/07/FIBUdataServiceStack.ServiceModel.Models">
    <d2p1:ArrayOfOnlinehandelItem>
      <d2p1:OnlinehandelItem>
        <d2p1:col_nummer>0</d2p1:col_nummer>
        <d2p1:datum>0001-01-01T00:00:00</d2p1:datum>
        <d2p1:datum_string>String</d2p1:datum_string>
        <d2p1:fehler>false</d2p1:fehler>
        <d2p1:header>String</d2p1:header>
        <d2p1:konfiguration>OrderiD</d2p1:konfiguration>
        <d2p1:original>String</d2p1:original>
        <d2p1:summenkonfiguration>false</d2p1:summenkonfiguration>
        <d2p1:value />
        <d2p1:zahl>0</d2p1:zahl>
        <d2p1:zahl_string>String</d2p1:zahl_string>
      </d2p1:OnlinehandelItem>
    </d2p1:ArrayOfOnlinehandelItem>
  </Liste>
  <NeueDateiID>0</NeueDateiID>
  <PayPalJson xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PayPalJson>
  <transaction_details xmlns:d2p1="http://schemas.datacontract.org/2004/07/FIBUdataServiceStack.ServiceModel.Common">
    <d2p1:TransactionDetail>
      <d2p1:auction_info>
        <d2p1:auction_buyer_id>String</d2p1:auction_buyer_id>
        <d2p1:auction_closing_date>0001-01-01T00:00:00</d2p1:auction_closing_date>
        <d2p1:auction_item_site>String</d2p1:auction_item_site>
        <d2p1:auction_site>String</d2p1:auction_site>
      </d2p1:auction_info>
      <d2p1:cart_info>
        <d2p1:item_details>
          <d2p1:ItemDetail>
            <d2p1:basic_shipping_amount>
              <d2p1:currency_code>String</d2p1:currency_code>
              <d2p1:value>String</d2p1:value>
            </d2p1:basic_shipping_amount>
            <d2p1:invoice_number>String</d2p1:invoice_number>
            <d2p1:item_amount>
              <d2p1:currency_code>String</d2p1:currency_code>
              <d2p1:value>String</d2p1:value>
            </d2p1:item_amount>
            <d2p1:item_code>String</d2p1:item_code>
            <d2p1:item_description>String</d2p1:item_description>
            <d2p1:item_name>String</d2p1:item_name>
            <d2p1:item_quantity>String</d2p1:item_quantity>
            <d2p1:item_unit_price>
              <d2p1:currency_code>String</d2p1:currency_code>
              <d2p1:value>String</d2p1:value>
            </d2p1:item_unit_price>
            <d2p1:tax_percentage>String</d2p1:tax_percentage>
            <d2p1:total_item_amount>
              <d2p1:currency_code>String</d2p1:currency_code>
              <d2p1:value>String</d2p1:value>
            </d2p1:total_item_amount>
          </d2p1:ItemDetail>
        </d2p1:item_details>
      </d2p1:cart_info>
      <d2p1:incentive_info />
      <d2p1:payer_info>
        <d2p1:account_id>String</d2p1:account_id>
        <d2p1:address_status>String</d2p1:address_status>
        <d2p1:country_code>String</d2p1:country_code>
        <d2p1:email_address>String</d2p1:email_address>
        <d2p1:payer_name>
          <d2p1:alternate_full_name>String</d2p1:alternate_full_name>
          <d2p1:given_name>String</d2p1:given_name>
          <d2p1:middle_name>String</d2p1:middle_name>
          <d2p1:surname>String</d2p1:surname>
        </d2p1:payer_name>
        <d2p1:payer_status>String</d2p1:payer_status>
      </d2p1:payer_info>
      <d2p1:shipping_info>
        <d2p1:address>
          <d2p1:address_line_1>String</d2p1:address_line_1>
          <d2p1:admin_area_2>String</d2p1:admin_area_2>
          <d2p1:city>String</d2p1:city>
          <d2p1:country_code>String</d2p1:country_code>
          <d2p1:line1>String</d2p1:line1>
          <d2p1:postal_code>String</d2p1:postal_code>
        </d2p1:address>
        <d2p1:name>String</d2p1:name>
      </d2p1:shipping_info>
      <d2p1:store_info />
      <d2p1:transaction_info>
        <d2p1:available_balance>
          <d2p1:currency_code>String</d2p1:currency_code>
          <d2p1:value>String</d2p1:value>
        </d2p1:available_balance>
        <d2p1:bank_reference_id>String</d2p1:bank_reference_id>
        <d2p1:credit_term>String</d2p1:credit_term>
        <d2p1:custom_field>String</d2p1:custom_field>
        <d2p1:ending_balance>
          <d2p1:currency_code>String</d2p1:currency_code>
          <d2p1:value>String</d2p1:value>
        </d2p1:ending_balance>
        <d2p1:fee_amount>
          <d2p1:currency_code>String</d2p1:currency_code>
          <d2p1:value>String</d2p1:value>
        </d2p1:fee_amount>
        <d2p1:invoice_id>String</d2p1:invoice_id>
        <d2p1:payment_method_type>String</d2p1:payment_method_type>
        <d2p1:paypal_account_id>String</d2p1:paypal_account_id>
        <d2p1:paypal_reference_id>String</d2p1:paypal_reference_id>
        <d2p1:paypal_reference_id_type>String</d2p1:paypal_reference_id_type>
        <d2p1:protection_eligibility>String</d2p1:protection_eligibility>
        <d2p1:transaction_amount>
          <d2p1:currency_code>String</d2p1:currency_code>
          <d2p1:value>String</d2p1:value>
        </d2p1:transaction_amount>
        <d2p1:transaction_event_code>String</d2p1:transaction_event_code>
        <d2p1:transaction_id>String</d2p1:transaction_id>
        <d2p1:transaction_initiation_date>0001-01-01T00:00:00</d2p1:transaction_initiation_date>
        <d2p1:transaction_note>String</d2p1:transaction_note>
        <d2p1:transaction_status>String</d2p1:transaction_status>
        <d2p1:transaction_subject>String</d2p1:transaction_subject>
        <d2p1:transaction_updated_date>0001-01-01T00:00:00</d2p1:transaction_updated_date>
      </d2p1:transaction_info>
    </d2p1:TransactionDetail>
  </transaction_details>
</PayPalListeListeResponse>