@kreiseck/kasseneck-api 0.31.0 → 1.0.0-rc.2

package/fixtures/surface.json

@@ -0,0 +1,877 @@
+{
+  "version": "1.0.0-rc.2",
+  "baseUrls": {
+    "public": "https://api.kasseneck.at/v3",
+    "pos": "https://kasse.kasseneck.at/api/v3"
+  },
+  "calls": {
+    "public": [
+      "activateCashregister",
+      "cancelInvoice",
+      "cancelReceipt",
+      "createCreditNote",
+      "createCustomer",
+      "createCustomerCashregister",
+      "createPartnerCustomer",
+      "checkPartnerCustomerEmail",
+      "createPartnerWebhook",
+      "createPaymentLinkStripe",
+      "createReceipt",
+      "deletePartnerWebhook",
+      "downloadDailyReport",
+      "downloadReport",
+      "financeWebService",
+      "generateFullReceiptId",
+      "getCustomer",
+      "getCustomerCredentials",
+      "getCustomerSignatureStatus",
+      "getFirstReceiptDate",
+      "getInvoice",
+      "getInvoicePdf",
+      "getInvoiceSetupStatus",
+      "getInvoiceXml",
+      "getPartnerCustomer",
+      "getPartnerInfo",
+      "getReceipt",
+      "getReportV2",
+      "hobexPayApi",
+      "hobexRefundApi",
+      "issueInvoice",
+      "listCustomerCashregisters",
+      "listInvoices",
+      "listBrands",
+      "listMyTipRecipients",
+      "listPartnerCustomers",
+      "listPartnerWebhookDeliveries",
+      "listPartnerWebhooks",
+      "recordInvoicePayment",
+      "reportCustomerContract",
+      "requestCustomerSignature",
+      "searchCustomers",
+      "sendPartnerCustomerFonLink",
+      "sendPartnerWebhookTest",
+      "sendReceiptEmail",
+      "stripeCaptureIntent",
+      "rotatePartnerWebhookSecret",
+      "updateCustomer",
+      "updatePartnerWebhook"
+    ],
+    "pos": [
+      "cancelReceipt",
+      "createPrintJob",
+      "createReceipt",
+      "endRegisterSession",
+      "generateFullReceiptId",
+      "getKasseSettings",
+      "getPrintJob",
+      "getReceipt",
+      "listMyArticleGroups",
+      "listMyArticles",
+      "listMyCashregisters",
+      "listMyPrinters",
+      "listMyReceipts",
+      "listMyTipRecipients",
+      "listRegisterUsersForDevice",
+      "listRegisterSessionsForDevice",
+      "pairRegisterDevice",
+      "registerPinLogin",
+      "registerUserLogin",
+      "renewRegisterSession",
+      "sendReceiptEmail",
+      "setMyKasseLogo",
+      "setMyKasseSettings",
+      "setMyRegisterDeviceSettings",
+      "unpairRegisterDevice"
+    ]
+  },
+  "routes": {
+    "public": [
+      "createReceipt",
+      "getReceipt",
+      "cancelReceipt",
+      "sendReceiptEmail",
+      "generateFullReceiptId",
+      "downloadReceipt",
+      "getFirstReceiptDate",
+      "getReportV2",
+      "downloadReport",
+      "downloadDailyReport",
+      "createPaymentLinkStripe",
+      "stripeCaptureIntent",
+      "hobexPayApi",
+      "hobexRefundApi",
+      "hobexGetStatus",
+      "financeWebService",
+      "listMyTipRecipients",
+      "getPartnerInfo",
+      "createPartnerCustomer",
+      "checkPartnerCustomerEmail",
+      "listPartnerCustomers",
+      "getPartnerCustomer",
+      "sendPartnerCustomerFonLink",
+      "createPartnerWebhook",
+      "updatePartnerWebhook",
+      "deletePartnerWebhook",
+      "listPartnerWebhooks",
+      "sendPartnerWebhookTest",
+      "rotatePartnerWebhookSecret",
+      "listPartnerWebhookDeliveries",
+      "requestCustomerSignature",
+      "getCustomerSignatureStatus",
+      "createCustomerCashregister",
+      "activateCashregister",
+      "listCustomerCashregisters",
+      "getCustomerCredentials",
+      "reportCustomerContract",
+      "createCustomer",
+      "getCustomer",
+      "updateCustomer",
+      "searchCustomers",
+      "issueInvoice",
+      "cancelInvoice",
+      "createCreditNote",
+      "getInvoice",
+      "listInvoices",
+      "getInvoicePdf",
+      "getInvoiceXml",
+      "getInvoiceSetupStatus",
+      "listBrands",
+      "recordInvoicePayment"
+    ],
+    "pos": [
+      "pairRegisterDevice",
+      "listRegisterUsersForDevice",
+      "listRegisterSessionsForDevice",
+      "registerUserLogin",
+      "registerPinLogin",
+      "renewRegisterSession",
+      "endRegisterSession",
+      "unpairRegisterDevice",
+      "listMyCashregisters",
+      "listMyReceipts",
+      "getReceipt",
+      "createReceipt",
+      "generateFullReceiptId",
+      "cancelReceipt",
+      "sendReceiptEmail",
+      "listMyArticleGroups",
+      "listMyArticles",
+      "getKasseSettings",
+      "setMyKasseSettings",
+      "setMyKasseLogo",
+      "setMyRegisterDeviceSettings",
+      "listMyPrinters",
+      "createPrintJob",
+      "getPrintJob",
+      "listMyTipRecipients"
+    ]
+  },
+  "enums": {
+    "autoLogoutMinutes": [
+      0,
+      1,
+      5,
+      15,
+      30
+    ],
+    "cardProvider": [
+      "none",
+      "external",
+      "gptom",
+      "hobex",
+      "mypos",
+      "stripe"
+    ],
+    "categoryPosition": [
+      "top",
+      "left"
+    ],
+    "checkoutMode": [
+      "page",
+      "panel"
+    ],
+    "codePage": [
+      "CP1252",
+      "CP437"
+    ],
+    "cut": [
+      "partial",
+      "full",
+      "none"
+    ],
+    "discount": [
+      "off",
+      "on"
+    ],
+    "doneScreenSeconds": [
+      0,
+      3,
+      5,
+      10,
+      15,
+      30,
+      60
+    ],
+    "drawerAutoOpen": [
+      "cash",
+      "always",
+      "never"
+    ],
+    "fontSize": [
+      "S",
+      "M",
+      "L",
+      "XL"
+    ],
+    "layout": [
+      "right",
+      "left",
+      "fullscreen"
+    ],
+    "logoScale": [
+      "S",
+      "M",
+      "L",
+      "XL"
+    ],
+    "logoSize": [
+      "S",
+      "M",
+      "L"
+    ],
+    "paperSize": [
+      "mm58",
+      "mm80"
+    ],
+    "printerType": [
+      "sdp",
+      "network",
+      "bluetooth",
+      "usb",
+      "connect"
+    ],
+    "qrMode": [
+      "auto",
+      "raster",
+      "escpos"
+    ],
+    "quantity": [
+      "off",
+      "x",
+      "kg"
+    ],
+    "receiptOutput": [
+      "qr",
+      "print",
+      "email",
+      "sms",
+      "ask"
+    ],
+    "settingsFontSize": [
+      "S",
+      "M",
+      "L"
+    ],
+    "terminalType": [
+      "none",
+      "hps"
+    ],
+    "terminalVia": [
+      "direct",
+      "connect"
+    ],
+    "theme": [
+      "clear",
+      "warm",
+      "night",
+      "contrast"
+    ],
+    "tileHeight": [
+      "S",
+      "M",
+      "L"
+    ],
+    "tileStyle": [
+      "stripe",
+      "full"
+    ],
+    "tipMode": [
+      "amount",
+      "total",
+      "both"
+    ],
+    "watermark": [
+      "off",
+      "login",
+      "everywhere"
+    ],
+    "watermarkScale": [
+      "S",
+      "M",
+      "L",
+      "XL"
+    ],
+    "watermarkSide": [
+      "left",
+      "center",
+      "right"
+    ],
+    "watermarkStrength": [
+      3,
+      6,
+      10,
+      16
+    ]
+  },
+  "registerPerms": [
+    "sell",
+    "cancel",
+    "articles",
+    "layout",
+    "reports",
+    "takeover",
+    "cancelScope",
+    "receiptsScope",
+    "drawer",
+    "discount",
+    "tipAssign"
+  ],
+  "registerErrorCodes": [
+    "account_not_found",
+    "admin_required",
+    "cashregister_in_use",
+    "cashregister_not_assigned",
+    "cashregister_not_found",
+    "cashregister_token_invalid",
+    "cashregister_token_missing",
+    "device_bound_elsewhere",
+    "device_not_found",
+    "device_not_paired",
+    "device_takeover_required",
+    "dialect_mismatch",
+    "internal_translation_error",
+    "licenses_exhausted",
+    "live_not_enabled",
+    "location_outside",
+    "location_required",
+    "login_failed",
+    "login_mode_select_user",
+    "login_unavailable",
+    "method_not_allowed",
+    "mfa_required",
+    "not_found",
+    "pairing_code_expired",
+    "pairing_code_unknown",
+    "pairing_code_used",
+    "pairing_failed",
+    "register_user_no_business",
+    "register_user_not_allowed",
+    "register_user_not_found",
+    "register_user_only",
+    "response_translation_failed",
+    "session_ended",
+    "session_expired",
+    "session_not_running",
+    "session_other_cashregister",
+    "too_many_attempts",
+    "unauthorized",
+    "user_disabled",
+    "user_verification_failed",
+    "validation",
+    "route_missing"
+  ],
+  "posShortcutActions": [
+    "checkout",
+    "complete",
+    "cancel",
+    "customAmount",
+    "cash",
+    "card",
+    "exactAmount",
+    "receipts",
+    "undoLast",
+    "settings",
+    "logout",
+    "tip",
+    "fullscreen",
+    "clearTendered",
+    "clearCart",
+    "splitPayment"
+  ],
+  "pos": {
+    "posErrorCodes": [
+      "account_not_found",
+      "admin_required",
+      "cashregister_not_assigned",
+      "cashregister_not_found",
+      "cashregister_token_invalid",
+      "cashregister_token_missing",
+      "device_not_found",
+      "dialect_mismatch",
+      "internal_translation_error",
+      "live_not_enabled",
+      "logo_invalid",
+      "logo_invalid_type",
+      "logo_too_large",
+      "method_not_allowed",
+      "mfa_required",
+      "module_inactive",
+      "not_found",
+      "not_permitted",
+      "print_job_not_found",
+      "print_layout_failed",
+      "printer_not_found",
+      "register_user_no_business",
+      "register_user_not_allowed",
+      "register_user_not_found",
+      "response_translation_failed",
+      "session_expired",
+      "session_other_cashregister",
+      "unauthorized",
+      "user_disabled",
+      "user_verification_failed",
+      "validation",
+      "route_missing"
+    ],
+    "printJobSources": [
+      "pos",
+      "panel"
+    ],
+    "printJobStatuses": [
+      "pending",
+      "sent",
+      "printed",
+      "failed",
+      "expired"
+    ],
+    "quantityRules": [
+      "piece",
+      "decimal"
+    ]
+  },
+  "partner": {
+    "austrianStates": [
+      "AT-1",
+      "AT-2",
+      "AT-3",
+      "AT-4",
+      "AT-5",
+      "AT-6",
+      "AT-7",
+      "AT-8",
+      "AT-9"
+    ],
+    "avvModes": [
+      "direct",
+      "power_of_attorney",
+      "subprocessor"
+    ],
+    "businessFields": [
+      "companyName",
+      "legalForm",
+      "state",
+      "industry",
+      "companyRegister",
+      "court",
+      "web",
+      "phone",
+      "email",
+      "billingEmail",
+      "address.street",
+      "address.number",
+      "address.zip",
+      "address.city",
+      "taxDetails.taxNumber",
+      "taxDetails.vatId",
+      "taxDetails.gln",
+      "taxDetails.smallBusiness",
+      "contacts[].name",
+      "contacts[].email",
+      "contacts[].phone",
+      "contacts[].roles",
+      "taxAdvisor.name",
+      "taxAdvisor.email",
+      "taxAdvisor.phone",
+      "taxAdvisor.mayContact"
+    ],
+    "contactRoles": [
+      "management",
+      "accounting",
+      "technical",
+      "pos"
+    ],
+    "contractKinds": [
+      "avv",
+      "terms"
+    ],
+    "contractSources": [
+      "setup_link",
+      "process_link",
+      "partner_power_of_attorney",
+      "admin_paper",
+      "paper_upload",
+      "app",
+      "portal"
+    ],
+    "feeIntervals": [
+      "monthly",
+      "yearly",
+      "once"
+    ],
+    "legalForms": [
+      "sole_proprietor",
+      "eu",
+      "og",
+      "kg",
+      "gmbh",
+      "gmbhcokg",
+      "ag",
+      "association",
+      "other"
+    ],
+    "partnerEnvs": [
+      "live",
+      "test"
+    ],
+    "partnerErrorCodes": [
+      "validation",
+      "rate_limited",
+      "app_not_found",
+      "app_not_accepted",
+      "live_not_allowed",
+      "customer_exists",
+      "customer_conflict",
+      "customer_limit",
+      "access_not_allowed",
+      "email_taken",
+      "no_email",
+      "tax_number_missing",
+      "fon_missing",
+      "signature_pending",
+      "signature_missing",
+      "signature_unknown",
+      "signature_ambiguous",
+      "signature_not_ready",
+      "signature_limit",
+      "signature_failed",
+      "module_inactive",
+      "cashregister_limit",
+      "cashregister_not_found",
+      "contracts_pending",
+      "kind_not_allowed",
+      "mode_not_allowed",
+      "power_of_attorney_missing",
+      "not_found",
+      "no_version",
+      "unknown_version",
+      "text_changed",
+      "already_accepted",
+      "activation_failed",
+      "webhook_limit",
+      "webhook_inactive",
+      "event_not_subscribed"
+    ],
+    "partnerPortalErrorCodes": [
+      "app_locked",
+      "version_locked",
+      "invalid_transition",
+      "no_accepted_app",
+      "consent",
+      "key_limit",
+      "last_owner",
+      "auth_user_exists",
+      "card_missing",
+      "card_duplicate",
+      "card_not_verified",
+      "already_assigned"
+    ],
+    "partnerRequestErrorCodes": [
+      "method_not_allowed",
+      "unauthorized",
+      "partner_locked",
+      "scope_missing",
+      "internal_translation_error",
+      "dialect_mismatch",
+      "response_translation_failed",
+      "route_missing"
+    ],
+    "partnerWebhookEvents": [
+      "customer.created",
+      "customer.updated",
+      "customer.status_changed",
+      "customer.fon_verified",
+      "customer.live_enabled",
+      "customer.avv_accepted",
+      "customer.terms_accepted",
+      "signature.requested",
+      "signature.ready",
+      "signature.failed",
+      "cashregister.created",
+      "cashregister.live",
+      "cashregister.failed",
+      "app.version.accepted",
+      "app.version.rejected",
+      "webhook.test"
+    ],
+    "signatureErrorCodes": [
+      "customer_not_found",
+      "incomplete",
+      "finanzonline_error"
+    ],
+    "signatureHistoryReasons": [
+      "api",
+      "portal",
+      "card_entered",
+      "finanzonline",
+      "automation_off",
+      "test_environment",
+      "no_stock"
+    ],
+    "webhookDeliveryStatuses": [
+      "pending",
+      "delivered",
+      "failed",
+      "dropped"
+    ],
+    "webhookEnvelopeFields": [
+      "id",
+      "type",
+      "createdAt",
+      "partnerId",
+      "test",
+      "data"
+    ],
+    "webhookRetryPlanSec": [
+      60,
+      300,
+      1800,
+      7200,
+      43200
+    ]
+  },
+  "invoice": {
+    "creditNoteReasons": [
+      "cancellation",
+      "price_reduction",
+      "return",
+      "incorrect_invoice",
+      "other"
+    ],
+    "customerTypes": [
+      "private",
+      "company"
+    ],
+    "docTypes": [
+      "invoice",
+      "credit_note"
+    ],
+    "einvoiceFormats": [
+      "ubl",
+      "cii"
+    ],
+    "einvoiceMissingCodes": [
+      "name",
+      "street",
+      "zip",
+      "city",
+      "country",
+      "vat_id",
+      "order_reference",
+      "order_reference_format"
+    ],
+    "invoiceEndpoints": [
+      "createCustomer",
+      "getCustomer",
+      "updateCustomer",
+      "searchCustomers",
+      "issueInvoice",
+      "cancelInvoice",
+      "createCreditNote",
+      "getInvoice",
+      "listInvoices",
+      "getInvoicePdf",
+      "getInvoiceXml",
+      "getInvoiceSetupStatus",
+      "listBrands",
+      "recordInvoicePayment"
+    ],
+    "invoiceErrorCodes": [
+      "validation",
+      "idempotency_conflict",
+      "module_inactive",
+      "customer_not_found",
+      "customer_exists",
+      "short_code_taken",
+      "short_code_immutable",
+      "recipient_required",
+      "invoice_requirements_missing",
+      "invoice_not_found",
+      "invoice_ambiguous",
+      "not_cancellable",
+      "partial_credit_exists",
+      "credit_exceeds_invoice",
+      "einvoice_incomplete",
+      "invoice_api_not_enabled",
+      "invoice_setup_incomplete",
+      "language_not_allowed",
+      "brand_not_found",
+      "not_payable",
+      "payment_exceeds_invoice",
+      "tax_scheme_mismatch",
+      "vat_rate_not_in_country",
+      "reverse_charge_reason_required",
+      "reverse_charge_threshold",
+      "mixed_supply_not_allowed",
+      "oss_not_enabled",
+      "einvoice_unavailable",
+      "amount_too_large"
+    ],
+    "invoiceLanguages": [
+      "de",
+      "en"
+    ],
+    "invoiceListStatus": [
+      "final",
+      "paid",
+      "cancelled",
+      "open",
+      "overdue"
+    ],
+    "invoiceNoticeCodes": [
+      "cash_receipt_required",
+      "recapitulative_statement_due",
+      "place_of_supply_check"
+    ],
+    "invoicePaymentMethods": [
+      "transfer",
+      "card",
+      "online",
+      "cash"
+    ],
+    "invoiceRequestErrorCodes": [
+      "account_not_found",
+      "admin_required",
+      "cashregister_not_assigned",
+      "cashregister_not_found",
+      "cashregister_token_invalid",
+      "cashregister_token_missing",
+      "dialect_mismatch",
+      "internal_translation_error",
+      "live_not_enabled",
+      "method_not_allowed",
+      "mfa_required",
+      "not_found",
+      "register_user_no_business",
+      "register_user_not_allowed",
+      "register_user_not_found",
+      "response_translation_failed",
+      "session_expired",
+      "session_other_cashregister",
+      "unauthorized",
+      "user_disabled",
+      "user_verification_failed",
+      "route_missing"
+    ],
+    "invoiceSetupRequirements": [
+      "module_active",
+      "api_enabled",
+      "live_enabled",
+      "business_name",
+      "address",
+      "vat_id",
+      "bank_account",
+      "number_format"
+    ],
+    "invoiceUnits": [
+      "piece",
+      "pair",
+      "set",
+      "dozen",
+      "second",
+      "minute",
+      "hour",
+      "day",
+      "night",
+      "week",
+      "month",
+      "quarter",
+      "half_year",
+      "year",
+      "milligram",
+      "gram",
+      "kilogram",
+      "tonne",
+      "millimetre",
+      "centimetre",
+      "metre",
+      "running_metre",
+      "kilometre",
+      "square_metre",
+      "hectare",
+      "millilitre",
+      "litre",
+      "cubic_metre",
+      "kilowatt_hour",
+      "megawatt_hour",
+      "gigabyte",
+      "terabyte",
+      "flat_rate",
+      "person",
+      "licence",
+      "user",
+      "device",
+      "session",
+      "trip",
+      "page",
+      "sheet",
+      "package",
+      "box",
+      "carton",
+      "bottle",
+      "can",
+      "roll",
+      "bag",
+      "pallet"
+    ],
+    "itemKinds": [
+      "goods",
+      "service"
+    ],
+    "priceModes": [
+      "net",
+      "gross"
+    ],
+    "taxSchemes": [
+      "normal",
+      "smallBusiness",
+      "reverseCharge",
+      "intraCommunitySupply",
+      "exportThirdCountry",
+      "domesticReverseCharge",
+      "oss",
+      "outsideScope"
+    ],
+    "vatRates": [
+      0,
+      10,
+      13,
+      20
+    ],
+    "writeOffReasonCodes": [
+      "uncollectible",
+      "time_barred",
+      "waived",
+      "disputed",
+      "settled_externally",
+      "other"
+    ],
+    "zeroRatedTaxSchemes": [
+      "smallBusiness",
+      "reverseCharge",
+      "intraCommunitySupply",
+      "exportThirdCountry",
+      "domesticReverseCharge",
+      "outsideScope"
+    ]
+  }
+}