anybill_base_models library
Library containing DTOs and Models used withing the anybill SDK
Classes
- AboutUsDto
- A stores about us information.
- AdditionalBoiTvaDataBaseDto
- Additional data of the BOI-TVA.
- AdditionalBoiTvaDataKeyValueDto
- KeyValue object for the additional BOI-TVA data
- AdditionalBoiTvaDataTextDto
- Text object for the additional BOI-TVA data
- AdditionalHeaderInformationDto
- Additional header information as key/value pair. Only the value will be display on the pdf receipt.
- AdditionalReceiptDto
- Additional receipt document.
- AdditionalRksvDataDto
- Additional security data of the tse that is not explicitly defined in the RksvDto.
- AdditionalTseDataDto
- Additional security data of the tse that is not explicitly defined in the TseDto.
- AddressDto
- AfterSalesCouponDto
- A coupon that the customer gets after the checkout.
- AnybillStoreBillCreationInformationDto
- Information about how a bill can be created in a store.
- AnybillStoreDetailsDto
- AnybillStoreDto
- Holds information for anybill stores.
- BankTransferPaymentDetailsDto
- Additional optional payment details about the bank transfer payment type. Used for PaymentType = BankTransfer
- BarcodeCustomSectionDataDto
- Barcode section
- BillBaseDto
- The definition of a bill based on the version '1.0.0' of the DFKA.
- BillCategoryDto
- BillDiscountDto
- Discounts applied to the bill.
- BillDiscountVatAmountDto
- Amount per tax rate and bill discount.
- BillDto
- A digital bill that was added for a vendor customer. Needs type set to 'bill'.
- BillScanDto
- Scanned bill via the app. Not added via a pos system. Needs type set to 'scan'.
- BillVendorDto
- Object that returns the bill vendor information.
- BoiTvaDto
- BOI-TVA object for france fiscalisation
- BuyerAddressDto
- Address of the receipt recipient / buyer in a structured form.
- BuyerDto
- Structured data of the receipt recipient / buyer.
- CardPaymentDetailsDto
- Additional optional payment details about the card tender type. Used for PaymentType = CreditCard, GiroCard, Visa and Maestro
- CashPaymentDetailsDto
- Additional optional payment details about the cash tender type. Used for PaymentType = Cash
- CashRegisterDto
- Information about the cash register.
- CategoryDto
- Category object to return.
- CheckPaymentDetailsDto
- Additional optional payment details about the check tender type. Used for PaymentType = Check
- ContentAreaDto
- CountrySpecificAttributesBaseDto
- Country specific attributes base Object
- CreateLinkBillDto
- DTO for the linking of a bill to a user.
- CreateWarrantyDto
- Object to create a warranty for an item of a bill.
- CreditCardPaymentDetailsDto
- Additional optional payment details about the credit card tender type. Used for PaymentType = CreditCard
- CustomSectionDataBaseDto
- The custom section data object.
- CustomSectionDto
- A custom section which can be defined to add custom attributes
- DataDto
- Bill data.
- DataVatAmountDto
- Total amount per tax rate.
- DefaultLineDiscountDto
- Applied discount for this line.
- DefaultLineDto
- Default line of an item / product or service provided. Needs type set to 'default'.
- DirectDebitPaymentDetailsDto
- Additional optional payment details about the direct debit tender type. Used for PaymentType = DirectDebit, Girocard, Elv, Maestro, VisaElectron
- DiscountLineDto
- Discount line. Represents a discount not explicitly bound to a specific line. Needs type set to 'discount'.
- DiscountLineVatAmountDto
- Amount per tax rate and discount.
- ElvPaymentDetailsDto
- ElvPaymentDetailsDto for correct Swagger Generator. Type = PaymentType.Elv
- FranceSpecificAttributesDto
- France specific attributes
- GiftCardPaymentDetailsDto
- Additional optional payment details about the gift card tender type. Used for PaymentType = GiftCard
- GirocardPaymentDetailsDto
- GirocardPaymentDetailsDto for correct Swagger Generator. Type = PaymentType.Girocard
- HeadDto
- Head data of the bill.
- HospitalityBillInformationDto
- HostedPersonDto
- Hosted person.
- ItemDto
- Detailed description of a line item.
- KeyValueCustomSectionDataDto
- KeyValue section
- KeyValueLineDto
- A custom line is a line, which is not defined by the DFKA.. Key and Value will be shown on the left and right side of the pdf receipt.
- LineBaseDto
- Definition of a line of the receipt.
- LineDiscountVatAmountDto
- Amount per tax rate and line item.
- LineVatAmountDto
- Amount per tax rate and line item.
- LinkedBillDto
- DTO for the linking of a bill to a user.
- LinkTransactionWithBillDto
- A bill linked with a fino transaction.
- LocationDto
- LogoDto
- Logo that should appear on the receipt.
- LoyaltyCardPaymentDetailsDto
- Additional optional payment details about the loyalty card tender type. Used for PaymentType = LoyaltyCard
- MaestroPaymentDetailsDto
- MaestroPaymentDetailsDto for correct Swagger Generator. Type = PaymentType.Maestro
- MiscDto
- Optional additional data.
- MiscellaneousPaymentDetailsDto
- MiscellaneousPaymentDetailsDto for correct Swagger Generator. Type = PaymentType.Miscellaneous
- NewsDto
- News of a store.
- NewsStoreDto
- Store of a news.
- OnlinePaymentDetailsDto
- Additional optional payment details about the online payment tender type. Used for PaymentType = OnlinePayment
- PaymentDetailsDto
- Additional payment details.
- PaymentTypeInformationDto
- Payment type used to pay the receipt.
- QrCodeCustomSectionDataDto
- QrCode section
- ReceiptTransactionTypeDto
- Type of the receipt transaction default should be PurchaseReceipt
- ReminderDto
- Reminder definition for a warranty.
- RemoveLinkedBillsDto
- ReviewDto
- Review of a store.
- RksvDto
- Security features according to 'Registrierkassensicherheitsverordnung'.
- SecurityDto
- Data to secure the receipt via TSE.
- SecurityInformationDataDto
- Base object for security information data.
- SecurityInformationDto
- Dynamic security / tse information.
- SellerAddressDto
- Address of the providing company / seller.
- SellerDto
- Information on the document issuer / providing company / seller.
- StoreOpeningHoursDto
- Opening hours of a store.
- TerminalPaymentDetailsDto
- Additional information for payments using a card terminal.
- TextCustomSectionDataDto
- Text section
- TextLineDto
- Text line used to display only text. Needs type set to 'text'.
- TseBaseDto
- Bae TSE Dto.
- TseDto
- Security features according to 'KassenSichV'.
- UserInformationDto
- Information of a AppUser.
- UserQrCodeDto
- Qr Code of a AppUser.
- VisaElectronPaymentDetailsDto
- VisaElectronPaymentDetailsDto for correct Swagger Generator. Type = PaymentType.VisaElectron
- WarrantyDto
- Warranty definition for a line item.
Enums
- AccountLinkStatusDto
- Link status of a gmi account.
- AdditionalBoiTvaDataPositionDto
- Position type where additional BOI-TVA data should be displayed.
- AdditionalBoiTvaDataTypeDto
- Additional BOI-TVA type
- AdditionBoiTvaDataAlignmentDto
- Alignment position of the text value.
- AfterSalesCouponCodeType
- Type of the code of an after sales coupon.
- BillCreationTypeDto
- BillDiscountBarcodeType
- Type of a bill discount barcode.
- BillDiscountType
- BillLinkingTypeDto
- Linking type of the bill.
- BillType
- Type of bill.
- ContentAreaPositionDto
- ContentAreaStyleDto
- Determines where the ContentArea should be placed on the bill and if a resource is included or not.
- CountryTypeDto
- Type of the country. Used to determine settings for when the bill is from a foreign, supported country.
- CustomSectionBarcodeTypeDto
- Type of the barcode. Default = Barcode (Code39)
- CustomSectionDataTypeDto
- The Type of the custom section data.
- CustomSectionPositionDto
- Position type where section should be displayed.
- CustomSectionTypeDto
- Areas into which the receipt is divided. A more detailed explanation of the areas can be found at https://developers.anybill.de/the_anybill_vendor_api/ .
- DayOfWeek
- GenderDto
- LineType
- PaymentType
- Method of payment
- QuantityMeasure
- The quantity measure of a line item.
- ReceiptTransactionTypeTypeDto
- Type of the receipt transaction default = PurchaseReceipt
- ResourceSizeDto
- Specifies the size of logos or images. Can be Small, Medium, Large or Original.
- ReturnBarcodeType
- Type of a return barcode.
- SecurityInformationDataTypeDto
- Type of the security information data of a receipt.
- ThirdPartySettingsTypeDto
- TseTypeDto
- Type of the tse.