{"openapi":"3.1.0","info":{"title":"AbaNinja AbaNet API","version":"3.0.0","x-domain-id":"abanet"},"servers":[{"url":"https://api.abaninja.ch","description":"The AbaNinja API server"}],"tags":[{"name":"abanet_networks","description":"Manage abanet networks","x-displayName":"AbaNet Networks"},{"name":"accounting_accounting-assignments","description":"Manage accounting assignments","x-displayName":"Accounting Assignments"},{"name":"accounting_accounting-preset","description":"Manage presets of accounting accounts","x-displayName":"Accounting Preset"},{"name":"accounting_accounting-tax-timelines","description":"Manage Tax Timelines","x-displayName":"Tax Timelines"},{"name":"accounts_accounts","description":"Manage accounts","x-displayName":"Accounts"},{"name":"accounts_users","description":"Manage users","x-displayName":"Users"},{"name":"addresses_Addresses","description":"Manage addresses","x-displayName":"Addresses"},{"name":"documents_document-common","description":"Manage documents","x-displayName":"Common"},{"name":"documents_document-contract-note-settings","description":"Manage contract note settings","x-displayName":"Contract Note Settings"},{"name":"documents_document-credit-note-settings","description":"Manage credit note settings","x-displayName":"Credit Note Settings"},{"name":"documents_document-delivery-note-settings","description":"Manage delivery note settings","x-displayName":"Delivery Note Settings"},{"name":"documents_document-invoice-settings","description":"Manage invoice settings","x-displayName":"Invoice Settings"},{"name":"documents_document-receipt-settings","description":"Manage receipt settings","x-displayName":"Receipt Settings"},{"name":"documents_document-quote-settings","description":"Manage quote settings","x-displayName":"Quote Settings"},{"name":"documents_document-invoices","description":"Manage invoice documents","x-displayName":"Invoices"},{"name":"documents_document-receipts","description":"Manage receipt documents","x-displayName":"Receipts"},{"name":"documents_document-credit-notes","description":"Manage credit notes","x-displayName":"Credit Notes"},{"name":"documents_document-recurring-invoices","description":"Manage recurring invoices","x-displayName":"Recurring Invoices"},{"name":"documents_document-quotes","description":"Manage quote documents","x-displayName":"Quotes"},{"name":"documents_document-contract-notes","description":"Manage contract notes","x-displayName":"Contract Notes"},{"name":"documents_document-delivery-notes","description":"Manage delivery notes","x-displayName":"Delivery Notes"},{"name":"documents_document-supplier-credit-notes","description":"Manage supplier credit notes","x-displayName":"Supplier Credit Notes"},{"name":"exports_exports","description":"Manage exports","x-displayName":"Exports"},{"name":"finances_bank-accounts","description":"Manage bank accounts","x-displayName":"Bank Accounts"},{"name":"finances_bank-files","description":"Manage bank files","x-displayName":"Bank Files"},{"name":"finances_payments","description":"Manage payments","x-displayName":"Payments"},{"name":"holidays_holidays","description":"Manage holidays","x-displayName":"Holidays"},{"name":"holidays_holiday-settings","description":"Manage holiday settings","x-displayName":"Holiday Settings"},{"name":"members_members","description":"Manage members","x-displayName":"Members"},{"name":"members_member-groups","description":"Manage member groups","x-displayName":"Member Groups"},{"name":"members_memberships","description":"Manage memberships","x-displayName":"Memberships"},{"name":"products_products","description":"Manage products","x-displayName":"Products"},{"name":"products_product-groups","description":"Manage product groups","x-displayName":"Product Groups"},{"name":"products_product-suppliers","description":"Manage product suppliers","x-displayName":"Product Suppliers"},{"name":"time-tracking_time-tracking-employees","description":"Manage employees","x-displayName":"Employees"},{"name":"time-tracking_time-tracking-employee-groups","description":"Manage employee groups","x-displayName":"Employee Groups"},{"name":"time-tracking_time-tracking-employee-statistics","description":"Get employee statistics","x-displayName":"Employee Statistics"},{"name":"time-tracking_time-tracking-employee-organigram","description":"Manage employee organigram","x-displayName":"Employee Organigram"},{"name":"time-tracking_time-tracking-activities","description":"Manage time tracking activities","x-displayName":"Activities"},{"name":"time-tracking_time-tracking-timestamps","description":"Manage time tracking timestamps","x-displayName":"Timestamps"},{"name":"time-tracking_time-tracking-corrections","description":"Manage time tracking corrections","x-displayName":"Corrections"},{"name":"time-tracking_time-tracking-closures","description":"Manage time tracking closures","x-displayName":"Closures"},{"name":"time-tracking_time-tracking-contracts","description":"Manage time tracking contracts","x-displayName":"Contracts"},{"name":"time-tracking_time-tracking-settings","description":"Manage time tracking settings","x-displayName":"Time Tracking Settings"},{"name":"units_account-units","description":"Manage account units","x-displayName":"Account Units"},{"name":"units_system-units","description":"Manage system units","x-displayName":"System Units"},{"name":"warehouse_exports","description":"Manage exports","x-displayName":"Exports"},{"name":"warehouse_warehouse","description":"Manage warehouse","x-displayName":"Warehouse"},{"name":"warehouse_warehouse-exports","description":"Get exports from warehouse","x-displayName":"Warehouse Exports"},{"name":"warehouse_warehouse-products","description":"Manage warehouse products","x-displayName":"Warehouse Products"},{"name":"warehouse_warehouse-transactions","description":"Manage warehouse transactions","x-displayName":"Warehouse Transactions"},{"name":"warehouse_warehouse-transaction-types","description":"Get warehouse transaction types","x-displayName":"Warehouse Transaction Types"},{"name":"webhooks_outgoing-webhooks","description":"Manage outgoing webhooks","x-displayName":"Outgoing Webhooks"}],"paths":{"/accounts/{accountUuid}/abanet/v2/connection/status":{"get":{"tags":["abanet_networks"],"summary":"Check AbaNet status","description":"Check the connection status of AbaNet","operationId":"abanet_list_status","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"AbaNet Connection Status Resource","properties":{"isValid":{"type":"boolean"},"onboardingLink":{"type":["string","null"]}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"596a9bc6c83284b2b39c18e24a965a70","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/abanet/v2/networks/{networkUuid}":{"get":{"tags":["abanet_networks"],"summary":"Get AbaNet network","description":"Get a single AbaNet network","operationId":"abanet_get_networks","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"networkUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Network Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"contract":{"type":["string","null"]},"type":{"type":"string","enum":["receiver","sender"]}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"3c6dc42ed215feb50bd2c31d547eb91e","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/accounting/v2/account-assignments":{"get":{"tags":["accounting_accounting-assignments"],"summary":"Get all assignments","description":"Get all assignments","operationId":"accounting_list_account_assignments","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Accounting Account Assignment with Details","properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["PAYMENT_TYPE","COLLECT_INVOICE","COLLECT_RECEIPT","VAT_REVENUE","VAT_EFFORTS","VAT_INPUT","VAT_EXPORT","VAT_ACQUISITION","ON_ACCOUNT","CLOSING_INCOME","CLOSING_PASSIVE","DEFAULT_REVENUE","DEFAULT_EFFORTS","FOREX_REVENUE","FOREX_EFFORTS","ROUNDING_INVOICE","ROUNDING_RECEIPT","CREDIT_NOTE_OFFSET_DEBITOR","CREDIT_NOTE_OFFSET_CREDITOR","DUNNING_FEES"]},"accAccount":{"properties":{"exists":{"type":"boolean"},"uuid":{"type":["string","null"],"format":"uuid"},"number":{"type":["string","null"]},"name":{"type":["string","null"]}},"type":"object"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"paymentMethod":{"type":["string","null"],"enum":["BANK","BITPAY","CARD_TERMINAL","CASH","CASH_ON_DELIVERY","INSTANT_TRANSFER","PAYPAL","TWINT","WIR","VOUCHER_OWN","VOUCHER_THIRD_PARTY","CREDIT_NOTE_OFFSET","DISCOUNT","CASH_DISCOUNT","DEBIT_LOSS","DEBIT_CREDIT_CARD","DONATION","CARD_COMMISSIONS","CURRENT_ACCOUNT","PREPAYMENT","PRIVATE","MAESTRO","MASTERCARD","VISA","AMEX","POSTFINANCE","DINERS_CARD","DUNNING_REMISSION"]},"direction":{"type":["string","null"],"enum":["IN","OUT"]},"taxRateUuid":{"type":["string","null"],"format":"uuid"},"bankAccountUuid":{"type":["string","null"],"format":"uuid"},"paymentCardUuid":{"type":["string","null"],"format":"uuid"},"flags":{"properties":{"isGenerated":{"type":"boolean"},"isRequired":{"type":"boolean"},"isComplete":{"type":"boolean"},"isSystem":{"type":"boolean"}},"type":"object"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/accounting"]}],"x-legacy-operation-id":"156043603836d5e9c1ba6bfc1e344421","x-required-scopes":["accounting"]},"post":{"tags":["accounting_accounting-assignments"],"summary":"Create assignment","description":"Create a new assignment","operationId":"accounting_create_account_assignments","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create assignment","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/account-assignment.create.schema.json","description":"A Schema for creating an accounting account assignment","type":"object","properties":{"type":{"type":"string","enum":["PAYMENT_TYPE","COLLECT_INVOICE","COLLECT_RECEIPT","VAT_REVENUE","VAT_EFFORTS","VAT_INPUT","VAT_EXPORT","VAT_ACQUISITION","ON_ACCOUNT","CLOSING_INCOME","CLOSING_PASSIVE","DEFAULT_REVENUE","DEFAULT_EFFORTS","FOREX_REVENUE","FOREX_EFFORTS","ROUNDING_INVOICE","ROUNDING_RECEIPT","CREDIT_NOTE_OFFSET_DEBITOR","CREDIT_NOTE_OFFSET_CREDITOR","DUNNING_FEES"],"description":"The type of accounting assignment. Dictates further validation."},"accAccountUuid":{"type":"string","format":"uuid","description":"The UUID of the AccAccount, that should be used when booking."},"currencyCode":{"type":["null","string"],"pattern":"^[A-Z]{3}$","description":"ISO code of the currency. When set, the assignment is only getting used, when a booking in the set currency is being booked."},"taxRateUuid":{"type":["null","string"],"format":"uuid","description":"UUID of a tax rate. When set, the assignment is only getting used, when a booking with the set tax rate is being booked."},"paymentMethod":{"type":["null","string"],"enum":[null,"BANK","BITPAY","CARD_TERMINAL","CASH","CASH_ON_DELIVERY","INSTANT_TRANSFER","PAYPAL","TWINT","WIR","VOUCHER_OWN","VOUCHER_THIRD_PARTY","CREDIT_NOTE_OFFSET","DISCOUNT","CASH_DISCOUNT","DEBIT_LOSS","DEBIT_CREDIT_CARD","DONATION","CARD_COMMISSIONS","CURRENT_ACCOUNT","PREPAYMENT","PRIVATE","MAESTRO","MASTERCARD","VISA","AMEX","POSTFINANCE","DUNNING_REMISSION"],"description":"Method of a Payment. When set, the assignment is only getting used, when a payment with the set payment method is being booked."},"direction":{"type":["null","string"],"enum":[null,"IN","OUT"],"description":"Direction of a Payment. When set, the assignment is only getting used, when a payment with the set direction is being booked."},"bankAccountUuid":{"type":["null","string"],"format":"uuid","description":"UUID of a bank account. Only applies to Type PAYMENT_TYPE with Payment Method BANK."},"paymentCardUuid":{"type":["null","string"],"format":"uuid","description":"UUID of a payment card. Only applies to Type PAYMENT_TYPE with Payment Method DEBIT_CREDIT_CARD."}},"required":["type","accAccountUuid"],"additionalProperties":false}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Accounting Account Assignment with Details","properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["PAYMENT_TYPE","COLLECT_INVOICE","COLLECT_RECEIPT","VAT_REVENUE","VAT_EFFORTS","VAT_INPUT","VAT_EXPORT","VAT_ACQUISITION","ON_ACCOUNT","CLOSING_INCOME","CLOSING_PASSIVE","DEFAULT_REVENUE","DEFAULT_EFFORTS","FOREX_REVENUE","FOREX_EFFORTS","ROUNDING_INVOICE","ROUNDING_RECEIPT","CREDIT_NOTE_OFFSET_DEBITOR","CREDIT_NOTE_OFFSET_CREDITOR","DUNNING_FEES"]},"accAccount":{"properties":{"exists":{"type":"boolean"},"uuid":{"type":["string","null"],"format":"uuid"},"number":{"type":["string","null"]},"name":{"type":["string","null"]}},"type":"object"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"paymentMethod":{"type":["string","null"],"enum":["BANK","BITPAY","CARD_TERMINAL","CASH","CASH_ON_DELIVERY","INSTANT_TRANSFER","PAYPAL","TWINT","WIR","VOUCHER_OWN","VOUCHER_THIRD_PARTY","CREDIT_NOTE_OFFSET","DISCOUNT","CASH_DISCOUNT","DEBIT_LOSS","DEBIT_CREDIT_CARD","DONATION","CARD_COMMISSIONS","CURRENT_ACCOUNT","PREPAYMENT","PRIVATE","MAESTRO","MASTERCARD","VISA","AMEX","POSTFINANCE","DINERS_CARD","DUNNING_REMISSION"]},"direction":{"type":["string","null"],"enum":["IN","OUT"]},"taxRateUuid":{"type":["string","null"],"format":"uuid"},"bankAccountUuid":{"type":["string","null"],"format":"uuid"},"paymentCardUuid":{"type":["string","null"],"format":"uuid"},"flags":{"properties":{"isGenerated":{"type":"boolean"},"isRequired":{"type":"boolean"},"isComplete":{"type":"boolean"},"isSystem":{"type":"boolean"}},"type":"object"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/accounting"]}],"x-legacy-operation-id":"49fbd5712c34b61d08dd3e276a94db9c","x-required-scopes":["accounting"]}},"/accounts/{accountUuid}/accounting/v2/tax-timelines":{"get":{"tags":["accounting_accounting-tax-timelines"],"summary":"Get all tax timelines","description":"Get all tax timelines","operationId":"accounting_list_tax_timelines","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Tax Timeline","properties":{"uuid":{"type":"string","format":"uuid"},"taxMethod":{"type":"string","enum":["tax_free","brut_method","net_method","flat_rate_method"]},"taxConsideration":{"type":"string","enum":["AGREED","RECEIVED"]},"validFrom":{"type":"string","format":"date"},"defaultTaxRate":{"properties":{"uuid":{"type":"string","format":"uuid"},"rate":{"type":"number"}},"type":"object"},"flatTaxConfiguration":{"properties":{"flatTaxRateStandard323":{"type":"string","format":"uuid"},"flatTaxRateReduced333":{"type":"string","format":"uuid"},"flatTaxRateAccommodation333":{"type":"string","format":"uuid"},"flatTaxRateStandard322":{"type":"string","format":"uuid"},"flatTaxRateReduced332":{"type":"string","format":"uuid"},"flatTaxRateAccommodation332":{"type":"string","format":"uuid"}},"type":["object","null"]}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/accounting"]}],"x-legacy-operation-id":"4b4fc1715e3dc08d0396cfb8a0f272c8","x-required-scopes":["accounting"]},"post":{"tags":["accounting_accounting-tax-timelines"],"summary":"Create new tax timeline","description":"Create new tax timeline","operationId":"accounting_create_tax_timelines","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create tax timeline","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/tax-timeline.create.schema.json","description":"A Schema for creating a tax timeline","type":"object","properties":{"taxMethod":{"type":"string","enum":["tax_free","brut_method","net_method","flat_rate_method"],"description":"The type of tax method for this period."},"taxConsideration":{"type":"string","enum":["AGREED","RECEIVED"],"description":"The type of tax consideration for this period."},"defaultTaxRateUuid":{"type":"string","format":"uuid","description":"The UUID of the tax rate, that should be prefilled on invoices by default."},"validFrom":{"type":"string","format":"date","description":"Date from which on this tax timeline is to be used. This date has to be on the first of any quarter."},"flatTaxConfiguration":{}},"required":["taxMethod","taxConsideration","defaultTaxRateUuid","validFrom"],"additionalProperties":false,"if":{"properties":{"taxMethod":{"enum":["tax_free","brut_method","net_method"]}}},"then":{"properties":{"flatTaxConfiguration":{"type":"null"}}},"else":{"required":["flatTaxConfiguration"],"properties":{"flatTaxConfiguration":{"type":"object","properties":{"flatTaxRateStandard323":{"type":"string","format":"uuid","description":"The UUID of the flat tax rate, that should be applied instead of the standard tax rate (currently 8.1%) that will be placed into figure 323."},"flatTaxRateStandard322":{"type":"string","format":"uuid","description":"The UUID of the flat tax rate, that should be applied instead of the old standard tax rate (currently 7.7%) that will be placed into figure 322."},"flatTaxRateReduced333":{"type":"string","format":"uuid","description":"The UUID of the flat tax rate, that should be applied instead of the reduced tax rate (currently 2.6%) that will be placed into figure 333."},"flatTaxRateReduced332":{"type":"string","format":"uuid","description":"The UUID of the flat tax rate, that should be applied instead of the old reduced tax rate (currently 2.5%) that will be placed into figure 332."},"flatTaxRateAccommodation333":{"type":"string","format":"uuid","description":"The UUID of the flat tax rate, that should be applied instead of the accommodation tax rate (currently 3.7%) that will be placed into figure 333."},"flatTaxRateAccommodation332":{"type":"string","format":"uuid","description":"The UUID of the flat tax rate, that should be applied instead of the old accommodation tax rate (currently 3.6%) that will be placed into figure 332."}},"required":["flatTaxRateStandard323","flatTaxRateReduced333","flatTaxRateAccommodation333","flatTaxRateStandard322","flatTaxRateReduced332","flatTaxRateAccommodation332"]}}}}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Tax Timeline","properties":{"uuid":{"type":"string","format":"uuid"},"taxMethod":{"type":"string","enum":["tax_free","brut_method","net_method","flat_rate_method"]},"taxConsideration":{"type":"string","enum":["AGREED","RECEIVED"]},"validFrom":{"type":"string","format":"date"},"defaultTaxRate":{"properties":{"uuid":{"type":"string","format":"uuid"},"rate":{"type":"number"}},"type":"object"},"flatTaxConfiguration":{"properties":{"flatTaxRateStandard323":{"type":"string","format":"uuid"},"flatTaxRateReduced333":{"type":"string","format":"uuid"},"flatTaxRateAccommodation333":{"type":"string","format":"uuid"},"flatTaxRateStandard322":{"type":"string","format":"uuid"},"flatTaxRateReduced332":{"type":"string","format":"uuid"},"flatTaxRateAccommodation332":{"type":"string","format":"uuid"}},"type":["object","null"]}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/accounting"]}],"x-legacy-operation-id":"f07ed114b14b89c3ce9d6aac9e2f2bf1","x-required-scopes":["accounting"]}},"/accounts/{accountUuid}/accounting/v2/account-assignments/{assignmentUuid}":{"get":{"tags":["accounting_accounting-assignments"],"summary":"Get single assignment","description":"Get a single assignment","operationId":"accounting_get_account_assignments","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"assignmentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Accounting Account Assignment with Details","properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["PAYMENT_TYPE","COLLECT_INVOICE","COLLECT_RECEIPT","VAT_REVENUE","VAT_EFFORTS","VAT_INPUT","VAT_EXPORT","VAT_ACQUISITION","ON_ACCOUNT","CLOSING_INCOME","CLOSING_PASSIVE","DEFAULT_REVENUE","DEFAULT_EFFORTS","FOREX_REVENUE","FOREX_EFFORTS","ROUNDING_INVOICE","ROUNDING_RECEIPT","CREDIT_NOTE_OFFSET_DEBITOR","CREDIT_NOTE_OFFSET_CREDITOR","DUNNING_FEES"]},"accAccount":{"properties":{"exists":{"type":"boolean"},"uuid":{"type":["string","null"],"format":"uuid"},"number":{"type":["string","null"]},"name":{"type":["string","null"]}},"type":"object"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"paymentMethod":{"type":["string","null"],"enum":["BANK","BITPAY","CARD_TERMINAL","CASH","CASH_ON_DELIVERY","INSTANT_TRANSFER","PAYPAL","TWINT","WIR","VOUCHER_OWN","VOUCHER_THIRD_PARTY","CREDIT_NOTE_OFFSET","DISCOUNT","CASH_DISCOUNT","DEBIT_LOSS","DEBIT_CREDIT_CARD","DONATION","CARD_COMMISSIONS","CURRENT_ACCOUNT","PREPAYMENT","PRIVATE","MAESTRO","MASTERCARD","VISA","AMEX","POSTFINANCE","DINERS_CARD","DUNNING_REMISSION"]},"direction":{"type":["string","null"],"enum":["IN","OUT"]},"taxRateUuid":{"type":["string","null"],"format":"uuid"},"bankAccountUuid":{"type":["string","null"],"format":"uuid"},"paymentCardUuid":{"type":["string","null"],"format":"uuid"},"flags":{"properties":{"isGenerated":{"type":"boolean"},"isRequired":{"type":"boolean"},"isComplete":{"type":"boolean"},"isSystem":{"type":"boolean"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/accounting"]}],"x-legacy-operation-id":"befda99174e4cf3a142859aaf7011891","x-required-scopes":["accounting"]},"patch":{"tags":["accounting_accounting-assignments"],"summary":"Update assignment","description":"Update an existing assignment","operationId":"accounting_update_account_assignments","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"assignmentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update assignment","required":false,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/account-assignment.update.schema.json","description":"A Schema for updating an accounting account assignment","type":"object","properties":{"accAccountUuid":{"type":"string","format":"uuid","description":"The UUID of the AccAccount, that should be used when booking."},"currencyCode":{"type":["null","string"],"pattern":"^[A-Z]{3}$","description":"ISO code of the currency. When set, the assignment is only getting used, when a booking in the set currency is being booked."},"taxRateUuid":{"type":["null","string"],"format":"uuid","description":"UUID of a tax rate. When set, the assignment is only getting used, when a booking with the set tax rate is being booked."},"paymentMethod":{"type":["null","string"],"enum":[null,"BANK","BITPAY","CARD_TERMINAL","CASH","CASH_ON_DELIVERY","INSTANT_TRANSFER","PAYPAL","TWINT","WIR","VOUCHER_OWN","VOUCHER_THIRD_PARTY","CREDIT_NOTE_OFFSET","DISCOUNT","CASH_DISCOUNT","DEBIT_LOSS","DEBIT_CREDIT_CARD","DONATION","CARD_COMMISSIONS","CURRENT_ACCOUNT","PREPAYMENT","PRIVATE","MAESTRO","MASTERCARD","VISA","AMEX","POSTFINANCE","DUNNING_REMISSION"],"description":"Method of a Payment. When set, the assignment is only getting used, when a payment with the set payment method is being booked."},"direction":{"type":["null","string"],"enum":[null,"IN","OUT"],"description":"Direction of a Payment. When set, the assignment is only getting used, when a payment with the set direction is being booked."},"bankAccountUuid":{"type":["null","string"],"format":"uuid","description":"UUID of a bank account. Only applies to Type PAYMENT_TYPE with Payment Method BANK."},"paymentCardUuid":{"type":["null","string"],"format":"uuid","description":"UUID of a payment card. Only applies to Type PAYMENT_TYPE with Payment Method DEBIT_CREDIT_CARD."}},"additionalProperties":false}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Accounting Account Assignment with Details","properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["PAYMENT_TYPE","COLLECT_INVOICE","COLLECT_RECEIPT","VAT_REVENUE","VAT_EFFORTS","VAT_INPUT","VAT_EXPORT","VAT_ACQUISITION","ON_ACCOUNT","CLOSING_INCOME","CLOSING_PASSIVE","DEFAULT_REVENUE","DEFAULT_EFFORTS","FOREX_REVENUE","FOREX_EFFORTS","ROUNDING_INVOICE","ROUNDING_RECEIPT","CREDIT_NOTE_OFFSET_DEBITOR","CREDIT_NOTE_OFFSET_CREDITOR","DUNNING_FEES"]},"accAccount":{"properties":{"exists":{"type":"boolean"},"uuid":{"type":["string","null"],"format":"uuid"},"number":{"type":["string","null"]},"name":{"type":["string","null"]}},"type":"object"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"paymentMethod":{"type":["string","null"],"enum":["BANK","BITPAY","CARD_TERMINAL","CASH","CASH_ON_DELIVERY","INSTANT_TRANSFER","PAYPAL","TWINT","WIR","VOUCHER_OWN","VOUCHER_THIRD_PARTY","CREDIT_NOTE_OFFSET","DISCOUNT","CASH_DISCOUNT","DEBIT_LOSS","DEBIT_CREDIT_CARD","DONATION","CARD_COMMISSIONS","CURRENT_ACCOUNT","PREPAYMENT","PRIVATE","MAESTRO","MASTERCARD","VISA","AMEX","POSTFINANCE","DINERS_CARD","DUNNING_REMISSION"]},"direction":{"type":["string","null"],"enum":["IN","OUT"]},"taxRateUuid":{"type":["string","null"],"format":"uuid"},"bankAccountUuid":{"type":["string","null"],"format":"uuid"},"paymentCardUuid":{"type":["string","null"],"format":"uuid"},"flags":{"properties":{"isGenerated":{"type":"boolean"},"isRequired":{"type":"boolean"},"isComplete":{"type":"boolean"},"isSystem":{"type":"boolean"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/accounting"]}],"x-legacy-operation-id":"ac2396fd7e63e17d0d1a9202e80e4825","x-required-scopes":["accounting"]},"delete":{"tags":["accounting_accounting-assignments"],"summary":"Delete assignment","description":"Delete an assignment","operationId":"accounting_delete_account_assignments","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"assignmentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/accounting"]}],"x-legacy-operation-id":"9d1adbdf86885fc8563fbfd574bd5cc0","x-required-scopes":["accounting"]}},"/accounts/{accountUuid}/accounting/v2/tax-timelines/{taxTimelineUuid}":{"get":{"tags":["accounting_accounting-tax-timelines"],"summary":"Get single tax timelines","description":"Get single tax timelines","operationId":"accounting_get_tax_timelines","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"taxTimelineUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Tax Timeline","properties":{"uuid":{"type":"string","format":"uuid"},"taxMethod":{"type":"string","enum":["tax_free","brut_method","net_method","flat_rate_method"]},"taxConsideration":{"type":"string","enum":["AGREED","RECEIVED"]},"validFrom":{"type":"string","format":"date"},"defaultTaxRate":{"properties":{"uuid":{"type":"string","format":"uuid"},"rate":{"type":"number"}},"type":"object"},"flatTaxConfiguration":{"properties":{"flatTaxRateStandard323":{"type":"string","format":"uuid"},"flatTaxRateReduced333":{"type":"string","format":"uuid"},"flatTaxRateAccommodation333":{"type":"string","format":"uuid"},"flatTaxRateStandard322":{"type":"string","format":"uuid"},"flatTaxRateReduced332":{"type":"string","format":"uuid"},"flatTaxRateAccommodation332":{"type":"string","format":"uuid"}},"type":["object","null"]}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/accounting"]}],"x-legacy-operation-id":"8cbef8627bc31e82d3b4a339a9721a36","x-required-scopes":["accounting"]},"patch":{"tags":["accounting_accounting-tax-timelines"],"summary":"Update tax timeline","description":"Update tax timeline","operationId":"accounting_update_tax_timelines","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"taxTimelineUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update tax timeline","required":false,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/tax-timeline.update.schema.json","description":"A Schema for updating a tax timeline","type":"object","properties":{"taxMethod":{"type":"string","enum":["tax_free","brut_method","net_method","flat_rate_method"],"description":"The type of tax method for this period."},"taxConsideration":{"type":"string","enum":["AGREED","RECEIVED"],"description":"The type of tax consideration for this period."},"defaultTaxRateUuid":{"type":"string","format":"uuid","description":"The UUID of the tax rate, that should be prefilled on invoices by default."},"validFrom":{"type":"string","format":"date","description":"Date from which on this tax timeline is to be used. This date has to be on the first of any quarter."},"flatTaxConfiguration":{"type":"object","properties":{"flatTaxRateStandard323":{"type":"string","format":"uuid","description":"The UUID of the flat tax rate, that should be applied instead of the standard tax rate (currently 8.1%) that will be placed into figure 323."},"flatTaxRateStandard322":{"type":"string","format":"uuid","description":"The UUID of the flat tax rate, that should be applied instead of the old standard tax rate (currently 7.7%) that will be placed into figure 322."},"flatTaxRateReduced333":{"type":"string","format":"uuid","description":"The UUID of the flat tax rate, that should be applied instead of the reduced tax rate (currently 2.6%) that will be placed into figure 333."},"flatTaxRateReduced332":{"type":"string","format":"uuid","description":"The UUID of the flat tax rate, that should be applied instead of the old reduced tax rate (currently 2.5%) that will be placed into figure 332."},"flatTaxRateAccommodation333":{"type":"string","format":"uuid","description":"The UUID of the flat tax rate, that should be applied instead of the accommodation tax rate (currently 3.7%) that will be placed into figure 333."},"flatTaxRateAccommodation332":{"type":"string","format":"uuid","description":"The UUID of the flat tax rate, that should be applied instead of the old accommodation tax rate (currently 3.6%) that will be placed into figure 332."}},"required":["flatTaxRateStandard323","flatTaxRateReduced333","flatTaxRateAccommodation333","flatTaxRateStandard322","flatTaxRateReduced332","flatTaxRateAccommodation332"]}},"additionalProperties":false,"if":{"required":["taxMethod"],"properties":{"taxMethod":{"const":"flat_rate_method"}}},"then":{"required":["flatTaxConfiguration"]}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Tax Timeline","properties":{"uuid":{"type":"string","format":"uuid"},"taxMethod":{"type":"string","enum":["tax_free","brut_method","net_method","flat_rate_method"]},"taxConsideration":{"type":"string","enum":["AGREED","RECEIVED"]},"validFrom":{"type":"string","format":"date"},"defaultTaxRate":{"properties":{"uuid":{"type":"string","format":"uuid"},"rate":{"type":"number"}},"type":"object"},"flatTaxConfiguration":{"properties":{"flatTaxRateStandard323":{"type":"string","format":"uuid"},"flatTaxRateReduced333":{"type":"string","format":"uuid"},"flatTaxRateAccommodation333":{"type":"string","format":"uuid"},"flatTaxRateStandard322":{"type":"string","format":"uuid"},"flatTaxRateReduced332":{"type":"string","format":"uuid"},"flatTaxRateAccommodation332":{"type":"string","format":"uuid"}},"type":["object","null"]}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/accounting"]}],"x-legacy-operation-id":"6a16b53f5a4866672258b6131f10ee35","x-required-scopes":["accounting"]},"delete":{"tags":["accounting_accounting-tax-timelines"],"summary":"Delete tax timeline","description":"Delete tax timeline","operationId":"accounting_delete_tax_timelines","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"taxTimelineUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/accounting"]}],"x-legacy-operation-id":"d4690bd8f7fac483ae20d5a7d2637d1d","x-required-scopes":["accounting"]}},"/accounts/{accountUuid}/accounting/v2/account-assignments/bank-account/{bankAccountUuid}":{"post":{"tags":["accounting_accounting-assignments"],"summary":"Create bank assignment","description":"Create a new banking assignment","operationId":"accounting_create_bank_account","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"bankAccountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create banking assignment","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/account-assignment-bank.create.schema.json","description":"A Schema for creating a bank accounting assignment","type":"object","properties":{"accAccountUuid":{"type":"string","format":"uuid","description":"The UUID of the AccAccount, that should be used when booking."}},"required":["accAccountUuid"],"additionalProperties":false}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Bank Assignment Account Resource","properties":{"accAccountUuid":{"type":"string","format":"uuid"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/accounting"]}],"x-legacy-operation-id":"8e67dc3cc128156796bc0f29ca967a51","x-required-scopes":["accounting"]}},"/accounts/{accountUuid}/accounting/v2/journal-years/{journalYearUuid}/preset":{"get":{"tags":["accounting_accounting-preset"],"summary":"Get all presets of Accounting Accounts","description":"Get all presets of Accounting Accounts","operationId":"accounting_list_preset","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"journalYearUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Preset of Accounting Accounts","properties":{"accAccountUuid":{"type":"string","format":"uuid"},"accountNumber":{"type":"string"},"description":{"type":"string"},"currencyCode":{"type":"string","format":"iso-4217","maxLength":3,"minLength":3},"classificationArea":{"type":"string","enum":["A","B"]},"value":{"type":"number","format":"float"},"exchangeValue":{"type":"number","format":"float"},"exchangeRate":{"type":"number","format":"float"},"preYearEndingBalance":{"type":"number","format":"float"},"exchangePreYearEndingBalance":{"type":"number","format":"float"},"preYearEndingBalanceFormatted":{"type":"string"},"exchangePreYearEndingBalanceFormatted":{"type":"string"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/accounting"]}],"x-legacy-operation-id":"334865e7a5458c06c150446800f8a642","x-required-scopes":["accounting"]},"post":{"tags":["accounting_accounting-preset"],"summary":"Set presets of Accounting Accounts","description":"Set presets of Accounting Accounts","operationId":"accounting_create_preset","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"journalYearUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Set presets of Accounting Accounts","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/preset-acc-accounts.schema.json","description":"A Schema for creating saldo opening for acc accounts","type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"accAccountUuid":{"type":"string","format":"uuid"},"value":{"type":"number"},"exchangeValue":{"type":"number"}},"required":["accAccountUuid","value","exchangeValue"],"additionalProperties":false},"minItems":1}},"required":["accounts"],"additionalProperties":false}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/accounting"]}],"x-legacy-operation-id":"a70b144adff8b2e15cff4c79da3f5475","x-required-scopes":["accounting"]}},"/accounts/{accountUuid}/accounting/v2/journal-years/{journalYearUuid}/preset-auto":{"post":{"tags":["accounting_accounting-preset"],"summary":"Auto presetting of Accounting Accounts","description":"Automatically sets pre year ending saldo as saldo opening","operationId":"accounting_create_preset_auto","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"journalYearUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/accounting"]}],"x-legacy-operation-id":"fd032d1712f956030cae89b630d1a588","x-required-scopes":["accounting"]}},"/users/v2/me":{"get":{"tags":["accounts_users"],"summary":"Get user profile","description":"Get the profile of the current user","operationId":"users_list_me","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"User Resource Schema","description":"The current users profile","properties":{"uuid":{"type":"string","format":"uuid"},"oauthUserUuid":{"type":["string","null"],"format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"},"role":{"type":"string","enum":["STANDARD","SUPPORT","SUPPORT_AGENT","SUPPORT_MANAGER","ABANINJA_ADMIN"]}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/profile"]}],"x-legacy-operation-id":"487029d0787aee5d6488594202f5cd9e","x-required-scopes":["profile"]}},"/accounts/{accountUuid}/v2/users":{"get":{"tags":["accounts_users"],"summary":"Get users","description":"Get all users for an account","operationId":"v2_list_users","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"User Resource","properties":{"uuid":{"type":"string","format":"uuid"},"email":{"type":["string","null"],"format":"email"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"isOwner":{"type":"boolean"},"isAdmin":{"type":"boolean"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/accounts"]}],"x-legacy-operation-id":"f3d1866e150badb823642f7e55bfe9f5","x-required-scopes":["accounts"]}},"/accounts/v2/accounts/{accountUuid}":{"get":{"tags":["accounts_accounts"],"summary":"Get account","description":"Get account information","operationId":"accounts_get_accounts","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Account Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"type":"string","format":"email"},"type":{"type":"string","enum":["SWISS21","NINJABOX","STR"]},"locale":{"type":"string","enum":["de","en","fr","it"]},"currencyCode":{"type":"string","format":"iso-4217","maxLength":3,"minLength":3},"lastLogin":{"type":["string","null"],"format":"date-time"},"hasLogo":{"type":"boolean"},"isInitialized":{"description":"shows if the account is finished setting up","type":"boolean"},"industryCode":{"description":"NOGA code","type":["string","null"]},"companyKindCode":{"type":["string","null"],"enum":["TRADE","PRODUCTION","SERVICE","PRIVATE"]},"legalFormCode":{"type":["string","null"],"enum":["SOLE_PROPRIETORSHIP","GENERAL_PARTNERSHIP","LIMITED_PARTNERSHIP","LIMITED_COMPANY","LIMITED_LIABILITY_COMPANY","ASSOCIATION"]},"language":{"type":"string","enum":["de","en","fr","it"]}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/accounts","https://api.abaninja.ch/auth/profile","https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"bd9ba82ee57865ab384ee4fb21b8e543","x-required-scopes":["accounts","profile","settings"]}},"/users/v2/me/accounts":{"get":{"tags":["accounts_users"],"summary":"List user accounts","description":"Lists all accounts of the current user","operationId":"users_list_accounts","parameters":[{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"User Account Resource Schema","description":"The current users account","properties":{"uuid":{"type":"string","format":"uuid"},"appInstanceUuid":{"type":["string","null"],"format":"uuid"},"name":{"type":"string"},"email":{"type":["string","null"],"format":"email"},"type":{"type":"string","enum":["SWISS21","NINJABOX","STR"]},"lastLogin":{"type":["string","null"],"format":"date-time"},"isOwner":{"type":"boolean"},"accountRole":{"type":"string","enum":["OWNER","ADMIN","EMPLOYEE","SUPPORT","DC"]}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/profile"]}],"x-legacy-operation-id":"e168aad61bdc1dd5e33c4f9a0400002a","x-required-scopes":["profile"]}},"/accounts/{accountUuid}/v2/users/{userUuid}":{"get":{"tags":["accounts_users"],"summary":"Get user","description":"Get a user for an account","operationId":"v2_get_users","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"userUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"User Resource","properties":{"uuid":{"type":"string","format":"uuid"},"email":{"type":["string","null"],"format":"email"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"isOwner":{"type":"boolean"},"isAdmin":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/accounts"]}],"x-legacy-operation-id":"72728e9b7df7bc74e61cb994ab1e88bb","x-required-scopes":["accounts"]}},"/accounts/v2/accounts/{accountUuid}/logo":{"get":{"tags":["accounts_accounts"],"summary":"Get logo","description":"Get the account logo","operationId":"accounts_list_logo","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","headers":{"Content-Type":{"schema":{"type":"string","enum":["image/jpeg"]}},"Content-Length":{"schema":{"type":"integer"}}},"content":{"image/jpeg":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"No logo available","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/accounts","https://api.abaninja.ch/auth/profile","https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"7a12d935a96a3ba786fe1894c513df30","x-required-scopes":["accounts","profile","settings"]},"post":{"tags":["accounts_accounts"],"summary":"Upload logo","description":"Upload a new account logo","operationId":"accounts_create_logo","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["logo"],"properties":{"logo":{"type":"string","format":"binary"}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/accounts","https://api.abaninja.ch/auth/profile","https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"6e0c998e1a3ecfab6bafadd6aac8c945","x-required-scopes":["accounts","profile","settings"]}},"/accounts/{accountUuid}/addresses/v2/addresses":{"post":{"summary":"Create new address for given account","description":"Creating a new address in AbaNinja","tags":["addresses_Addresses"],"parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"force","in":"query","description":"Force saving of Address. Even when duplicates were found. Default: false\n","schema":{"type":"boolean"}}],"requestBody":{"description":"New Address","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AddressesCompanyBody"},{"$ref":"#/components/schemas/AddressesPersonBody"}]}}},"required":true},"responses":{"201":{"description":"Address created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"oneOf":[{"$ref":"#/components/schemas/AddressesCompany"},{"$ref":"#/components/schemas/AddressesPerson"}]}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"description":"Address duplicates found","content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/AddressesPerson"},{"$ref":"#/components/schemas/AddressesCompany"}]}}}}}},"operationId":"addresses_create_addresses","security":[{"ApiToken":[]}]}},"/accounts/{accountUuid}/addresses/v2/check-customer-number":{"get":{"summary":"Check if the customerNumber already in use or not","tags":["addresses_Addresses"],"responses":{"200":{"description":"This customer number is currently not in use"},"400":{"description":"This customer number is already in use"}},"parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"customerNumber","description":"The customer number to check","required":true,"in":"query","schema":{"type":"string"}},{"name":"addressUuid","in":"query","description":"The address UUID to ignore for this check","schema":{"type":"string","format":"uuid"}}],"operationId":"addresses_list_check_customer_number","security":[{"ApiToken":[]}]}},"/accounts/{accountUuid}/addresses/v2/companies":{"get":{"summary":"Get a list of company addresses for given account","description":"This return a list of available company addresses for the given account","tags":["addresses_Addresses"],"responses":{"200":{"description":"List of Addresses","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressesCompanies"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}},"parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"tags[]","in":"query","explode":true,"style":"form","schema":{"type":"array","items":{"type":"string"}}}],"operationId":"addresses_list_companies","security":[{"ApiToken":[]}]}},"/accounts/{accountUuid}/addresses/v2/persons":{"get":{"summary":"Get a list of person addresses for given account","description":"This return a list of available company addresses for the given account","tags":["addresses_Addresses"],"responses":{"200":{"description":"List of Addresses","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressesPersons"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}},"parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"tags[]","in":"query","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"operationId":"addresses_list_persons","security":[{"ApiToken":[]}]}},"/accounts/{accountUuid}/addresses/v2/companies/{companyUuid}":{"get":{"summary":"Single company","description":"Returns data for one company only","tags":["addresses_Addresses"],"responses":{"200":{"description":"Requested company","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AddressesCompany"}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}},"parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"companyUuid","in":"path","schema":{"type":"string","format":"uuid"},"required":true,"description":"The id of the address"}],"operationId":"addresses_get_companies","security":[{"ApiToken":[]}]},"patch":{"summary":"Single company update","description":"Updates single company","tags":["addresses_Addresses"],"requestBody":{"description":"Addressfields to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressesCompany"}}}},"responses":{"200":{"description":"Address updated"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}},"parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"companyUuid","in":"path","schema":{"type":"string","format":"uuid"},"required":true,"description":"The id of the address"}],"operationId":"addresses_update_companies","security":[{"ApiToken":[]}]},"delete":{"summary":"Delete company","tags":["addresses_Addresses"],"responses":{"200":{"description":"Company deleted"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"description":"Company not deleted. Is in use"}},"parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"companyUuid","in":"path","schema":{"type":"string","format":"uuid"},"required":true,"description":"The id of the address"}],"operationId":"addresses_delete_companies","security":[{"ApiToken":[]}]}},"/accounts/{accountUuid}/addresses/v2/persons/{personUuid}":{"get":{"summary":"Single person access","description":"Returns data for one company only","tags":["addresses_Addresses"],"responses":{"200":{"description":"Requested address","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AddressesPerson"}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}},"parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"personUuid","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"operationId":"addresses_get_persons","security":[{"ApiToken":[]}]},"patch":{"summary":"Single person update","description":"Updates single person","tags":["addresses_Addresses"],"requestBody":{"description":"Addressfields to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressesPerson"}}}},"responses":{"200":{"description":"Address updated"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}},"parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"personUuid","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"operationId":"addresses_update_persons","security":[{"ApiToken":[]}]},"delete":{"summary":"Delete person","tags":["addresses_Addresses"],"responses":{"200":{"description":"Person deleted"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"description":"Person not deleted. Is in use"}},"parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"personUuid","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"operationId":"addresses_delete_persons","security":[{"ApiToken":[]}]}},"/accounts/{accountUuid}/documents/v2/contract-notes":{"get":{"tags":["documents_document-contract-notes"],"summary":"Get contract notes","description":"Get contract notes","operationId":"documents_list_contract_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"is_template","in":"query","description":"get templates","required":false,"schema":{"type":"boolean","default":false}},{"name":"updatedSince","in":"query","description":"filter for updated items","required":false,"schema":{"anyOf":[{"type":["string","null"],"format":"date","default":null},{"type":["string","null"],"format":"date-time","default":null}]}},{"name":"limit","in":"query","description":"pagination limit","required":false,"schema":{"type":["number","null"],"maximum":400,"minimum":1}},{"name":"page","in":"query","description":"pagination page","required":false,"schema":{"type":["number","null"],"default":1,"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Contract Note Collection Item Resource","description":"Resource used in collections","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"number","format":"int64","deprecated":true},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"contractNoteDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"receiver":{"oneOf":[{"title":"Lite Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"customerNumber":{"type":["string","null"]},"name":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"}},"type":"object"},{"title":"Lite Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"customerNumber":{"type":["string","null"]},"name":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"}},"type":"object"}]},"documentTotal":{"type":"number","format":"float"},"contractNoteNumber":{"type":"string"},"isArchived":{"type":"boolean"},"isCancelled":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"9db0a2564b6304a1241d4736af44a54b","x-required-scopes":["customers"]},"post":{"tags":["documents_document-contract-notes"],"summary":"Create contract note","description":"Create contract note","operationId":"documents_create_contract_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create contract notes","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/contract-note.schema.json","title":"Contract notes","description":"A Schema for creating contract notes in AbaNinja over API","type":"object","properties":{"documents":{"type":"array","items":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"contractNoteDate":{"type":"string","format":"date"},"dueDate":{"type":["null","string"],"format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"paymentInstructions":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/payment-instructions-bank-account.schema.json","title":"Payment Instructions Bank Account","description":"Payment Instruction Schema for AbaNinja Invoice Json without reference","oneOf":[{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"}},"required":["qrIban"]},{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"}},"required":["bankAccountUuid"]}],"$defs":{"ibanInstruction":{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},"qrIbanInstruction":{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"}},"required":["qrIban"]},"bankAccountReference":{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"}},"required":["bankAccountUuid"]}}}]},"pricesIncludeVat":{"type":"boolean","description":"Controls if singlePrice includes vat or not"},"documentTotal":{"type":"number","description":"Total Amount incl. VAT"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]}},"required":["contractNoteDate","documentTotal","pricesIncludeVat","positions"],"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]},"minItems":1}},"required":["documents"],"$defs":{"singleContractNote":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"contractNoteDate":{"type":"string","format":"date"},"dueDate":{"type":["null","string"],"format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"paymentInstructions":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/payment-instructions-bank-account.schema.json","title":"Payment Instructions Bank Account","description":"Payment Instruction Schema for AbaNinja Invoice Json without reference","oneOf":[{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"}},"required":["qrIban"]},{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"}},"required":["bankAccountUuid"]}],"$defs":{"ibanInstruction":{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},"qrIbanInstruction":{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"}},"required":["qrIban"]},"bankAccountReference":{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"}},"required":["bankAccountUuid"]}}}]},"pricesIncludeVat":{"type":"boolean","description":"Controls if singlePrice includes vat or not"},"documentTotal":{"type":"number","description":"Total Amount incl. VAT"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]}},"required":["contractNoteDate","documentTotal","pricesIncludeVat","positions"],"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]}}}}}},"responses":{"201":{"description":"Contract note created","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"title":"Contract Note Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"contractNoteDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"paymentInstructions":{"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Bank Account Iban Resource","description":"Payment instructions bank account using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction Bank Account QrIban Resource","description":"Payment instructions bank account using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"}},"type":"object"}]},"pricesIncludeVat":{"type":"boolean"},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"contractNoteNumber":{"type":"string"},"type":{"type":"string","enum":["invoice"]},"documentDiscount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"}}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"202":{"description":"Asynchronous processing","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Asynchronous Import Resource","description":"Resource for asynchronous document imports","properties":{"status":{"type":"string","format":"uri"},"queueUuid":{"type":"string","format":"uuid"}},"type":"object"},"status":{"example":202}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"5947827fb8b1020bac675f59b57ad23e","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes":{"get":{"tags":["documents_document-credit-notes"],"summary":"Get credit notes","description":"Get credit notes","operationId":"documents_list_credit_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"is_template","in":"query","description":"get templates","required":false,"schema":{"type":"boolean","default":false}},{"name":"updatedSince","in":"query","description":"filter for updated items","required":false,"schema":{"anyOf":[{"type":["string","null"],"format":"date","default":null},{"type":["string","null"],"format":"date-time","default":null}]}},{"name":"limit","in":"query","description":"pagination limit","required":false,"schema":{"type":["number","null"],"maximum":400,"minimum":1}},{"name":"page","in":"query","description":"pagination page","required":false,"schema":{"type":["number","null"],"default":1,"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"title":"Credit Note Collection Item Resource","description":"Resource used in collections","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"number","format":"int64","deprecated":true},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"creditNoteNumber":{"type":"string"},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"documentTotal":{"type":"number","format":"float"},"creditNoteDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"updatedAt":{"type":"string","format":"date-time"},"isArchived":{"type":"boolean"},"isCancelled":{"type":"boolean"},"openAmount":{"type":"number","format":"float"},"receiver":{"oneOf":[{"title":"Lite Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"customerNumber":{"type":["string","null"]},"name":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"}},"type":"object"},{"title":"Lite Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"customerNumber":{"type":["string","null"]},"name":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"}},"type":"object"}]},"reference":{"type":"string"},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"title":{"type":["string","null"]},"isTemplate":{"type":"boolean"}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"8d4bd89274dc8315dfa9083245f0589d","x-required-scopes":["customers"]},"post":{"tags":["documents_document-credit-notes"],"summary":"Create credit note","description":"Create credit note","operationId":"documents_create_credit_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create credit notes","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/credit-note.schema.json","title":"Credit notes","description":"A Schema for creating credit notes in AbaNinja over API","type":"object","properties":{"documents":{"type":"array","items":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"creditNoteDate":{"type":"string","format":"date"},"dueDate":{"type":["null","string"],"format":"date"},"pricesIncludeVat":{"type":"boolean","description":"Controls if single_price and position_total includes vat or not"},"documentTotal":{"type":"number","description":"Total Amount incl. VAT"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]}},"required":["creditNoteDate","documentTotal","pricesIncludeVat","positions"],"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]},"minItems":1}},"required":["documents"],"$defs":{"singleCreditNote":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"creditNoteDate":{"type":"string","format":"date"},"dueDate":{"type":["null","string"],"format":"date"},"pricesIncludeVat":{"type":"boolean","description":"Controls if single_price and position_total includes vat or not"},"documentTotal":{"type":"number","description":"Total Amount incl. VAT"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]}},"required":["creditNoteDate","documentTotal","pricesIncludeVat","positions"],"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]}}}}}},"responses":{"201":{"description":"Credit note created","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"title":"Credit Note Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"creditNoteDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"pricesIncludeVat":{"type":"boolean"},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"creditNoteNumber":{"type":"string"},"openAmount":{"type":"number","format":"float"},"abanetSendAt":{"type":["string","null"],"format":"date-time"},"abanetConfirmedAt":{"type":["string","null"],"format":"date-time"},"type":{"type":"string","enum":["credit_note"]},"documentDiscount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"}}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"202":{"description":"Asynchronous processing","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Asynchronous Import Resource","description":"Resource for asynchronous document imports","properties":{"status":{"type":"string","format":"uri"},"queueUuid":{"type":"string","format":"uuid"}},"type":"object"},"status":{"example":202}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"a90ef75e0081e26fcf3d71b054d22145","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes":{"get":{"tags":["documents_document-delivery-notes"],"summary":"Get delivery notes","description":"Get delivery notes","operationId":"documents_list_delivery_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"is_template","in":"query","description":"get templates","required":false,"schema":{"type":"boolean","default":false}},{"name":"updatedSince","in":"query","description":"filter for updated items","required":false,"schema":{"anyOf":[{"type":["string","null"],"format":"date","default":null},{"type":["string","null"],"format":"date-time","default":null}]}},{"name":"limit","in":"query","description":"pagination limit","required":false,"schema":{"type":["number","null"],"maximum":400,"minimum":1}},{"name":"page","in":"query","description":"pagination page","required":false,"schema":{"type":["number","null"],"default":1,"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"title":"Delivery Note Collection Item Resource","description":"Resource used in collections","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"number","format":"int64","deprecated":true},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"deliveryNoteDate":{"type":["string","null"],"format":"date"},"deliveryNoteNumber":{"type":"string"},"isArchived":{"type":"boolean"},"isCancelled":{"type":"boolean"},"receiver":{"oneOf":[{"title":"Lite Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"customerNumber":{"type":["string","null"]},"name":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"}},"type":"object"},{"title":"Lite Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"customerNumber":{"type":["string","null"]},"name":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"}},"type":"object"}]},"reference":{"type":"string"},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"title":{"type":["string","null"]},"updatedAt":{"type":"string","format":"date-time"},"isTemplate":{"type":"boolean"}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"1438e5773c6363e26cc28ba03ab1fc0b","x-required-scopes":["customers"]},"post":{"tags":["documents_document-delivery-notes"],"summary":"Create delivery note","description":"Create delivery note","operationId":"documents_create_delivery_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create delivery notes","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/delivery-note.schema.json","title":"Delivery notes","description":"A Schema for creating delivery notes in AbaNinja over API","type":"object","properties":{"documents":{"type":"array","items":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"deliveryNoteDate":{"type":"string","format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"pricesIncludeVat":{"type":"boolean","description":"Controls if prices includes vat or not. If omitted the accounts default setting is used."},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/delivery-note-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber, productDescription and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over unitCode"},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Price, which will be used when converting the delivery note to another document like an invoice"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\". Used only when converting the delivery note to another document like an invoice."},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"],"description":"VAT to use. Is precedented by \"vatUuid\". Used only when converting the delivery note to another document like an invoice."}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber, productDescription and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over unitCode"},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Price, which will be used when converting the delivery note to another document like an invoice"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\". Used only when converting the delivery note to another document like an invoice."},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"],"description":"VAT to use. Is precedented by \"vatUuid\". Used only when converting the delivery note to another document like an invoice."}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1},"showCollapsed":{"type":"boolean","default":true}},"required":["title","kind","items"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber, productDescription and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over unitCode"},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Price, which will be used when converting the delivery note to another document like an invoice"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\". Used only when converting the delivery note to another document like an invoice."},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"],"description":"VAT to use. Is precedented by \"vatUuid\". Used only when converting the delivery note to another document like an invoice."}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber, productDescription and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over unitCode"},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Price, which will be used when converting the delivery note to another document like an invoice"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\". Used only when converting the delivery note to another document like an invoice."},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"],"description":"VAT to use. Is precedented by \"vatUuid\". Used only when converting the delivery note to another document like an invoice."}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1},"showCollapsed":{"type":"boolean","default":true}},"required":["title","kind","items"]}}},"minItems":1},"documentDiscount":{"description":"Discount, which only will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]}},"required":["deliveryNoteDate","positions"],"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]},"minItems":1}},"required":["documents"],"$defs":{"singleDeliveryNote":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"deliveryNoteDate":{"type":"string","format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"pricesIncludeVat":{"type":"boolean","description":"Controls if prices includes vat or not. If omitted the accounts default setting is used."},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/delivery-note-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber, productDescription and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over unitCode"},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Price, which will be used when converting the delivery note to another document like an invoice"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\". Used only when converting the delivery note to another document like an invoice."},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"],"description":"VAT to use. Is precedented by \"vatUuid\". Used only when converting the delivery note to another document like an invoice."}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber, productDescription and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over unitCode"},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Price, which will be used when converting the delivery note to another document like an invoice"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\". Used only when converting the delivery note to another document like an invoice."},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"],"description":"VAT to use. Is precedented by \"vatUuid\". Used only when converting the delivery note to another document like an invoice."}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1},"showCollapsed":{"type":"boolean","default":true}},"required":["title","kind","items"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber, productDescription and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over unitCode"},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Price, which will be used when converting the delivery note to another document like an invoice"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\". Used only when converting the delivery note to another document like an invoice."},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"],"description":"VAT to use. Is precedented by \"vatUuid\". Used only when converting the delivery note to another document like an invoice."}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber, productDescription and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over unitCode"},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Price, which will be used when converting the delivery note to another document like an invoice"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\". Used only when converting the delivery note to another document like an invoice."},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"],"description":"VAT to use. Is precedented by \"vatUuid\". Used only when converting the delivery note to another document like an invoice."}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1},"showCollapsed":{"type":"boolean","default":true}},"required":["title","kind","items"]}}},"minItems":1},"documentDiscount":{"description":"Discount, which only will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]}},"required":["deliveryNoteDate","positions"],"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]}}}}}},"responses":{"201":{"description":"Delivery note created","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"title":"Delivery Note Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"deliveryNoteDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"deliveryNoteNumber":{"type":"string"},"type":{"type":"string","enum":["delivery_note"]},"documentDiscount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"}}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"202":{"description":"Asynchronous processing","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Asynchronous Import Resource","description":"Resource for asynchronous document imports","properties":{"status":{"type":"string","format":"uri"},"queueUuid":{"type":"string","format":"uuid"}},"type":"object"},"status":{"example":202}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"7da60322aa209b143e5a26078a43b05c","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices":{"get":{"tags":["documents_document-invoices"],"summary":"Get invoices","description":"Get invoices","operationId":"documents_list_invoices","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"is_template","in":"query","description":"get templates","required":false,"schema":{"type":"boolean","default":false}},{"name":"updatedSince","in":"query","description":"filter for updated items","required":false,"schema":{"anyOf":[{"type":["string","null"],"format":"date","default":null},{"type":["string","null"],"format":"date-time","default":null}]}},{"name":"limit","in":"query","description":"pagination limit","required":false,"schema":{"type":["number","null"],"maximum":400,"minimum":1}},{"name":"page","in":"query","description":"pagination page","required":false,"schema":{"type":["number","null"],"default":1,"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"oneOf":[{"title":"Invoice Collection Item Resource","description":"Resource used in collections","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"number","format":"int64","deprecated":true},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"type":{"type":"string","enum":["invoice"]},"subtype":{"type":["string","null"],"enum":["partial","final","on_account","instalment","dunning"]},"reference":{"type":"string"},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"invoiceDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"receiver":{"oneOf":[{"title":"Lite Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"customerNumber":{"type":["string","null"]},"name":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"}},"type":"object"},{"title":"Lite Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"customerNumber":{"type":["string","null"]},"name":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"}},"type":"object"}]},"documentTotal":{"type":"number","format":"float"},"nextDunningDate":{"type":["string","null"],"format":"date"},"customDunningDate":{"type":["string","null"],"format":"date"},"dunningLevel":{"type":"string","enum":["REMINDER","FIRST_DUNNING","FINAL_DUNNING","NO_DUNNING"]},"invoiceNumber":{"description":"Equals to importedInvoiceNumber if set, otherwise systemInvoiceNumber","type":"string","deprecated":true},"importedInvoiceNumber":{"description":"The recognized invoiceNumber of the imported document","type":["string","null"]},"systemInvoiceNumber":{"description":"The invoiceNumber generated by AbaNinja","type":"string"},"isArchived":{"type":"boolean"},"isCancelled":{"type":"boolean"},"isImported":{"type":"boolean"},"openAmount":{"type":"number","format":"float"},"updatedAt":{"type":"string","format":"date-time"},"isTemplate":{"type":"boolean"}},"type":"object"},{"title":"Imported Invoice Collection Item Resource","description":"Resource used in collections","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"number","format":"int64","deprecated":true},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"type":{"type":"string","enum":["invoice"]},"subtype":{"type":["string","null"],"enum":["partial","final","on_account","instalment","dunning"]},"reference":{"type":"string"},"number":{"type":"string","deprecated":true},"invoiceNumber":{"description":"Equals to importedInvoiceNumber if set, otherwise systemInvoiceNumber","type":"string","deprecated":true},"importedInvoiceNumber":{"description":"The recognized invoiceNumber of the imported document","type":["string","null"]},"systemInvoiceNumber":{"description":"The invoiceNumber generated by AbaNinja","type":"string"},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"invoiceDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"receiver":{"oneOf":[{"oneOf":[{"title":"Lite Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"customerNumber":{"type":["string","null"]},"name":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"}},"type":"object"},{"title":"Lite Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"customerNumber":{"type":["string","null"]},"name":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"}},"type":"object"}]},{"type":"null"}]},"nextDunningDate":{"type":["string","null"],"format":"date"},"customDunningDate":{"type":["string","null"],"format":"date"},"dunningLevel":{"type":"string","enum":["REMINDER","FIRST_DUNNING","FINAL_DUNNING","NO_DUNNING"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"paymentInstructions":{"allOf":[{"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Bank Account Iban Resource","description":"Payment instructions bank account using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction Bank Account QrIban Resource","description":"Payment instructions bank account using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"}},"type":"object"}]}],"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Iban Resource","description":"Payment instructions using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]},"reference":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction QrIban Resource","description":"Payment instructions using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"},"reference":{"type":["string","null"]}},"type":"object"}]},"documentTotal":{"type":"number","format":"float"},"balance":{"type":"number","format":"float","deprecated":true},"openAmount":{"type":"number","format":"float"},"archived":{"type":"boolean","deprecated":true},"isArchived":{"type":"boolean"},"cancelled":{"type":"boolean","deprecated":true},"isCancelled":{"type":"boolean"},"isImported":{"type":"boolean"},"isTemplate":{"type":"boolean"},"cashDiscounts":{"type":"array","items":{"properties":{"days":{"type":"number","format":"int64"},"percentage":{"type":"number","format":"float"}},"type":"object"},"maxItems":3,"minItems":0},"documentDiscount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"}]}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"fe69a694d64645f98325550841e6e705","x-required-scopes":["customers"]},"post":{"tags":["documents_document-invoices"],"summary":"Create invoice","description":"Create invoices","operationId":"documents_create_invoices","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create invoices","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/invoice.schema.json","title":"Invoices","description":"A Schema for creating invoices in AbaNinja over API","type":"object","properties":{"documents":{"type":"array","items":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"invoiceDate":{"type":"string","format":"date"},"dueDate":{"type":["null","string"],"format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"paymentInstructions":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/payment-instructions.schema.json","title":"Payment Instructions","description":"Payment Instruction Schema for AbaNinja Invoice Json","oneOf":[{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}],"$defs":{"ibanInstruction":{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},"qrIbanInstruction":{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},"bankAccountReference":{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}}},"pricesIncludeVat":{"type":"boolean","description":"Controls if singlePrice includes vat or not"},"isVariantInvoice":{"type":"boolean","default":false},"documentTotal":{"type":"number","description":"Total Amount incl. VAT"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"cashDiscounts":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/cash-discount.schema.json","description":"Cash Discount Schema for AbaNinja Invoice Json","type":"object","properties":{"days":{"type":"integer","minimum":1,"maximum":60,"description":"Number of days"},"percentage":{"type":"number","minimum":0.5,"maximum":100}},"required":["days","percentage"]},"description":"Skonto","maxItems":3},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]}},"required":["invoiceDate","paymentInstructions","documentTotal","pricesIncludeVat","positions"],"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]},"minItems":1}},"required":["documents"],"$defs":{"singleInvoice":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"invoiceDate":{"type":"string","format":"date"},"dueDate":{"type":["null","string"],"format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"paymentInstructions":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/payment-instructions.schema.json","title":"Payment Instructions","description":"Payment Instruction Schema for AbaNinja Invoice Json","oneOf":[{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}],"$defs":{"ibanInstruction":{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},"qrIbanInstruction":{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},"bankAccountReference":{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}}},"pricesIncludeVat":{"type":"boolean","description":"Controls if singlePrice includes vat or not"},"isVariantInvoice":{"type":"boolean","default":false},"documentTotal":{"type":"number","description":"Total Amount incl. VAT"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"cashDiscounts":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/cash-discount.schema.json","description":"Cash Discount Schema for AbaNinja Invoice Json","type":"object","properties":{"days":{"type":"integer","minimum":1,"maximum":60,"description":"Number of days"},"percentage":{"type":"number","minimum":0.5,"maximum":100}},"required":["days","percentage"]},"description":"Skonto","maxItems":3},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]}},"required":["invoiceDate","paymentInstructions","documentTotal","pricesIncludeVat","positions"],"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]}}}}}},"responses":{"201":{"description":"Invoice created","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"title":"Invoice Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"invoiceDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"nextDunningDate":{"type":["string","null"],"format":"date"},"customDunningDate":{"type":["string","null"],"format":"date"},"dunningLevel":{"type":"string","enum":["REMINDER","FIRST_DUNNING","FINAL_DUNNING","NO_DUNNING"]},"paymentInstructions":{"allOf":[{"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Bank Account Iban Resource","description":"Payment instructions bank account using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction Bank Account QrIban Resource","description":"Payment instructions bank account using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"}},"type":"object"}]}],"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Iban Resource","description":"Payment instructions using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]},"reference":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction QrIban Resource","description":"Payment instructions using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"},"reference":{"type":["string","null"]}},"type":"object"}]},"pricesIncludeVat":{"type":"boolean"},"isVariantInvoice":{"type":"boolean"},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"isCollectiveBill":{"type":"boolean"},"invoiceNumber":{"description":"Equals to importedInvoiceNumber if set, otherwise systemInvoiceNumber","type":"string","deprecated":true},"importedInvoiceNumber":{"description":"The recognized invoiceNumber of the imported document","type":["string","null"]},"systemInvoiceNumber":{"description":"The invoiceNumber generated by AbaNinja","type":"string"},"openAmount":{"type":"number","format":"float"},"type":{"type":"string","enum":["invoice"]},"subtype":{"type":["string","null"],"enum":["partial","final","on_account","instalment","dunning"]},"abanetSendAt":{"type":["string","null"],"format":"date-time"},"abanetConfirmedAt":{"type":["string","null"],"format":"date-time"},"bookedAt":{"type":["string","null"],"format":"date-time"},"syncedAt":{"type":["string","null"],"format":"date-time"},"syncMessage":{"type":["string","null"]},"syncStatus":{"type":["string","null"],"enum":["OK","FAILED","INCORRECT_STATE","GENERAL_ERROR","CONNECTION_ERROR","BLOCKED_PREVIOUS_NOT_SYNCED"]},"cashDiscounts":{"type":"array","items":{"properties":{"days":{"type":"number","format":"int64"},"percentage":{"type":"number","format":"float"}},"type":"object"},"maxItems":3,"minItems":0},"documentDiscount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"}}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"202":{"description":"Asynchronous processing","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Asynchronous Import Resource","description":"Resource for asynchronous document imports","properties":{"status":{"type":"string","format":"uri"},"queueUuid":{"type":"string","format":"uuid"}},"type":"object"},"status":{"example":202}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"d5df668659a1d982c4a0ef984338993b","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/queue":{"get":{"tags":["documents_document-common"],"summary":"Get queues","description":"Get the document-mass-import queues","operationId":"documents_list_queue","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}},{"name":"type","in":"query","schema":{"type":["string","null"],"enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Mass Document Import Queue Collection Resource","description":"Describes the status of an document mass import, used in collections","properties":{"uuid":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"total":{"type":"integer"},"successful":{"type":"integer"},"failed":{"type":"integer"},"status":{"type":"string","enum":["pending","failed","finished","aborted"]}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers","https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"1a624e567dbd96d00cf952077f416109","x-required-scopes":["customers","suppliers"]}},"/accounts/{accountUuid}/documents/v2/quotes":{"get":{"tags":["documents_document-quotes"],"summary":"Get quotes","description":"Get quotes","operationId":"documents_list_quotes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"is_template","in":"query","description":"get templates","required":false,"schema":{"type":"boolean","default":false}},{"name":"updatedSince","in":"query","description":"filter for updated items","required":false,"schema":{"anyOf":[{"type":["string","null"],"format":"date","default":null},{"type":["string","null"],"format":"date-time","default":null}]}},{"name":"limit","in":"query","description":"pagination limit","required":false,"schema":{"type":["number","null"],"maximum":400,"minimum":1}},{"name":"page","in":"query","description":"pagination page","required":false,"schema":{"type":["number","null"],"default":1,"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"title":"Quote Collection Item Resource","description":"Resource used in collections","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"number","format":"int64","deprecated":true},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Lite Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"customerNumber":{"type":["string","null"]},"name":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"}},"type":"object"},{"title":"Lite Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"customerNumber":{"type":["string","null"]},"name":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"}},"type":"object"}]},"documentTotal":{"type":"number","format":"float"},"isArchived":{"type":"boolean"},"isCancelled":{"type":"boolean"},"quoteDate":{"type":["string","null"],"format":"date"},"validUntilDate":{"type":["string","null"],"format":"date"},"quoteNumber":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"isTemplate":{"type":"boolean"}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"831a23e436a51206a09a1cbe95341724","x-required-scopes":["customers"]},"post":{"tags":["documents_document-quotes"],"summary":"Create quote","description":"Create quotes","operationId":"documents_create_quotes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create quotes","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/quote.schema.json","title":"Quotes","description":"A Schema for creating quotes in AbaNinja over API","type":"object","properties":{"documents":{"type":"array","items":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"quoteDate":{"type":"string","format":"date"},"validUntilDate":{"type":["null","string"],"format":"date"},"pricesIncludeVat":{"type":"boolean","description":"Controls if single_price and position_total includes vat or not"},"documentTotal":{"type":"number","description":"Total Amount incl. VAT"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"signaturePage":{"type":"boolean","default":false},"deepSignSignatureMode":{"type":["string","null"],"enum":["timestamp","advanced","qualified",null]},"signees":{"description":"if set at least one of each signee type (receiver, sender) is required","type":["array","null"],"maxItems":2,"minItems":2,"items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-signee.schema.json","title":"Signee","description":"Signee for documents","type":"object","oneOf":[{"title":"Receiver signee","type":"object","properties":{"type":{"const":"receiver"},"personUuid":{"description":"If the receiver address is a company, a person is needed","type":["null","string"],"format":"uuid"}}},{"title":"Sender signee","type":"object","properties":{"type":{"const":"sender"},"userUuid":{"type":"string","format":"uuid"}},"required":["userUuid"]}],"properties":{"type":{"type":"string","enum":["receiver","sender"]},"signOrder":{"description":"Order of the signature","type":"number","format":"int64"}},"required":["type"],"$defs":{"receiverSignee":{"title":"Receiver signee","type":"object","properties":{"type":{"const":"receiver"},"personUuid":{"description":"If the receiver address is a company, a person is needed","type":["null","string"],"format":"uuid"}}},"senderSignee":{"title":"Sender signee","type":"object","properties":{"type":{"const":"sender"},"userUuid":{"type":"string","format":"uuid"}},"required":["userUuid"]}}}}},"required":["quoteDate","documentTotal","pricesIncludeVat","positions"],"if":{"anyOf":[{"properties":{"signaturePage":{"const":true}},"required":["signaturePage"]},{"properties":{"signees":{"type":"array"}},"required":["signees"]}]},"then":{"properties":{"signees":{"type":"array"},"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["signees","receiver"]},"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]},"minItems":1}},"required":["documents"],"$defs":{"singleQuote":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"quoteDate":{"type":"string","format":"date"},"validUntilDate":{"type":["null","string"],"format":"date"},"pricesIncludeVat":{"type":"boolean","description":"Controls if single_price and position_total includes vat or not"},"documentTotal":{"type":"number","description":"Total Amount incl. VAT"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"signaturePage":{"type":"boolean","default":false},"deepSignSignatureMode":{"type":["string","null"],"enum":["timestamp","advanced","qualified",null]},"signees":{"description":"if set at least one of each signee type (receiver, sender) is required","type":["array","null"],"maxItems":2,"minItems":2,"items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-signee.schema.json","title":"Signee","description":"Signee for documents","type":"object","oneOf":[{"title":"Receiver signee","type":"object","properties":{"type":{"const":"receiver"},"personUuid":{"description":"If the receiver address is a company, a person is needed","type":["null","string"],"format":"uuid"}}},{"title":"Sender signee","type":"object","properties":{"type":{"const":"sender"},"userUuid":{"type":"string","format":"uuid"}},"required":["userUuid"]}],"properties":{"type":{"type":"string","enum":["receiver","sender"]},"signOrder":{"description":"Order of the signature","type":"number","format":"int64"}},"required":["type"],"$defs":{"receiverSignee":{"title":"Receiver signee","type":"object","properties":{"type":{"const":"receiver"},"personUuid":{"description":"If the receiver address is a company, a person is needed","type":["null","string"],"format":"uuid"}}},"senderSignee":{"title":"Sender signee","type":"object","properties":{"type":{"const":"sender"},"userUuid":{"type":"string","format":"uuid"}},"required":["userUuid"]}}}}},"required":["quoteDate","documentTotal","pricesIncludeVat","positions"],"if":{"anyOf":[{"properties":{"signaturePage":{"const":true}},"required":["signaturePage"]},{"properties":{"signees":{"type":"array"}},"required":["signees"]}]},"then":{"properties":{"signees":{"type":"array"},"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["signees","receiver"]},"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]}}}}}},"responses":{"201":{"description":"Quote created","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"title":"Quote Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"quoteDate":{"type":["string","null"],"format":"date"},"validUntilDate":{"type":["string","null"],"format":"date"},"pricesIncludeVat":{"type":"boolean"},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"quoteNumber":{"type":"string"},"type":{"type":"string","enum":["quote"]},"signaturePage":{"type":"boolean"},"deepSignSignatureMode":{"type":["string","null"],"enum":["timestamp","advanced","qualified"]},"signees":{"type":["array","null"],"items":{"title":"Signee Resource","properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["receiver","sender"]},"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"userUuid":{"type":["string","null"],"format":"uuid"},"signOrder":{"type":"number","format":"int64"},"companyName":{"type":["string","null"]},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"},"completedAt":{"type":["string","null"],"format":"date-time"},"signStatus":{"type":"string","enum":["pending","signed","rejected"]},"comment":{"type":["string","null"]}},"type":"object"}},"documentDiscount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"}}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"202":{"description":"Asynchronous processing","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Asynchronous Import Resource","description":"Resource for asynchronous document imports","properties":{"status":{"type":"string","format":"uri"},"queueUuid":{"type":"string","format":"uuid"}},"type":"object"},"status":{"example":202}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"99bbefa05498a3318792b040a26f923d","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/receipts":{"get":{"tags":["documents_document-receipts"],"summary":"Get receipts","description":"Get receipts","operationId":"documents_list_receipts","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"updatedSince","in":"query","description":"filter for updated items","required":false,"schema":{"anyOf":[{"type":["string","null"],"format":"date","default":null},{"type":["string","null"],"format":"date-time","default":null}]}},{"name":"limit","in":"query","description":"pagination limit","required":false,"schema":{"type":["number","null"],"maximum":400,"minimum":1}},{"name":"page","in":"query","description":"pagination page","required":false,"schema":{"type":["number","null"],"default":1,"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"oneOf":[{"title":"Receipt Collection Item Resource","description":"Resource used in collections","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"number":{"type":"string","deprecated":true},"receiptNumber":{"type":"string"},"reference":{"type":"string"},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"invoiceDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"documentTotal":{"type":"number","format":"float"},"isArchived":{"type":"boolean"},"archived":{"type":"boolean","deprecated":true},"isCancelled":{"type":"boolean"},"cancelled":{"type":"boolean","deprecated":true},"openAmount":{"type":"number","format":"float"},"balance":{"type":"number","format":"float","deprecated":true},"isTemplate":{"type":"boolean"}},"type":"object"}]}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"167ed3bd2bcd729a3763b621ccd898b4","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/recurring-invoices":{"get":{"tags":["documents_document-recurring-invoices"],"summary":"Get recurring invoices","description":"Get recurring invoices","operationId":"documents_list_recurring_invoices_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"updatedSince","in":"query","description":"filter for updated items","required":false,"schema":{"anyOf":[{"type":["string","null"],"format":"date","default":null},{"type":["string","null"],"format":"date-time","default":null}]}},{"name":"limit","in":"query","description":"pagination limit","required":false,"schema":{"type":["number","null"],"maximum":400,"minimum":1}},{"name":"page","in":"query","description":"pagination page","required":false,"schema":{"type":["number","null"],"default":1,"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"title":"Recurring Invoice Collection Item Resource","description":"Resource used in collections","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"number","format":"int64","deprecated":true},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Lite Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"customerNumber":{"type":["string","null"]},"name":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"}},"type":"object"},{"title":"Lite Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"customerNumber":{"type":["string","null"]},"name":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"}},"type":"object"}]},"documentTotal":{"type":"number","format":"float"},"frequency":{"type":["string","null"],"enum":["weekly","two_weeks","four_weeks","monthly","three_months","six_months","annually"]},"isLastOfMonth":{"type":"boolean"},"isRecurringActive":{"type":"boolean"},"pricesIncludeVat":{"type":"boolean"},"startDate":{"type":["string","null"],"format":"date"},"updatedAt":{"type":"string","format":"date-time"},"isTemplate":{"type":"boolean"},"recurringInvoiceNumber":{"type":"string"},"billingPeriod":{"type":"string","enum":["CURRENT","PREVIOUS","NEXT","NONE"]}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"0ccdf21f5aa2f15fe83cc2045062e325","x-required-scopes":["customers"]},"post":{"tags":["documents_document-recurring-invoices"],"summary":"Create recurring invoice","description":"Create recurring invoice","operationId":"documents_create_recurring_invoices","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create recurring invoices","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/recurring-invoice.schema.json","title":"Recurring invoices","description":"A Schema for creating recurring invoices in AbaNinja over API","type":"object","properties":{"documents":{"type":"array","items":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}},"startDate":{"type":"string","format":"date"},"endDate":{"type":["null","string"],"format":"date"},"frequency":{"enum":["weekly","two_weeks","four_weeks","monthly","three_months","six_months","annually"]},"isRecurringActive":{"type":"boolean","default":false},"isLastOfMonth":{"type":"boolean","default":false,"description":"send invoice always at end of month. Only has an effect with frequencies monthly, three_months and six_months."},"paymentInstructions":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/payment-instructions.schema.json","title":"Payment Instructions","description":"Payment Instruction Schema for AbaNinja Invoice Json","oneOf":[{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}],"$defs":{"ibanInstruction":{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},"qrIbanInstruction":{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},"bankAccountReference":{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}}},"pricesIncludeVat":{"type":"boolean","description":"Controls if single_price and position_total includes vat or not"},"documentTotal":{"type":"number","description":"Total Amount incl. VAT"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"cashDiscounts":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/cash-discount.schema.json","description":"Cash Discount Schema for AbaNinja Invoice Json","type":"object","properties":{"days":{"type":"integer","minimum":1,"maximum":60,"description":"Number of days"},"percentage":{"type":"number","minimum":0.5,"maximum":100}},"required":["days","percentage"]},"description":"Skonto","maxItems":3},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"billingPeriod":{"type":"string","enum":["NONE","CURRENT","PREVIOUS","NEXT"],"default":"NONE"}},"required":["receiver","startDate","frequency","paymentInstructions","documentTotal","pricesIncludeVat","positions"]},"minItems":1}},"required":["documents"],"$defs":{"singleRecurringInvoice":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}},"startDate":{"type":"string","format":"date"},"endDate":{"type":["null","string"],"format":"date"},"frequency":{"enum":["weekly","two_weeks","four_weeks","monthly","three_months","six_months","annually"]},"isRecurringActive":{"type":"boolean","default":false},"isLastOfMonth":{"type":"boolean","default":false,"description":"send invoice always at end of month. Only has an effect with frequencies monthly, three_months and six_months."},"paymentInstructions":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/payment-instructions.schema.json","title":"Payment Instructions","description":"Payment Instruction Schema for AbaNinja Invoice Json","oneOf":[{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}],"$defs":{"ibanInstruction":{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},"qrIbanInstruction":{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},"bankAccountReference":{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}}},"pricesIncludeVat":{"type":"boolean","description":"Controls if single_price and position_total includes vat or not"},"documentTotal":{"type":"number","description":"Total Amount incl. VAT"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"cashDiscounts":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/cash-discount.schema.json","description":"Cash Discount Schema for AbaNinja Invoice Json","type":"object","properties":{"days":{"type":"integer","minimum":1,"maximum":60,"description":"Number of days"},"percentage":{"type":"number","minimum":0.5,"maximum":100}},"required":["days","percentage"]},"description":"Skonto","maxItems":3},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"billingPeriod":{"type":"string","enum":["NONE","CURRENT","PREVIOUS","NEXT"],"default":"NONE"}},"required":["receiver","startDate","frequency","paymentInstructions","documentTotal","pricesIncludeVat","positions"]}}}}}},"responses":{"201":{"description":"Recurring invoice created","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"title":"Recurring Invoice Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"startDate":{"type":["string","null"],"format":"date"},"endDate":{"type":["string","null"],"format":"date"},"nextSendDate":{"type":["string","null"],"format":"date"},"frequency":{"type":["string","null"],"enum":["weekly","two_weeks","four_weeks","monthly","three_months","six_months","annually"]},"isRecurringActive":{"type":"boolean"},"isLastOfMonth":{"type":"boolean"},"paymentInstructions":{"allOf":[{"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Bank Account Iban Resource","description":"Payment instructions bank account using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction Bank Account QrIban Resource","description":"Payment instructions bank account using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"}},"type":"object"}]}],"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Iban Resource","description":"Payment instructions using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]},"reference":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction QrIban Resource","description":"Payment instructions using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"},"reference":{"type":["string","null"]}},"type":"object"}]},"pricesIncludeVat":{"type":"boolean"},"paymentTerms":{"type":["integer","null"],"deprecated":true},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"recurringInvoiceNumber":{"type":"string"},"type":{"type":"string","enum":["recurring_invoice"]},"cashDiscounts":{"type":"array","items":{"properties":{"days":{"type":"number","format":"int64"},"percentage":{"type":"number","format":"float"}},"type":"object"},"maxItems":3,"minItems":0},"documentDiscount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"}}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"202":{"description":"Asynchronous processing","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Asynchronous Import Resource","description":"Resource for asynchronous document imports","properties":{"status":{"type":"string","format":"uri"},"queueUuid":{"type":"string","format":"uuid"}},"type":"object"},"status":{"example":202}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"ccdc56d8add840f09795e78a859d1943","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/statistics":{"get":{"tags":["documents_document-common"],"summary":"Get document statistics","description":"Get statistics of saved documents and their location","operationId":"documents_list_statistics","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document statistics resource","properties":{"total":{"type":"number","format":"int64","minimum":0},"deepBox":{"type":"number","format":"int64","minimum":0},"s3":{"type":"number","format":"int64","minimum":0}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/profile","https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"81e8bf43b3f06636d92f5cd48689c497","x-required-scopes":["profile","settings"]}},"/accounts/{accountUuid}/documents/v2/supplier-credit-notes":{"get":{"tags":["documents_document-supplier-credit-notes"],"summary":"Get supplier credit notes","description":"Get supplier credit notes","operationId":"documents_list_supplier_credit_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"updatedSince","in":"query","description":"filter for updated items","required":false,"schema":{"anyOf":[{"type":["string","null"],"format":"date","default":null},{"type":["string","null"],"format":"date-time","default":null}]}},{"name":"limit","in":"query","description":"pagination limit","required":false,"schema":{"type":["number","null"],"maximum":400,"minimum":1}},{"name":"page","in":"query","description":"pagination page","required":false,"schema":{"type":["number","null"],"default":1,"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"title":"Supplier Credit Note Collection Item Resource","description":"Resource used in collections","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"reference":{"type":"string"},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"receiver":{"oneOf":[{"title":"Lite Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"customerNumber":{"type":["string","null"]},"name":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"}},"type":"object"},{"title":"Lite Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"customerNumber":{"type":["string","null"]},"name":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"}},"type":"object"}]},"supplierCreditNoteNumber":{"type":"string"},"supplierCreditNoteDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"documentTotal":{"type":"number","format":"float"}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"7af80e2db1037132be0f8b1612e3dade","x-required-scopes":["suppliers"]},"post":{"tags":["documents_document-supplier-credit-notes"],"summary":"Create supplier credit notes","description":"Create supplier credit notes","operationId":"documents_create_supplier_credit_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create supplier credit notes","required":true,"content":{"multipart/form-data":{"schema":{"properties":{"data":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/import-supplier-credit-note-multipart.schema.json","description":"A Schema for importing supplier credit note pdfs in AbaNinja over API","type":"object","properties":{"documents":{"type":"array","items":{"type":"object","properties":{"documentFile":{"type":"string","description":"The file name when uploading the document as multipart request"},"documentData":{"type":"object","description":"Additional Data for the invoice document","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}},"supplierCreditNoteDate":{"type":"string","format":"date"},"dueDate":{"type":"string","format":"date"},"reference":{"type":"string"},"documentTotal":{"type":"number","exclusiveMinimum":0,"description":"Total Amount incl. VAT"},"taxPositions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/tax-position.schema.json","description":"A Schema for tax positions for imported invoices","type":"object","properties":{"id":{"type":["integer","null"],"exclusiveMinimum":0,"deprecated":true,"description":"identifier of the object. \"uuid\" should be used instead"},"uuid":{"type":["string","null"],"format":"uuid"},"accountNumber":{"type":"integer","minimum":1000,"maximum":999999999999,"deprecated":true,"description":"The booking account number. Use bookingAccountUuid instead."},"bookingAccountUuid":{"type":["string","null"],"format":"uuid"},"isTaxIncluded":{"type":"boolean","default":false,"description":"controls if amount already includes tax or not"},"amount":{"type":"number"},"taxRate":{"type":"number","minimum":0,"maximum":100,"deprecated":true,"description":"Tax Rate to apply. Use \"taxRateUuid\" instead"},"taxRateUuid":{"type":["null","string"],"format":"uuid"}},"required":["amount"]},"minItems":1},"wasTaxIncluded":{"type":"boolean","default":false,"description":"Controls whether tax was included during supplier credit note invoicing"}},"required":["currencyCode","receiver","supplierCreditNoteDate","dueDate","documentTotal","taxPositions"]}},"required":["documentFile"]},"minItems":1}},"required":["documents"],"$defs":{"singleDocument":{"type":"object","properties":{"documentFile":{"type":"string","description":"The file name when uploading the document as multipart request"},"documentData":{"type":"object","description":"Additional Data for the invoice document","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}},"supplierCreditNoteDate":{"type":"string","format":"date"},"dueDate":{"type":"string","format":"date"},"reference":{"type":"string"},"documentTotal":{"type":"number","exclusiveMinimum":0,"description":"Total Amount incl. VAT"},"taxPositions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/tax-position.schema.json","description":"A Schema for tax positions for imported invoices","type":"object","properties":{"id":{"type":["integer","null"],"exclusiveMinimum":0,"deprecated":true,"description":"identifier of the object. \"uuid\" should be used instead"},"uuid":{"type":["string","null"],"format":"uuid"},"accountNumber":{"type":"integer","minimum":1000,"maximum":999999999999,"deprecated":true,"description":"The booking account number. Use bookingAccountUuid instead."},"bookingAccountUuid":{"type":["string","null"],"format":"uuid"},"isTaxIncluded":{"type":"boolean","default":false,"description":"controls if amount already includes tax or not"},"amount":{"type":"number"},"taxRate":{"type":"number","minimum":0,"maximum":100,"deprecated":true,"description":"Tax Rate to apply. Use \"taxRateUuid\" instead"},"taxRateUuid":{"type":["null","string"],"format":"uuid"}},"required":["amount"]},"minItems":1},"wasTaxIncluded":{"type":"boolean","default":false,"description":"Controls whether tax was included during supplier credit note invoicing"}},"required":["currencyCode","receiver","supplierCreditNoteDate","dueDate","documentTotal","taxPositions"]}},"required":["documentFile"]}}},"files":{"type":"array","items":{"type":"string","format":"binary"},"maximum":5,"minimum":1}},"type":"object"}},"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/import-supplier-credit-note.schema.json","description":"A Schema for importing supplier credit note pdfs in AbaNinja over API","type":"object","properties":{"documents":{"type":"array","items":{"type":"object","properties":{"documentUrl":{"type":"string","format":"uri","description":"The url where to download the document file to import"},"documentData":{"type":"object","description":"Additional Data for the invoice document","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}},"supplierCreditNoteDate":{"type":"string","format":"date"},"dueDate":{"type":"string","format":"date"},"reference":{"type":"string"},"documentTotal":{"type":"number","exclusiveMinimum":0,"description":"Total Amount incl. VAT"},"taxPositions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/tax-position.schema.json","description":"A Schema for tax positions for imported invoices","type":"object","properties":{"id":{"type":["integer","null"],"exclusiveMinimum":0,"deprecated":true,"description":"identifier of the object. \"uuid\" should be used instead"},"uuid":{"type":["string","null"],"format":"uuid"},"accountNumber":{"type":"integer","minimum":1000,"maximum":999999999999,"deprecated":true,"description":"The booking account number. Use bookingAccountUuid instead."},"bookingAccountUuid":{"type":["string","null"],"format":"uuid"},"isTaxIncluded":{"type":"boolean","default":false,"description":"controls if amount already includes tax or not"},"amount":{"type":"number"},"taxRate":{"type":"number","minimum":0,"maximum":100,"deprecated":true,"description":"Tax Rate to apply. Use \"taxRateUuid\" instead"},"taxRateUuid":{"type":["null","string"],"format":"uuid"}},"required":["amount"]},"minItems":1},"wasTaxIncluded":{"type":"boolean","default":false,"description":"Controls whether tax was included during supplier credit note invoicing"}},"required":["currencyCode","receiver","supplierCreditNoteDate","dueDate","documentTotal","taxPositions"]}},"required":["documentUrl"]},"minItems":1}},"required":["documents"],"$defs":{"singleDocument":{"type":"object","properties":{"documentUrl":{"type":"string","format":"uri","description":"The url where to download the document file to import"},"documentData":{"type":"object","description":"Additional Data for the invoice document","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}},"supplierCreditNoteDate":{"type":"string","format":"date"},"dueDate":{"type":"string","format":"date"},"reference":{"type":"string"},"documentTotal":{"type":"number","exclusiveMinimum":0,"description":"Total Amount incl. VAT"},"taxPositions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/tax-position.schema.json","description":"A Schema for tax positions for imported invoices","type":"object","properties":{"id":{"type":["integer","null"],"exclusiveMinimum":0,"deprecated":true,"description":"identifier of the object. \"uuid\" should be used instead"},"uuid":{"type":["string","null"],"format":"uuid"},"accountNumber":{"type":"integer","minimum":1000,"maximum":999999999999,"deprecated":true,"description":"The booking account number. Use bookingAccountUuid instead."},"bookingAccountUuid":{"type":["string","null"],"format":"uuid"},"isTaxIncluded":{"type":"boolean","default":false,"description":"controls if amount already includes tax or not"},"amount":{"type":"number"},"taxRate":{"type":"number","minimum":0,"maximum":100,"deprecated":true,"description":"Tax Rate to apply. Use \"taxRateUuid\" instead"},"taxRateUuid":{"type":["null","string"],"format":"uuid"}},"required":["amount"]},"minItems":1},"wasTaxIncluded":{"type":"boolean","default":false,"description":"Controls whether tax was included during supplier credit note invoicing"}},"required":["currencyCode","receiver","supplierCreditNoteDate","dueDate","documentTotal","taxPositions"]}},"required":["documentUrl"]}}}}}},"responses":{"201":{"description":"Supplier credit note created","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"title":"Supplier Credit Note Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"supplierCreditNoteNumber":{"type":"string"},"supplierCreditNoteDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"documentTotal":{"type":"number","format":"float"},"taxPositions":{"type":"array","items":{"title":"Receipt Tax Position Resource","properties":{"id":{"type":"integer","format":"int64"},"accountNumber":{"type":"integer","format":"int64"},"isTaxIncluded":{"type":"boolean"},"amount":{"type":"number","format":"float"},"taxRate":{"type":"number","format":"float"},"taxRateUuid":{"type":["string","null"],"format":"uuid"}},"type":"object"}},"isTemplate":{"type":"boolean"},"openAmount":{"type":"number","format":"float"},"reference":{"type":"string"},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"type":{"type":"string","enum":["supplier_credit_note"]},"wasTaxIncluded":{"type":"boolean"},"wasRecognitionLimitReached":{"type":"boolean"}},"type":"object"}}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"202":{"description":"Asynchronous processing","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Asynchronous Import Resource","description":"Resource for asynchronous document imports","properties":{"status":{"type":"string","format":"uri"},"queueUuid":{"type":"string","format":"uuid"}},"type":"object"},"status":{"example":202}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"1be3ab7dd3d00097957a7711dc3471e8","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/{contractNoteUuid}":{"get":{"tags":["documents_document-contract-notes"],"summary":"Get contract note","description":"Get a single contract note","operationId":"documents_get_contract_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"contractNoteUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"title":"Contract Note Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"contractNoteDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"paymentInstructions":{"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Bank Account Iban Resource","description":"Payment instructions bank account using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction Bank Account QrIban Resource","description":"Payment instructions bank account using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"}},"type":"object"}]},"pricesIncludeVat":{"type":"boolean"},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"contractNoteNumber":{"type":"string"},"type":{"type":"string","enum":["invoice"]},"documentDiscount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"8d0777ed212d601681f61034a2a959dc","x-required-scopes":["customers"]},"patch":{"tags":["documents_document-contract-notes"],"summary":"Update contract note","description":"Update contract note","operationId":"documents_update_contract_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"contractNoteUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update contract note","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/contract-note.schema.json","title":"Contract notes","description":"A Schema for creating contract notes in AbaNinja over API","type":"object","properties":{"documents":{"type":"array","items":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"contractNoteDate":{"type":"string","format":"date"},"dueDate":{"type":["null","string"],"format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"paymentInstructions":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/payment-instructions-bank-account.schema.json","title":"Payment Instructions Bank Account","description":"Payment Instruction Schema for AbaNinja Invoice Json without reference","oneOf":[{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"}},"required":["qrIban"]},{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"}},"required":["bankAccountUuid"]}],"$defs":{"ibanInstruction":{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},"qrIbanInstruction":{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"}},"required":["qrIban"]},"bankAccountReference":{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"}},"required":["bankAccountUuid"]}}}]},"pricesIncludeVat":{"type":"boolean","description":"Controls if singlePrice includes vat or not"},"documentTotal":{"type":"number","description":"Total Amount incl. VAT"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]}},"required":["contractNoteDate","documentTotal","pricesIncludeVat","positions"],"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]},"minItems":1}},"required":["documents"],"$defs":{"singleContractNote":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"contractNoteDate":{"type":"string","format":"date"},"dueDate":{"type":["null","string"],"format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"paymentInstructions":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/payment-instructions-bank-account.schema.json","title":"Payment Instructions Bank Account","description":"Payment Instruction Schema for AbaNinja Invoice Json without reference","oneOf":[{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"}},"required":["qrIban"]},{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"}},"required":["bankAccountUuid"]}],"$defs":{"ibanInstruction":{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},"qrIbanInstruction":{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"}},"required":["qrIban"]},"bankAccountReference":{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"}},"required":["bankAccountUuid"]}}}]},"pricesIncludeVat":{"type":"boolean","description":"Controls if singlePrice includes vat or not"},"documentTotal":{"type":"number","description":"Total Amount incl. VAT"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]}},"required":["contractNoteDate","documentTotal","pricesIncludeVat","positions"],"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]}}}}}},"responses":{"200":{"description":"Contract note updated","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"title":"Contract Note Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"contractNoteDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"paymentInstructions":{"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Bank Account Iban Resource","description":"Payment instructions bank account using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction Bank Account QrIban Resource","description":"Payment instructions bank account using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"}},"type":"object"}]},"pricesIncludeVat":{"type":"boolean"},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"contractNoteNumber":{"type":"string"},"type":{"type":"string","enum":["invoice"]},"documentDiscount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"915f78a8d733cdf8ee22d0d97917f50f","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions":{"get":{"tags":["documents_document-contract-notes"],"summary":"Get bulk actions","description":"Get contract note bulk actions","operationId":"documents_list_bulk_actions","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"forList","in":"query","description":"filter list actions","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","example":{"archive":"Archive","cancel":"Cancel","delete":"Delete"},"additionalProperties":{"description":"description of the action","type":"string"},"propertyNames":{"enum":["paymentAdd","archive","cancel","cancelPermanently","clone","collectInvoice","convertCNDN","convertCNI","convertDNI","convertIC","convertDN","convertT","convertCN","convert","convertTemplateToContractNote","convertTemplateToCreditNote","convertTemplateToDeliveryNote","convertTI","convertTemplateToQuote","convertToTemplate","createFinal","createInstalments","createPartial","createOnAccount","customerPortalUrl","delete","dissolve","downloadPdf","downloadPaymentConfirmation","dunningPrint","dunningSent","dunningDate","setDunningAmounts","edit","activity","info","email","markApproved","markDeclined","markSent","massDownloadZip","massDunningPrint","massDunningSent","massPrint","massSent","offsetCreditNotes","offsetInvoices","offsetReceipts","offsetSupplierCreditNotes","plannedMail","print","regeneratePdf","resync","restore","save","sendPaymentConfirmation","sendAbaNet","sendDeepSign","sign","signSupplierCreditNote","sync"]}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"b8875754b8467ffddf56c709dcb4104f","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/calculate":{"post":{"tags":["documents_document-contract-notes"],"summary":"Calculate amounts of new document","description":"Calculates the amounts of a document for previewing without manipulating any resources","operationId":"documents_create_calculate_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Document to calculate","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/invoice-calculate.schema.json","description":"A Schema for calculating invoices in AbaNinja over API","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}}},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"invoiceDate":{"type":["string","null"],"format":"date"}},"required":["positions","currencyCode"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Contract Note Calculation Resource","type":"object","allOf":[{"title":"Calculation Resource","properties":{"total":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"roundingDifference":{"type":"number","format":"float"},"taxes":{"type":"array","items":{"properties":{"rate":{"type":"number","format":"float"},"value":{"type":"number","format":"float"},"name":{"type":"string"},"baseSum":{"type":"number","format":"float"}},"type":"object"}}},"type":"object"},{"properties":{"total":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"roundingDifference":{"type":"number","format":"float"},"taxes":{"type":"array","items":{"properties":{"rate":{"type":"number","format":"float"},"value":{"type":"number","format":"float"},"name":{"type":"string"},"baseSum":{"type":"number","format":"float"}},"type":"object"}},"totalInvoicedAmount":{"description":"sum of all related invoices of this contract note","type":["number","null"],"format":"float"}},"type":"object"}]},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"851ab113a60c0ead90b00ab863698423","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/{creditNoteUuid}":{"get":{"tags":["documents_document-credit-notes"],"summary":"Get credit note","description":"Get a single credit note","operationId":"documents_get_credit_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"creditNoteUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"title":"Credit Note Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"creditNoteDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"pricesIncludeVat":{"type":"boolean"},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"creditNoteNumber":{"type":"string"},"openAmount":{"type":"number","format":"float"},"abanetSendAt":{"type":["string","null"],"format":"date-time"},"abanetConfirmedAt":{"type":["string","null"],"format":"date-time"},"type":{"type":"string","enum":["credit_note"]},"documentDiscount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"0ee21eb03b479538feec66f12d63a72f","x-required-scopes":["customers"]},"patch":{"tags":["documents_document-credit-notes"],"summary":"Update credit note","description":"Update credit note","operationId":"documents_update_credit_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"creditNoteUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update credit note","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/credit-note.schema.json","title":"Credit notes","description":"A Schema for creating credit notes in AbaNinja over API","type":"object","properties":{"documents":{"type":"array","items":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"creditNoteDate":{"type":"string","format":"date"},"dueDate":{"type":["null","string"],"format":"date"},"pricesIncludeVat":{"type":"boolean","description":"Controls if single_price and position_total includes vat or not"},"documentTotal":{"type":"number","description":"Total Amount incl. VAT"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]}},"required":["creditNoteDate","documentTotal","pricesIncludeVat","positions"],"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]},"minItems":1}},"required":["documents"],"$defs":{"singleCreditNote":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"creditNoteDate":{"type":"string","format":"date"},"dueDate":{"type":["null","string"],"format":"date"},"pricesIncludeVat":{"type":"boolean","description":"Controls if single_price and position_total includes vat or not"},"documentTotal":{"type":"number","description":"Total Amount incl. VAT"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]}},"required":["creditNoteDate","documentTotal","pricesIncludeVat","positions"],"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]}}}}}},"responses":{"200":{"description":"Credit note updated","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"title":"Credit Note Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"creditNoteDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"pricesIncludeVat":{"type":"boolean"},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"creditNoteNumber":{"type":"string"},"openAmount":{"type":"number","format":"float"},"abanetSendAt":{"type":["string","null"],"format":"date-time"},"abanetConfirmedAt":{"type":["string","null"],"format":"date-time"},"type":{"type":"string","enum":["credit_note"]},"documentDiscount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"2d75c52735462a49f0d1cb27159bb31d","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/bulk-actions":{"get":{"tags":["documents_document-credit-notes"],"summary":"Get bulk actions","description":"Get credit note bulk actions","operationId":"documents_list_bulk_actions_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"forList","in":"query","description":"filter list actions","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","example":{"archive":"Archive","cancel":"Cancel","delete":"Delete"},"additionalProperties":{"description":"description of the action","type":"string"},"propertyNames":{"enum":["paymentAdd","archive","cancel","cancelPermanently","clone","collectInvoice","convertCNDN","convertCNI","convertDNI","convertIC","convertDN","convertT","convertCN","convert","convertTemplateToContractNote","convertTemplateToCreditNote","convertTemplateToDeliveryNote","convertTI","convertTemplateToQuote","convertToTemplate","createFinal","createInstalments","createPartial","createOnAccount","customerPortalUrl","delete","dissolve","downloadPdf","downloadPaymentConfirmation","dunningPrint","dunningSent","dunningDate","setDunningAmounts","edit","activity","info","email","markApproved","markDeclined","markSent","massDownloadZip","massDunningPrint","massDunningSent","massPrint","massSent","offsetCreditNotes","offsetInvoices","offsetReceipts","offsetSupplierCreditNotes","plannedMail","print","regeneratePdf","resync","restore","save","sendPaymentConfirmation","sendAbaNet","sendDeepSign","sign","signSupplierCreditNote","sync"]}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"e2333cc358a4a64bc96f2e38fbafdacc","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/calculate":{"post":{"tags":["documents_document-credit-notes"],"summary":"Calculate amounts of new document","description":"Calculates the amounts of a document for previewing without manipulating any resources","operationId":"documents_create_calculate","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Document to calculate","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/invoice-calculate.schema.json","description":"A Schema for calculating invoices in AbaNinja over API","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}}},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"invoiceDate":{"type":["string","null"],"format":"date"}},"required":["positions","currencyCode"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Calculation Resource","properties":{"total":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"roundingDifference":{"type":"number","format":"float"},"taxes":{"type":"array","items":{"properties":{"rate":{"type":"number","format":"float"},"value":{"type":"number","format":"float"},"name":{"type":"string"},"baseSum":{"type":"number","format":"float"}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"74a0f0fee1f36d628fac8d546f2287d5","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/{deliveryNoteUuid}":{"get":{"tags":["documents_document-delivery-notes"],"summary":"Get delivery note","description":"Get a single delivery note","operationId":"documents_get_delivery_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"deliveryNoteUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"title":"Delivery Note Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"deliveryNoteDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"deliveryNoteNumber":{"type":"string"},"type":{"type":"string","enum":["delivery_note"]},"documentDiscount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"1ac7e32b908780789b3c8908825959ca","x-required-scopes":["customers"]},"patch":{"tags":["documents_document-delivery-notes"],"summary":"Update delivery note","description":"Update delivery note","operationId":"documents_update_delivery_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"deliveryNoteUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update delivery note","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/delivery-note.schema.json","title":"Delivery notes","description":"A Schema for creating delivery notes in AbaNinja over API","type":"object","properties":{"documents":{"type":"array","items":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"deliveryNoteDate":{"type":"string","format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"pricesIncludeVat":{"type":"boolean","description":"Controls if prices includes vat or not. If omitted the accounts default setting is used."},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/delivery-note-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber, productDescription and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over unitCode"},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Price, which will be used when converting the delivery note to another document like an invoice"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\". Used only when converting the delivery note to another document like an invoice."},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"],"description":"VAT to use. Is precedented by \"vatUuid\". Used only when converting the delivery note to another document like an invoice."}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber, productDescription and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over unitCode"},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Price, which will be used when converting the delivery note to another document like an invoice"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\". Used only when converting the delivery note to another document like an invoice."},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"],"description":"VAT to use. Is precedented by \"vatUuid\". Used only when converting the delivery note to another document like an invoice."}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1},"showCollapsed":{"type":"boolean","default":true}},"required":["title","kind","items"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber, productDescription and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over unitCode"},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Price, which will be used when converting the delivery note to another document like an invoice"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\". Used only when converting the delivery note to another document like an invoice."},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"],"description":"VAT to use. Is precedented by \"vatUuid\". Used only when converting the delivery note to another document like an invoice."}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber, productDescription and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over unitCode"},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Price, which will be used when converting the delivery note to another document like an invoice"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\". Used only when converting the delivery note to another document like an invoice."},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"],"description":"VAT to use. Is precedented by \"vatUuid\". Used only when converting the delivery note to another document like an invoice."}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1},"showCollapsed":{"type":"boolean","default":true}},"required":["title","kind","items"]}}},"minItems":1},"documentDiscount":{"description":"Discount, which only will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]}},"required":["deliveryNoteDate","positions"],"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]},"minItems":1}},"required":["documents"],"$defs":{"singleDeliveryNote":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"deliveryNoteDate":{"type":"string","format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"pricesIncludeVat":{"type":"boolean","description":"Controls if prices includes vat or not. If omitted the accounts default setting is used."},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/delivery-note-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber, productDescription and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over unitCode"},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Price, which will be used when converting the delivery note to another document like an invoice"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\". Used only when converting the delivery note to another document like an invoice."},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"],"description":"VAT to use. Is precedented by \"vatUuid\". Used only when converting the delivery note to another document like an invoice."}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber, productDescription and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over unitCode"},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Price, which will be used when converting the delivery note to another document like an invoice"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\". Used only when converting the delivery note to another document like an invoice."},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"],"description":"VAT to use. Is precedented by \"vatUuid\". Used only when converting the delivery note to another document like an invoice."}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1},"showCollapsed":{"type":"boolean","default":true}},"required":["title","kind","items"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber, productDescription and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over unitCode"},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Price, which will be used when converting the delivery note to another document like an invoice"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\". Used only when converting the delivery note to another document like an invoice."},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"],"description":"VAT to use. Is precedented by \"vatUuid\". Used only when converting the delivery note to another document like an invoice."}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber, productDescription and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over unitCode"},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Price, which will be used when converting the delivery note to another document like an invoice"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\". Used only when converting the delivery note to another document like an invoice."},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"],"description":"VAT to use. Is precedented by \"vatUuid\". Used only when converting the delivery note to another document like an invoice."}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1},"showCollapsed":{"type":"boolean","default":true}},"required":["title","kind","items"]}}},"minItems":1},"documentDiscount":{"description":"Discount, which only will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]}},"required":["deliveryNoteDate","positions"],"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]}}}}}},"responses":{"200":{"description":"Delivery note updated","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"title":"Delivery Note Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"deliveryNoteDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"deliveryNoteNumber":{"type":"string"},"type":{"type":"string","enum":["delivery_note"]},"documentDiscount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"892eb85d36362f2cd12fd629be1d6f60","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/bulk-actions":{"get":{"tags":["documents_document-delivery-notes"],"summary":"Get bulk actions","description":"Get delivery note bulk actions","operationId":"documents_list_bulk_actions_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"forList","in":"query","description":"filter list actions","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","example":{"archive":"Archive","cancel":"Cancel","delete":"Delete"},"additionalProperties":{"description":"description of the action","type":"string"},"propertyNames":{"enum":["paymentAdd","archive","cancel","cancelPermanently","clone","collectInvoice","convertCNDN","convertCNI","convertDNI","convertIC","convertDN","convertT","convertCN","convert","convertTemplateToContractNote","convertTemplateToCreditNote","convertTemplateToDeliveryNote","convertTI","convertTemplateToQuote","convertToTemplate","createFinal","createInstalments","createPartial","createOnAccount","customerPortalUrl","delete","dissolve","downloadPdf","downloadPaymentConfirmation","dunningPrint","dunningSent","dunningDate","setDunningAmounts","edit","activity","info","email","markApproved","markDeclined","markSent","massDownloadZip","massDunningPrint","massDunningSent","massPrint","massSent","offsetCreditNotes","offsetInvoices","offsetReceipts","offsetSupplierCreditNotes","plannedMail","print","regeneratePdf","resync","restore","save","sendPaymentConfirmation","sendAbaNet","sendDeepSign","sign","signSupplierCreditNote","sync"]}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"e123f8667ec9f086949ded528e403d7b","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{invoiceUuid}":{"get":{"tags":["documents_document-invoices"],"summary":"Get invoice","description":"Get a single invoice","operationId":"documents_get_invoices","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"invoiceUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"oneOf":[{"title":"Invoice Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"invoiceDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"nextDunningDate":{"type":["string","null"],"format":"date"},"customDunningDate":{"type":["string","null"],"format":"date"},"dunningLevel":{"type":"string","enum":["REMINDER","FIRST_DUNNING","FINAL_DUNNING","NO_DUNNING"]},"paymentInstructions":{"allOf":[{"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Bank Account Iban Resource","description":"Payment instructions bank account using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction Bank Account QrIban Resource","description":"Payment instructions bank account using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"}},"type":"object"}]}],"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Iban Resource","description":"Payment instructions using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]},"reference":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction QrIban Resource","description":"Payment instructions using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"},"reference":{"type":["string","null"]}},"type":"object"}]},"pricesIncludeVat":{"type":"boolean"},"isVariantInvoice":{"type":"boolean"},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"isCollectiveBill":{"type":"boolean"},"invoiceNumber":{"description":"Equals to importedInvoiceNumber if set, otherwise systemInvoiceNumber","type":"string","deprecated":true},"importedInvoiceNumber":{"description":"The recognized invoiceNumber of the imported document","type":["string","null"]},"systemInvoiceNumber":{"description":"The invoiceNumber generated by AbaNinja","type":"string"},"openAmount":{"type":"number","format":"float"},"type":{"type":"string","enum":["invoice"]},"subtype":{"type":["string","null"],"enum":["partial","final","on_account","instalment","dunning"]},"abanetSendAt":{"type":["string","null"],"format":"date-time"},"abanetConfirmedAt":{"type":["string","null"],"format":"date-time"},"bookedAt":{"type":["string","null"],"format":"date-time"},"syncedAt":{"type":["string","null"],"format":"date-time"},"syncMessage":{"type":["string","null"]},"syncStatus":{"type":["string","null"],"enum":["OK","FAILED","INCORRECT_STATE","GENERAL_ERROR","CONNECTION_ERROR","BLOCKED_PREVIOUS_NOT_SYNCED"]},"cashDiscounts":{"type":"array","items":{"properties":{"days":{"type":"number","format":"int64"},"percentage":{"type":"number","format":"float"}},"type":"object"},"maxItems":3,"minItems":0},"documentDiscount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"},{"title":"Imported Invoice Resource","properties":{"documentUrl":{"type":["string","null"],"format":"uri"},"documentData":{"properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"reference":{"type":"string"},"publicNotes":{"type":["string","null"]},"receiver":{"oneOf":[{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},{"type":"null"}]},"invoiceNumber":{"description":"Equals to importedInvoiceNumber if set, otherwise systemInvoiceNumber","type":"string","deprecated":true},"importedInvoiceNumber":{"description":"The recognized invoiceNumber of the imported document","type":["string","null"]},"systemInvoiceNumber":{"description":"The invoiceNumber generated by AbaNinja","type":"string"},"invoiceDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"nextDunningDate":{"type":["string","null"],"format":"date"},"customDunningDate":{"type":["string","null"],"format":"date"},"dunningLevel":{"type":"string","enum":["REMINDER","FIRST_DUNNING","FINAL_DUNNING","NO_DUNNING"]},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"paymentInstructions":{"allOf":[{"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Bank Account Iban Resource","description":"Payment instructions bank account using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction Bank Account QrIban Resource","description":"Payment instructions bank account using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"}},"type":"object"}]}],"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Iban Resource","description":"Payment instructions using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]},"reference":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction QrIban Resource","description":"Payment instructions using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"},"reference":{"type":["string","null"]}},"type":"object"}]},"documentTotal":{"type":"number","format":"float"},"taxPositions":{"type":"array","items":{"title":"Tax Position Resource","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"number","format":"int64","deprecated":true},"accountNumber":{"type":["number","null"],"format":"int64","deprecated":true},"bookingAccountUuid":{"type":["string","null"],"format":"uuid"},"isTaxIncluded":{"type":"boolean"},"amount":{"type":"number","format":"float"},"taxRate":{"type":"number","format":"float","deprecated":true},"vatUuid":{"type":["string","null"],"format":"uuid","deprecated":true},"taxRateUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"}},"type":"object"}},"isTemplate":{"type":"boolean"},"openAmount":{"type":"number","format":"float"},"type":{"type":"string","enum":["invoice"]},"subtype":{"type":["string","null"],"enum":["partial","final","on_account","instalment","dunning"]},"abanetSendAt":{"type":["string","null"],"format":"date-time"},"abanetConfirmedAt":{"type":["string","null"],"format":"date-time"},"wasRecognitionLimitReached":{"type":"boolean"},"hasCustomPaymentSlip":{"description":"if the invoice has a custom payment slip (true) or if it will be generated by AbaNinja (false)","type":"boolean"}},"type":"object"}},"type":"object"}]}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"555ecc2a277c4d6831a7d652d2b19bc9","x-required-scopes":["customers"]},"patch":{"tags":["documents_document-invoices"],"summary":"Update invoice","description":"Update invoice","operationId":"documents_update_invoices","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"invoiceUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update invoice","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/invoice.schema.json","title":"Invoices","description":"A Schema for creating invoices in AbaNinja over API","type":"object","properties":{"documents":{"type":"array","items":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"invoiceDate":{"type":"string","format":"date"},"dueDate":{"type":["null","string"],"format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"paymentInstructions":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/payment-instructions.schema.json","title":"Payment Instructions","description":"Payment Instruction Schema for AbaNinja Invoice Json","oneOf":[{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}],"$defs":{"ibanInstruction":{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},"qrIbanInstruction":{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},"bankAccountReference":{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}}},"pricesIncludeVat":{"type":"boolean","description":"Controls if singlePrice includes vat or not"},"isVariantInvoice":{"type":"boolean","default":false},"documentTotal":{"type":"number","description":"Total Amount incl. VAT"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"cashDiscounts":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/cash-discount.schema.json","description":"Cash Discount Schema for AbaNinja Invoice Json","type":"object","properties":{"days":{"type":"integer","minimum":1,"maximum":60,"description":"Number of days"},"percentage":{"type":"number","minimum":0.5,"maximum":100}},"required":["days","percentage"]},"description":"Skonto","maxItems":3},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]}},"required":["invoiceDate","paymentInstructions","documentTotal","pricesIncludeVat","positions"],"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]},"minItems":1}},"required":["documents"],"$defs":{"singleInvoice":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"invoiceDate":{"type":"string","format":"date"},"dueDate":{"type":["null","string"],"format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"paymentInstructions":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/payment-instructions.schema.json","title":"Payment Instructions","description":"Payment Instruction Schema for AbaNinja Invoice Json","oneOf":[{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}],"$defs":{"ibanInstruction":{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},"qrIbanInstruction":{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},"bankAccountReference":{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}}},"pricesIncludeVat":{"type":"boolean","description":"Controls if singlePrice includes vat or not"},"isVariantInvoice":{"type":"boolean","default":false},"documentTotal":{"type":"number","description":"Total Amount incl. VAT"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"cashDiscounts":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/cash-discount.schema.json","description":"Cash Discount Schema for AbaNinja Invoice Json","type":"object","properties":{"days":{"type":"integer","minimum":1,"maximum":60,"description":"Number of days"},"percentage":{"type":"number","minimum":0.5,"maximum":100}},"required":["days","percentage"]},"description":"Skonto","maxItems":3},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]}},"required":["invoiceDate","paymentInstructions","documentTotal","pricesIncludeVat","positions"],"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]}}}}}},"responses":{"200":{"description":"Invoice updated","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"oneOf":[{"title":"Invoice Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"invoiceDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"nextDunningDate":{"type":["string","null"],"format":"date"},"customDunningDate":{"type":["string","null"],"format":"date"},"dunningLevel":{"type":"string","enum":["REMINDER","FIRST_DUNNING","FINAL_DUNNING","NO_DUNNING"]},"paymentInstructions":{"allOf":[{"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Bank Account Iban Resource","description":"Payment instructions bank account using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction Bank Account QrIban Resource","description":"Payment instructions bank account using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"}},"type":"object"}]}],"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Iban Resource","description":"Payment instructions using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]},"reference":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction QrIban Resource","description":"Payment instructions using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"},"reference":{"type":["string","null"]}},"type":"object"}]},"pricesIncludeVat":{"type":"boolean"},"isVariantInvoice":{"type":"boolean"},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"isCollectiveBill":{"type":"boolean"},"invoiceNumber":{"description":"Equals to importedInvoiceNumber if set, otherwise systemInvoiceNumber","type":"string","deprecated":true},"importedInvoiceNumber":{"description":"The recognized invoiceNumber of the imported document","type":["string","null"]},"systemInvoiceNumber":{"description":"The invoiceNumber generated by AbaNinja","type":"string"},"openAmount":{"type":"number","format":"float"},"type":{"type":"string","enum":["invoice"]},"subtype":{"type":["string","null"],"enum":["partial","final","on_account","instalment","dunning"]},"abanetSendAt":{"type":["string","null"],"format":"date-time"},"abanetConfirmedAt":{"type":["string","null"],"format":"date-time"},"bookedAt":{"type":["string","null"],"format":"date-time"},"syncedAt":{"type":["string","null"],"format":"date-time"},"syncMessage":{"type":["string","null"]},"syncStatus":{"type":["string","null"],"enum":["OK","FAILED","INCORRECT_STATE","GENERAL_ERROR","CONNECTION_ERROR","BLOCKED_PREVIOUS_NOT_SYNCED"]},"cashDiscounts":{"type":"array","items":{"properties":{"days":{"type":"number","format":"int64"},"percentage":{"type":"number","format":"float"}},"type":"object"},"maxItems":3,"minItems":0},"documentDiscount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"},{"title":"Imported Invoice Resource","properties":{"documentUrl":{"type":["string","null"],"format":"uri"},"documentData":{"properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"reference":{"type":"string"},"publicNotes":{"type":["string","null"]},"receiver":{"oneOf":[{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},{"type":"null"}]},"invoiceNumber":{"description":"Equals to importedInvoiceNumber if set, otherwise systemInvoiceNumber","type":"string","deprecated":true},"importedInvoiceNumber":{"description":"The recognized invoiceNumber of the imported document","type":["string","null"]},"systemInvoiceNumber":{"description":"The invoiceNumber generated by AbaNinja","type":"string"},"invoiceDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"nextDunningDate":{"type":["string","null"],"format":"date"},"customDunningDate":{"type":["string","null"],"format":"date"},"dunningLevel":{"type":"string","enum":["REMINDER","FIRST_DUNNING","FINAL_DUNNING","NO_DUNNING"]},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"paymentInstructions":{"allOf":[{"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Bank Account Iban Resource","description":"Payment instructions bank account using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction Bank Account QrIban Resource","description":"Payment instructions bank account using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"}},"type":"object"}]}],"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Iban Resource","description":"Payment instructions using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]},"reference":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction QrIban Resource","description":"Payment instructions using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"},"reference":{"type":["string","null"]}},"type":"object"}]},"documentTotal":{"type":"number","format":"float"},"taxPositions":{"type":"array","items":{"title":"Tax Position Resource","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"number","format":"int64","deprecated":true},"accountNumber":{"type":["number","null"],"format":"int64","deprecated":true},"bookingAccountUuid":{"type":["string","null"],"format":"uuid"},"isTaxIncluded":{"type":"boolean"},"amount":{"type":"number","format":"float"},"taxRate":{"type":"number","format":"float","deprecated":true},"vatUuid":{"type":["string","null"],"format":"uuid","deprecated":true},"taxRateUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"}},"type":"object"}},"isTemplate":{"type":"boolean"},"openAmount":{"type":"number","format":"float"},"type":{"type":"string","enum":["invoice"]},"subtype":{"type":["string","null"],"enum":["partial","final","on_account","instalment","dunning"]},"abanetSendAt":{"type":["string","null"],"format":"date-time"},"abanetConfirmedAt":{"type":["string","null"],"format":"date-time"},"wasRecognitionLimitReached":{"type":"boolean"},"hasCustomPaymentSlip":{"description":"if the invoice has a custom payment slip (true) or if it will be generated by AbaNinja (false)","type":"boolean"}},"type":"object"}},"type":"object"}]}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"842b28b467741ee232dd1604dc14c3ae","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/bulk-actions":{"get":{"tags":["documents_document-invoices"],"summary":"Get bulk actions","description":"Get invoice bulk actions","operationId":"documents_list_bulk_actions_4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"forList","in":"query","description":"filter list actions","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","example":{"archive":"Archive","cancel":"Cancel","delete":"Delete"},"additionalProperties":{"description":"description of the action","type":"string"},"propertyNames":{"enum":["paymentAdd","archive","cancel","cancelPermanently","clone","collectInvoice","convertCNDN","convertCNI","convertDNI","convertIC","convertDN","convertT","convertCN","convert","convertTemplateToContractNote","convertTemplateToCreditNote","convertTemplateToDeliveryNote","convertTI","convertTemplateToQuote","convertToTemplate","createFinal","createInstalments","createPartial","createOnAccount","customerPortalUrl","delete","dissolve","downloadPdf","downloadPaymentConfirmation","dunningPrint","dunningSent","dunningDate","setDunningAmounts","edit","activity","info","email","markApproved","markDeclined","markSent","massDownloadZip","massDunningPrint","massDunningSent","massPrint","massSent","offsetCreditNotes","offsetInvoices","offsetReceipts","offsetSupplierCreditNotes","plannedMail","print","regeneratePdf","resync","restore","save","sendPaymentConfirmation","sendAbaNet","sendDeepSign","sign","signSupplierCreditNote","sync"]}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"664ce4e360c1ffcaac5a88b94d3647ae","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/calculate":{"post":{"tags":["documents_document-invoices"],"summary":"Calculate amounts of new document","description":"Calculates the amounts of a document for previewing without manipulating any resources","operationId":"documents_create_calculate_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Document to calculate","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/invoice-calculate.schema.json","description":"A Schema for calculating invoices in AbaNinja over API","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}}},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"invoiceDate":{"type":["string","null"],"format":"date"}},"required":["positions","currencyCode"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Calculation Resource","properties":{"total":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"roundingDifference":{"type":"number","format":"float"},"taxes":{"type":"array","items":{"properties":{"rate":{"type":"number","format":"float"},"value":{"type":"number","format":"float"},"name":{"type":"string"},"baseSum":{"type":"number","format":"float"}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"da911941ed564e0285e8375bdd8de007","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/import":{"post":{"tags":["documents_document-invoices"],"summary":"Import invoice","description":"Import invoice from PDF","operationId":"documents_create_import","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Import invoices","required":true,"content":{"multipart/form-data":{"schema":{"properties":{"data":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/import-invoice-multipart.schema.json","description":"A Schema for importing invoice pdfs in AbaNinja over API","type":"object","properties":{"documents":{"type":"array","items":{"type":"object","properties":{"documentFile":{"type":"string","description":"The file name when uploading the document as multipart request"},"documentData":{"type":"object","description":"Additional Data for the invoice document","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}},"invoiceNumber":{"type":["null","string"]},"invoiceDate":{"type":"string","format":"date"},"dueDate":{"type":"string","format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"paymentInstructions":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/payment-instructions.schema.json","title":"Payment Instructions","description":"Payment Instruction Schema for AbaNinja Invoice Json","oneOf":[{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}],"$defs":{"ibanInstruction":{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},"qrIbanInstruction":{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},"bankAccountReference":{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}}},"documentTotal":{"type":"number","description":"Total Amount incl. VAT"},"taxPositions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/tax-position.schema.json","description":"A Schema for tax positions for imported invoices","type":"object","properties":{"id":{"type":["integer","null"],"exclusiveMinimum":0,"deprecated":true,"description":"identifier of the object. \"uuid\" should be used instead"},"uuid":{"type":["string","null"],"format":"uuid"},"accountNumber":{"type":"integer","minimum":1000,"maximum":999999999999,"deprecated":true,"description":"The booking account number. Use bookingAccountUuid instead."},"bookingAccountUuid":{"type":["string","null"],"format":"uuid"},"isTaxIncluded":{"type":"boolean","default":false,"description":"controls if amount already includes tax or not"},"amount":{"type":"number"},"taxRate":{"type":"number","minimum":0,"maximum":100,"deprecated":true,"description":"Tax Rate to apply. Use \"taxRateUuid\" instead"},"taxRateUuid":{"type":["null","string"],"format":"uuid"}},"required":["amount"]},"minItems":1},"reference":{"type":["string"],"maxLength":255},"publicNotes":{"type":["null","string"]}},"required":["currencyCode","receiver","invoiceDate","dueDate","paymentInstructions","documentTotal","taxPositions"]}},"required":["documentFile"]},"minItems":1}},"required":["documents"],"$defs":{"singleDocument":{"type":"object","properties":{"documentFile":{"type":"string","description":"The file name when uploading the document as multipart request"},"documentData":{"type":"object","description":"Additional Data for the invoice document","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}},"invoiceNumber":{"type":["null","string"]},"invoiceDate":{"type":"string","format":"date"},"dueDate":{"type":"string","format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"paymentInstructions":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/payment-instructions.schema.json","title":"Payment Instructions","description":"Payment Instruction Schema for AbaNinja Invoice Json","oneOf":[{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}],"$defs":{"ibanInstruction":{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},"qrIbanInstruction":{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},"bankAccountReference":{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}}},"documentTotal":{"type":"number","description":"Total Amount incl. VAT"},"taxPositions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/tax-position.schema.json","description":"A Schema for tax positions for imported invoices","type":"object","properties":{"id":{"type":["integer","null"],"exclusiveMinimum":0,"deprecated":true,"description":"identifier of the object. \"uuid\" should be used instead"},"uuid":{"type":["string","null"],"format":"uuid"},"accountNumber":{"type":"integer","minimum":1000,"maximum":999999999999,"deprecated":true,"description":"The booking account number. Use bookingAccountUuid instead."},"bookingAccountUuid":{"type":["string","null"],"format":"uuid"},"isTaxIncluded":{"type":"boolean","default":false,"description":"controls if amount already includes tax or not"},"amount":{"type":"number"},"taxRate":{"type":"number","minimum":0,"maximum":100,"deprecated":true,"description":"Tax Rate to apply. Use \"taxRateUuid\" instead"},"taxRateUuid":{"type":["null","string"],"format":"uuid"}},"required":["amount"]},"minItems":1},"reference":{"type":["string"],"maxLength":255},"publicNotes":{"type":["null","string"]}},"required":["currencyCode","receiver","invoiceDate","dueDate","paymentInstructions","documentTotal","taxPositions"]}},"required":["documentFile"]}}},"files":{"type":"array","items":{"type":"string","format":"binary"},"maximum":5,"minimum":1}},"type":"object"}},"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/import-invoice.schema.json","description":"A Schema for importing invoice pdfs in AbaNinja over API","type":"object","properties":{"documents":{"type":"array","items":{"type":"object","properties":{"documentUrl":{"type":"string","format":"uri","description":"The url where to download the document file to import"},"documentData":{"type":"object","description":"Additional Data for the invoice document","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}},"invoiceNumber":{"type":["null","string"]},"invoiceDate":{"type":"string","format":"date"},"dueDate":{"type":"string","format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"paymentInstructions":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/payment-instructions.schema.json","title":"Payment Instructions","description":"Payment Instruction Schema for AbaNinja Invoice Json","oneOf":[{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}],"$defs":{"ibanInstruction":{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},"qrIbanInstruction":{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},"bankAccountReference":{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}}},"documentTotal":{"type":"number","description":"Total Amount incl. VAT"},"taxPositions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/tax-position.schema.json","description":"A Schema for tax positions for imported invoices","type":"object","properties":{"id":{"type":["integer","null"],"exclusiveMinimum":0,"deprecated":true,"description":"identifier of the object. \"uuid\" should be used instead"},"uuid":{"type":["string","null"],"format":"uuid"},"accountNumber":{"type":"integer","minimum":1000,"maximum":999999999999,"deprecated":true,"description":"The booking account number. Use bookingAccountUuid instead."},"bookingAccountUuid":{"type":["string","null"],"format":"uuid"},"isTaxIncluded":{"type":"boolean","default":false,"description":"controls if amount already includes tax or not"},"amount":{"type":"number"},"taxRate":{"type":"number","minimum":0,"maximum":100,"deprecated":true,"description":"Tax Rate to apply. Use \"taxRateUuid\" instead"},"taxRateUuid":{"type":["null","string"],"format":"uuid"}},"required":["amount"]},"minItems":1},"reference":{"type":["string"],"maxLength":255},"publicNotes":{"type":["null","string"]},"hasCustomPaymentSlip":{"type":"boolean","default":false,"description":"if the invoice has a custom payment slip (true) or if it will be generated by AbaNinja (false)"}},"required":["currencyCode","receiver","invoiceDate","dueDate","paymentInstructions","documentTotal","taxPositions"]}},"required":["documentUrl"]},"minItems":1}},"required":["documents"],"$defs":{"singleDocument":{"type":"object","properties":{"documentUrl":{"type":"string","format":"uri","description":"The url where to download the document file to import"},"documentData":{"type":"object","description":"Additional Data for the invoice document","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}},"invoiceNumber":{"type":["null","string"]},"invoiceDate":{"type":"string","format":"date"},"dueDate":{"type":"string","format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"paymentInstructions":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/payment-instructions.schema.json","title":"Payment Instructions","description":"Payment Instruction Schema for AbaNinja Invoice Json","oneOf":[{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}],"$defs":{"ibanInstruction":{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},"qrIbanInstruction":{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},"bankAccountReference":{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}}},"documentTotal":{"type":"number","description":"Total Amount incl. VAT"},"taxPositions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/tax-position.schema.json","description":"A Schema for tax positions for imported invoices","type":"object","properties":{"id":{"type":["integer","null"],"exclusiveMinimum":0,"deprecated":true,"description":"identifier of the object. \"uuid\" should be used instead"},"uuid":{"type":["string","null"],"format":"uuid"},"accountNumber":{"type":"integer","minimum":1000,"maximum":999999999999,"deprecated":true,"description":"The booking account number. Use bookingAccountUuid instead."},"bookingAccountUuid":{"type":["string","null"],"format":"uuid"},"isTaxIncluded":{"type":"boolean","default":false,"description":"controls if amount already includes tax or not"},"amount":{"type":"number"},"taxRate":{"type":"number","minimum":0,"maximum":100,"deprecated":true,"description":"Tax Rate to apply. Use \"taxRateUuid\" instead"},"taxRateUuid":{"type":["null","string"],"format":"uuid"}},"required":["amount"]},"minItems":1},"reference":{"type":["string"],"maxLength":255},"publicNotes":{"type":["null","string"]},"hasCustomPaymentSlip":{"type":"boolean","default":false,"description":"if the invoice has a custom payment slip (true) or if it will be generated by AbaNinja (false)"}},"required":["currencyCode","receiver","invoiceDate","dueDate","paymentInstructions","documentTotal","taxPositions"]}},"required":["documentUrl"]}}}}}},"responses":{"201":{"description":"Invoice created","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"title":"Imported Invoice Resource","properties":{"documentUrl":{"type":["string","null"],"format":"uri"},"documentData":{"properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"reference":{"type":"string"},"publicNotes":{"type":["string","null"]},"receiver":{"oneOf":[{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},{"type":"null"}]},"invoiceNumber":{"description":"Equals to importedInvoiceNumber if set, otherwise systemInvoiceNumber","type":"string","deprecated":true},"importedInvoiceNumber":{"description":"The recognized invoiceNumber of the imported document","type":["string","null"]},"systemInvoiceNumber":{"description":"The invoiceNumber generated by AbaNinja","type":"string"},"invoiceDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"nextDunningDate":{"type":["string","null"],"format":"date"},"customDunningDate":{"type":["string","null"],"format":"date"},"dunningLevel":{"type":"string","enum":["REMINDER","FIRST_DUNNING","FINAL_DUNNING","NO_DUNNING"]},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"paymentInstructions":{"allOf":[{"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Bank Account Iban Resource","description":"Payment instructions bank account using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction Bank Account QrIban Resource","description":"Payment instructions bank account using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"}},"type":"object"}]}],"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Iban Resource","description":"Payment instructions using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]},"reference":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction QrIban Resource","description":"Payment instructions using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"},"reference":{"type":["string","null"]}},"type":"object"}]},"documentTotal":{"type":"number","format":"float"},"taxPositions":{"type":"array","items":{"title":"Tax Position Resource","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"number","format":"int64","deprecated":true},"accountNumber":{"type":["number","null"],"format":"int64","deprecated":true},"bookingAccountUuid":{"type":["string","null"],"format":"uuid"},"isTaxIncluded":{"type":"boolean"},"amount":{"type":"number","format":"float"},"taxRate":{"type":"number","format":"float","deprecated":true},"vatUuid":{"type":["string","null"],"format":"uuid","deprecated":true},"taxRateUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"}},"type":"object"}},"isTemplate":{"type":"boolean"},"openAmount":{"type":"number","format":"float"},"type":{"type":"string","enum":["invoice"]},"subtype":{"type":["string","null"],"enum":["partial","final","on_account","instalment","dunning"]},"abanetSendAt":{"type":["string","null"],"format":"date-time"},"abanetConfirmedAt":{"type":["string","null"],"format":"date-time"},"wasRecognitionLimitReached":{"type":"boolean"},"hasCustomPaymentSlip":{"description":"if the invoice has a custom payment slip (true) or if it will be generated by AbaNinja (false)","type":"boolean"}},"type":"object"}},"type":"object"}}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"202":{"description":"Asynchronous processing","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Asynchronous Import Resource","description":"Resource for asynchronous document imports","properties":{"status":{"type":"string","format":"uri"},"queueUuid":{"type":"string","format":"uuid"}},"type":"object"},"status":{"example":202}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"e9b69e6c492f9b24d798b7c5ef0f86fc","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/queue/{queueUuid}":{"get":{"tags":["documents_document-common"],"summary":"Get queue status","description":"Get the status of the document-mass-import queue","operationId":"documents_get_queue","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"queueUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Mass Document Import Queue Resource","description":"Describes the status of an document mass import","properties":{"uuid":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"total":{"type":"integer"},"successful":{"type":"integer"},"failed":{"type":"integer"},"status":{"type":"string","enum":["pending","failed","finished","aborted"]},"details":{"type":["array","null"],"items":{"title":"Mass Document Json Import Detail Resource","properties":{"status":{"type":"string","enum":["pending","failed","finished","aborted"]},"message":{"type":["string","null"]},"invoice":{"oneOf":[{"title":"Imported Invoice Resource","properties":{"documentUrl":{"type":["string","null"],"format":"uri"},"documentData":{"properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"reference":{"type":"string"},"publicNotes":{"type":["string","null"]},"receiver":{"oneOf":[{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},{"type":"null"}]},"invoiceNumber":{"description":"Equals to importedInvoiceNumber if set, otherwise systemInvoiceNumber","type":"string","deprecated":true},"importedInvoiceNumber":{"description":"The recognized invoiceNumber of the imported document","type":["string","null"]},"systemInvoiceNumber":{"description":"The invoiceNumber generated by AbaNinja","type":"string"},"invoiceDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"nextDunningDate":{"type":["string","null"],"format":"date"},"customDunningDate":{"type":["string","null"],"format":"date"},"dunningLevel":{"type":"string","enum":["REMINDER","FIRST_DUNNING","FINAL_DUNNING","NO_DUNNING"]},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"paymentInstructions":{"allOf":[{"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Bank Account Iban Resource","description":"Payment instructions bank account using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction Bank Account QrIban Resource","description":"Payment instructions bank account using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"}},"type":"object"}]}],"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Iban Resource","description":"Payment instructions using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]},"reference":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction QrIban Resource","description":"Payment instructions using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"},"reference":{"type":["string","null"]}},"type":"object"}]},"documentTotal":{"type":"number","format":"float"},"taxPositions":{"type":"array","items":{"title":"Tax Position Resource","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"number","format":"int64","deprecated":true},"accountNumber":{"type":["number","null"],"format":"int64","deprecated":true},"bookingAccountUuid":{"type":["string","null"],"format":"uuid"},"isTaxIncluded":{"type":"boolean"},"amount":{"type":"number","format":"float"},"taxRate":{"type":"number","format":"float","deprecated":true},"vatUuid":{"type":["string","null"],"format":"uuid","deprecated":true},"taxRateUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"}},"type":"object"}},"isTemplate":{"type":"boolean"},"openAmount":{"type":"number","format":"float"},"type":{"type":"string","enum":["invoice"]},"subtype":{"type":["string","null"],"enum":["partial","final","on_account","instalment","dunning"]},"abanetSendAt":{"type":["string","null"],"format":"date-time"},"abanetConfirmedAt":{"type":["string","null"],"format":"date-time"},"wasRecognitionLimitReached":{"type":"boolean"},"hasCustomPaymentSlip":{"description":"if the invoice has a custom payment slip (true) or if it will be generated by AbaNinja (false)","type":"boolean"}},"type":"object"}},"type":"object"},{"title":"Invoice Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"invoiceDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"nextDunningDate":{"type":["string","null"],"format":"date"},"customDunningDate":{"type":["string","null"],"format":"date"},"dunningLevel":{"type":"string","enum":["REMINDER","FIRST_DUNNING","FINAL_DUNNING","NO_DUNNING"]},"paymentInstructions":{"allOf":[{"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Bank Account Iban Resource","description":"Payment instructions bank account using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction Bank Account QrIban Resource","description":"Payment instructions bank account using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"}},"type":"object"}]}],"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Iban Resource","description":"Payment instructions using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]},"reference":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction QrIban Resource","description":"Payment instructions using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"},"reference":{"type":["string","null"]}},"type":"object"}]},"pricesIncludeVat":{"type":"boolean"},"isVariantInvoice":{"type":"boolean"},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"isCollectiveBill":{"type":"boolean"},"invoiceNumber":{"description":"Equals to importedInvoiceNumber if set, otherwise systemInvoiceNumber","type":"string","deprecated":true},"importedInvoiceNumber":{"description":"The recognized invoiceNumber of the imported document","type":["string","null"]},"systemInvoiceNumber":{"description":"The invoiceNumber generated by AbaNinja","type":"string"},"openAmount":{"type":"number","format":"float"},"type":{"type":"string","enum":["invoice"]},"subtype":{"type":["string","null"],"enum":["partial","final","on_account","instalment","dunning"]},"abanetSendAt":{"type":["string","null"],"format":"date-time"},"abanetConfirmedAt":{"type":["string","null"],"format":"date-time"},"bookedAt":{"type":["string","null"],"format":"date-time"},"syncedAt":{"type":["string","null"],"format":"date-time"},"syncMessage":{"type":["string","null"]},"syncStatus":{"type":["string","null"],"enum":["OK","FAILED","INCORRECT_STATE","GENERAL_ERROR","CONNECTION_ERROR","BLOCKED_PREVIOUS_NOT_SYNCED"]},"cashDiscounts":{"type":"array","items":{"properties":{"days":{"type":"number","format":"int64"},"percentage":{"type":"number","format":"float"}},"type":"object"},"maxItems":3,"minItems":0},"documentDiscount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"},{"title":"Recurring Invoice Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"startDate":{"type":["string","null"],"format":"date"},"endDate":{"type":["string","null"],"format":"date"},"nextSendDate":{"type":["string","null"],"format":"date"},"frequency":{"type":["string","null"],"enum":["weekly","two_weeks","four_weeks","monthly","three_months","six_months","annually"]},"isRecurringActive":{"type":"boolean"},"isLastOfMonth":{"type":"boolean"},"paymentInstructions":{"allOf":[{"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Bank Account Iban Resource","description":"Payment instructions bank account using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction Bank Account QrIban Resource","description":"Payment instructions bank account using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"}},"type":"object"}]}],"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Iban Resource","description":"Payment instructions using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]},"reference":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction QrIban Resource","description":"Payment instructions using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"},"reference":{"type":["string","null"]}},"type":"object"}]},"pricesIncludeVat":{"type":"boolean"},"paymentTerms":{"type":["integer","null"],"deprecated":true},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"recurringInvoiceNumber":{"type":"string"},"type":{"type":"string","enum":["recurring_invoice"]},"cashDiscounts":{"type":"array","items":{"properties":{"days":{"type":"number","format":"int64"},"percentage":{"type":"number","format":"float"}},"type":"object"},"maxItems":3,"minItems":0},"documentDiscount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"},{"title":"Credit Note Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"creditNoteDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"pricesIncludeVat":{"type":"boolean"},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"creditNoteNumber":{"type":"string"},"openAmount":{"type":"number","format":"float"},"abanetSendAt":{"type":["string","null"],"format":"date-time"},"abanetConfirmedAt":{"type":["string","null"],"format":"date-time"},"type":{"type":"string","enum":["credit_note"]},"documentDiscount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"},{"title":"Quote Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"quoteDate":{"type":["string","null"],"format":"date"},"validUntilDate":{"type":["string","null"],"format":"date"},"pricesIncludeVat":{"type":"boolean"},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"quoteNumber":{"type":"string"},"type":{"type":"string","enum":["quote"]},"signaturePage":{"type":"boolean"},"deepSignSignatureMode":{"type":["string","null"],"enum":["timestamp","advanced","qualified"]},"signees":{"type":["array","null"],"items":{"title":"Signee Resource","properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["receiver","sender"]},"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"userUuid":{"type":["string","null"],"format":"uuid"},"signOrder":{"type":"number","format":"int64"},"companyName":{"type":["string","null"]},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"},"completedAt":{"type":["string","null"],"format":"date-time"},"signStatus":{"type":"string","enum":["pending","signed","rejected"]},"comment":{"type":["string","null"]}},"type":"object"}},"documentDiscount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"},{"title":"Delivery Note Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"deliveryNoteDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"deliveryNoteNumber":{"type":"string"},"type":{"type":"string","enum":["delivery_note"]},"documentDiscount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"},{"title":"Contract Note Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"contractNoteDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"paymentInstructions":{"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Bank Account Iban Resource","description":"Payment instructions bank account using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction Bank Account QrIban Resource","description":"Payment instructions bank account using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"}},"type":"object"}]},"pricesIncludeVat":{"type":"boolean"},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"contractNoteNumber":{"type":"string"},"type":{"type":"string","enum":["invoice"]},"documentDiscount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"},{"title":"Supplier Credit Note Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"supplierCreditNoteNumber":{"type":"string"},"supplierCreditNoteDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"documentTotal":{"type":"number","format":"float"},"taxPositions":{"type":"array","items":{"title":"Receipt Tax Position Resource","properties":{"id":{"type":"integer","format":"int64"},"accountNumber":{"type":"integer","format":"int64"},"isTaxIncluded":{"type":"boolean"},"amount":{"type":"number","format":"float"},"taxRate":{"type":"number","format":"float"},"taxRateUuid":{"type":["string","null"],"format":"uuid"}},"type":"object"}},"isTemplate":{"type":"boolean"},"openAmount":{"type":"number","format":"float"},"reference":{"type":"string"},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"type":{"type":"string","enum":["supplier_credit_note"]},"wasTaxIncluded":{"type":"boolean"},"wasRecognitionLimitReached":{"type":"boolean"}},"type":"object"},{"type":"null"}]}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers","https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"87b422a0b55aea120a99abab47af38ef","x-required-scopes":["customers","suppliers"]},"delete":{"tags":["documents_document-common"],"summary":"Delete queue","description":"Delete the document-mass-import queue. Can only be done as long as the queue is aborted, finished or failed.","operationId":"documents_delete_queue","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"queueUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"400":{"description":"Bad Request, for instance when queue is still pending","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers","https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"a4d754a6c2d7f83f9014ccef4dec070a","x-required-scopes":["customers","suppliers"]}},"/accounts/{accountUuid}/documents/v2/quotes/{quoteUuid}":{"get":{"tags":["documents_document-quotes"],"summary":"Get quote","description":"Get a single quote","operationId":"documents_get_quotes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"quoteUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"title":"Quote Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"quoteDate":{"type":["string","null"],"format":"date"},"validUntilDate":{"type":["string","null"],"format":"date"},"pricesIncludeVat":{"type":"boolean"},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"quoteNumber":{"type":"string"},"type":{"type":"string","enum":["quote"]},"signaturePage":{"type":"boolean"},"deepSignSignatureMode":{"type":["string","null"],"enum":["timestamp","advanced","qualified"]},"signees":{"type":["array","null"],"items":{"title":"Signee Resource","properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["receiver","sender"]},"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"userUuid":{"type":["string","null"],"format":"uuid"},"signOrder":{"type":"number","format":"int64"},"companyName":{"type":["string","null"]},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"},"completedAt":{"type":["string","null"],"format":"date-time"},"signStatus":{"type":"string","enum":["pending","signed","rejected"]},"comment":{"type":["string","null"]}},"type":"object"}},"documentDiscount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"8a2a61a8436b9ba0d7949a11cc335c1c","x-required-scopes":["customers"]},"patch":{"tags":["documents_document-quotes"],"summary":"Update quote","description":"Update quote","operationId":"documents_update_quotes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"quoteUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update quote","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/quote.schema.json","title":"Quotes","description":"A Schema for creating quotes in AbaNinja over API","type":"object","properties":{"documents":{"type":"array","items":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"quoteDate":{"type":"string","format":"date"},"validUntilDate":{"type":["null","string"],"format":"date"},"pricesIncludeVat":{"type":"boolean","description":"Controls if single_price and position_total includes vat or not"},"documentTotal":{"type":"number","description":"Total Amount incl. VAT"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"signaturePage":{"type":"boolean","default":false},"deepSignSignatureMode":{"type":["string","null"],"enum":["timestamp","advanced","qualified",null]},"signees":{"description":"if set at least one of each signee type (receiver, sender) is required","type":["array","null"],"maxItems":2,"minItems":2,"items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-signee.schema.json","title":"Signee","description":"Signee for documents","type":"object","oneOf":[{"title":"Receiver signee","type":"object","properties":{"type":{"const":"receiver"},"personUuid":{"description":"If the receiver address is a company, a person is needed","type":["null","string"],"format":"uuid"}}},{"title":"Sender signee","type":"object","properties":{"type":{"const":"sender"},"userUuid":{"type":"string","format":"uuid"}},"required":["userUuid"]}],"properties":{"type":{"type":"string","enum":["receiver","sender"]},"signOrder":{"description":"Order of the signature","type":"number","format":"int64"}},"required":["type"],"$defs":{"receiverSignee":{"title":"Receiver signee","type":"object","properties":{"type":{"const":"receiver"},"personUuid":{"description":"If the receiver address is a company, a person is needed","type":["null","string"],"format":"uuid"}}},"senderSignee":{"title":"Sender signee","type":"object","properties":{"type":{"const":"sender"},"userUuid":{"type":"string","format":"uuid"}},"required":["userUuid"]}}}}},"required":["quoteDate","documentTotal","pricesIncludeVat","positions"],"if":{"anyOf":[{"properties":{"signaturePage":{"const":true}},"required":["signaturePage"]},{"properties":{"signees":{"type":"array"}},"required":["signees"]}]},"then":{"properties":{"signees":{"type":"array"},"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["signees","receiver"]},"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]},"minItems":1}},"required":["documents"],"$defs":{"singleQuote":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"quoteDate":{"type":"string","format":"date"},"validUntilDate":{"type":["null","string"],"format":"date"},"pricesIncludeVat":{"type":"boolean","description":"Controls if single_price and position_total includes vat or not"},"documentTotal":{"type":"number","description":"Total Amount incl. VAT"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"signaturePage":{"type":"boolean","default":false},"deepSignSignatureMode":{"type":["string","null"],"enum":["timestamp","advanced","qualified",null]},"signees":{"description":"if set at least one of each signee type (receiver, sender) is required","type":["array","null"],"maxItems":2,"minItems":2,"items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-signee.schema.json","title":"Signee","description":"Signee for documents","type":"object","oneOf":[{"title":"Receiver signee","type":"object","properties":{"type":{"const":"receiver"},"personUuid":{"description":"If the receiver address is a company, a person is needed","type":["null","string"],"format":"uuid"}}},{"title":"Sender signee","type":"object","properties":{"type":{"const":"sender"},"userUuid":{"type":"string","format":"uuid"}},"required":["userUuid"]}],"properties":{"type":{"type":"string","enum":["receiver","sender"]},"signOrder":{"description":"Order of the signature","type":"number","format":"int64"}},"required":["type"],"$defs":{"receiverSignee":{"title":"Receiver signee","type":"object","properties":{"type":{"const":"receiver"},"personUuid":{"description":"If the receiver address is a company, a person is needed","type":["null","string"],"format":"uuid"}}},"senderSignee":{"title":"Sender signee","type":"object","properties":{"type":{"const":"sender"},"userUuid":{"type":"string","format":"uuid"}},"required":["userUuid"]}}}}},"required":["quoteDate","documentTotal","pricesIncludeVat","positions"],"if":{"anyOf":[{"properties":{"signaturePage":{"const":true}},"required":["signaturePage"]},{"properties":{"signees":{"type":"array"}},"required":["signees"]}]},"then":{"properties":{"signees":{"type":"array"},"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["signees","receiver"]},"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]}}}}}},"responses":{"200":{"description":"Quote updated","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"title":"Quote Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"quoteDate":{"type":["string","null"],"format":"date"},"validUntilDate":{"type":["string","null"],"format":"date"},"pricesIncludeVat":{"type":"boolean"},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"quoteNumber":{"type":"string"},"type":{"type":"string","enum":["quote"]},"signaturePage":{"type":"boolean"},"deepSignSignatureMode":{"type":["string","null"],"enum":["timestamp","advanced","qualified"]},"signees":{"type":["array","null"],"items":{"title":"Signee Resource","properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["receiver","sender"]},"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"userUuid":{"type":["string","null"],"format":"uuid"},"signOrder":{"type":"number","format":"int64"},"companyName":{"type":["string","null"]},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"},"completedAt":{"type":["string","null"],"format":"date-time"},"signStatus":{"type":"string","enum":["pending","signed","rejected"]},"comment":{"type":["string","null"]}},"type":"object"}},"documentDiscount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"9522edd35bb09efd6f54e4b72c2ddf5d","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/bulk-actions":{"get":{"tags":["documents_document-quotes"],"summary":"Get bulk actions","description":"Get quote bulk actions","operationId":"documents_list_bulk_actions_5","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"forList","in":"query","description":"filter list actions","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","example":{"archive":"Archive","cancel":"Cancel","delete":"Delete"},"additionalProperties":{"description":"description of the action","type":"string"},"propertyNames":{"enum":["paymentAdd","archive","cancel","cancelPermanently","clone","collectInvoice","convertCNDN","convertCNI","convertDNI","convertIC","convertDN","convertT","convertCN","convert","convertTemplateToContractNote","convertTemplateToCreditNote","convertTemplateToDeliveryNote","convertTI","convertTemplateToQuote","convertToTemplate","createFinal","createInstalments","createPartial","createOnAccount","customerPortalUrl","delete","dissolve","downloadPdf","downloadPaymentConfirmation","dunningPrint","dunningSent","dunningDate","setDunningAmounts","edit","activity","info","email","markApproved","markDeclined","markSent","massDownloadZip","massDunningPrint","massDunningSent","massPrint","massSent","offsetCreditNotes","offsetInvoices","offsetReceipts","offsetSupplierCreditNotes","plannedMail","print","regeneratePdf","resync","restore","save","sendPaymentConfirmation","sendAbaNet","sendDeepSign","sign","signSupplierCreditNote","sync"]}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"af83b8860f04611ab8893c1c58906bec","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/calculate":{"post":{"tags":["documents_document-quotes"],"summary":"Calculate amounts of new document","description":"Calculates the amounts of a document for previewing without manipulating any resources","operationId":"documents_create_calculate_5","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Document to calculate","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/invoice-calculate.schema.json","description":"A Schema for calculating invoices in AbaNinja over API","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}}},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"invoiceDate":{"type":["string","null"],"format":"date"}},"required":["positions","currencyCode"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Calculation Resource","properties":{"total":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"roundingDifference":{"type":"number","format":"float"},"taxes":{"type":"array","items":{"properties":{"rate":{"type":"number","format":"float"},"value":{"type":"number","format":"float"},"name":{"type":"string"},"baseSum":{"type":"number","format":"float"}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"ffd68eec742e89cc330f104e2eb996ce","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/receipts/bulk-actions":{"get":{"tags":["documents_document-receipts"],"summary":"Get bulk actions","description":"Get receipt bulk actions","operationId":"documents_list_bulk_actions_6","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"forList","in":"query","description":"filter list actions","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","example":{"archive":"Archive","cancel":"Cancel","delete":"Delete"},"additionalProperties":{"description":"description of the action","type":"string"},"propertyNames":{"enum":["paymentAdd","archive","cancel","cancelPermanently","clone","collectInvoice","convertCNDN","convertCNI","convertDNI","convertIC","convertDN","convertT","convertCN","convert","convertTemplateToContractNote","convertTemplateToCreditNote","convertTemplateToDeliveryNote","convertTI","convertTemplateToQuote","convertToTemplate","createFinal","createInstalments","createPartial","createOnAccount","customerPortalUrl","delete","dissolve","downloadPdf","downloadPaymentConfirmation","dunningPrint","dunningSent","dunningDate","setDunningAmounts","edit","activity","info","email","markApproved","markDeclined","markSent","massDownloadZip","massDunningPrint","massDunningSent","massPrint","massSent","offsetCreditNotes","offsetInvoices","offsetReceipts","offsetSupplierCreditNotes","plannedMail","print","regeneratePdf","resync","restore","save","sendPaymentConfirmation","sendAbaNet","sendDeepSign","sign","signSupplierCreditNote","sync"]}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"8b790c818770cc127fd555c004407a4b","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/recurring-invoices/{recurringInvoiceUuid}":{"get":{"tags":["documents_document-recurring-invoices"],"summary":"Get recurring invoice","description":"Get a single recurring invoice","operationId":"documents_get_recurring_invoices","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"recurringInvoiceUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"title":"Recurring Invoice Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"startDate":{"type":["string","null"],"format":"date"},"endDate":{"type":["string","null"],"format":"date"},"nextSendDate":{"type":["string","null"],"format":"date"},"frequency":{"type":["string","null"],"enum":["weekly","two_weeks","four_weeks","monthly","three_months","six_months","annually"]},"isRecurringActive":{"type":"boolean"},"isLastOfMonth":{"type":"boolean"},"paymentInstructions":{"allOf":[{"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Bank Account Iban Resource","description":"Payment instructions bank account using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction Bank Account QrIban Resource","description":"Payment instructions bank account using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"}},"type":"object"}]}],"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Iban Resource","description":"Payment instructions using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]},"reference":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction QrIban Resource","description":"Payment instructions using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"},"reference":{"type":["string","null"]}},"type":"object"}]},"pricesIncludeVat":{"type":"boolean"},"paymentTerms":{"type":["integer","null"],"deprecated":true},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"recurringInvoiceNumber":{"type":"string"},"type":{"type":"string","enum":["recurring_invoice"]},"cashDiscounts":{"type":"array","items":{"properties":{"days":{"type":"number","format":"int64"},"percentage":{"type":"number","format":"float"}},"type":"object"},"maxItems":3,"minItems":0},"documentDiscount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"438bf040f7a75b30e2e4beda77ab7cb8","x-required-scopes":["customers"]},"patch":{"tags":["documents_document-recurring-invoices"],"summary":"Update recurring invoice","description":"Update recurring invoice","operationId":"documents_update_recurring_invoices_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"recurringInvoiceUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update recurring invoice","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/recurring-invoice.schema.json","title":"Recurring invoices","description":"A Schema for creating recurring invoices in AbaNinja over API","type":"object","properties":{"documents":{"type":"array","items":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}},"startDate":{"type":"string","format":"date"},"endDate":{"type":["null","string"],"format":"date"},"frequency":{"enum":["weekly","two_weeks","four_weeks","monthly","three_months","six_months","annually"]},"isRecurringActive":{"type":"boolean","default":false},"isLastOfMonth":{"type":"boolean","default":false,"description":"send invoice always at end of month. Only has an effect with frequencies monthly, three_months and six_months."},"paymentInstructions":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/payment-instructions.schema.json","title":"Payment Instructions","description":"Payment Instruction Schema for AbaNinja Invoice Json","oneOf":[{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}],"$defs":{"ibanInstruction":{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},"qrIbanInstruction":{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},"bankAccountReference":{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}}},"pricesIncludeVat":{"type":"boolean","description":"Controls if single_price and position_total includes vat or not"},"documentTotal":{"type":"number","description":"Total Amount incl. VAT"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"cashDiscounts":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/cash-discount.schema.json","description":"Cash Discount Schema for AbaNinja Invoice Json","type":"object","properties":{"days":{"type":"integer","minimum":1,"maximum":60,"description":"Number of days"},"percentage":{"type":"number","minimum":0.5,"maximum":100}},"required":["days","percentage"]},"description":"Skonto","maxItems":3},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"billingPeriod":{"type":"string","enum":["NONE","CURRENT","PREVIOUS","NEXT"],"default":"NONE"}},"required":["receiver","startDate","frequency","paymentInstructions","documentTotal","pricesIncludeVat","positions"]},"minItems":1}},"required":["documents"],"$defs":{"singleRecurringInvoice":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}},"startDate":{"type":"string","format":"date"},"endDate":{"type":["null","string"],"format":"date"},"frequency":{"enum":["weekly","two_weeks","four_weeks","monthly","three_months","six_months","annually"]},"isRecurringActive":{"type":"boolean","default":false},"isLastOfMonth":{"type":"boolean","default":false,"description":"send invoice always at end of month. Only has an effect with frequencies monthly, three_months and six_months."},"paymentInstructions":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/payment-instructions.schema.json","title":"Payment Instructions","description":"Payment Instruction Schema for AbaNinja Invoice Json","oneOf":[{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}],"$defs":{"ibanInstruction":{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},"qrIbanInstruction":{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},"bankAccountReference":{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}}},"pricesIncludeVat":{"type":"boolean","description":"Controls if single_price and position_total includes vat or not"},"documentTotal":{"type":"number","description":"Total Amount incl. VAT"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"cashDiscounts":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/cash-discount.schema.json","description":"Cash Discount Schema for AbaNinja Invoice Json","type":"object","properties":{"days":{"type":"integer","minimum":1,"maximum":60,"description":"Number of days"},"percentage":{"type":"number","minimum":0.5,"maximum":100}},"required":["days","percentage"]},"description":"Skonto","maxItems":3},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"billingPeriod":{"type":"string","enum":["NONE","CURRENT","PREVIOUS","NEXT"],"default":"NONE"}},"required":["receiver","startDate","frequency","paymentInstructions","documentTotal","pricesIncludeVat","positions"]}}}}}},"responses":{"200":{"description":"Recurring invoice updated","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"title":"Recurring Invoice Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"startDate":{"type":["string","null"],"format":"date"},"endDate":{"type":["string","null"],"format":"date"},"nextSendDate":{"type":["string","null"],"format":"date"},"frequency":{"type":["string","null"],"enum":["weekly","two_weeks","four_weeks","monthly","three_months","six_months","annually"]},"isRecurringActive":{"type":"boolean"},"isLastOfMonth":{"type":"boolean"},"paymentInstructions":{"allOf":[{"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Bank Account Iban Resource","description":"Payment instructions bank account using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction Bank Account QrIban Resource","description":"Payment instructions bank account using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"}},"type":"object"}]}],"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Iban Resource","description":"Payment instructions using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]},"reference":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction QrIban Resource","description":"Payment instructions using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"},"reference":{"type":["string","null"]}},"type":"object"}]},"pricesIncludeVat":{"type":"boolean"},"paymentTerms":{"type":["integer","null"],"deprecated":true},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"recurringInvoiceNumber":{"type":"string"},"type":{"type":"string","enum":["recurring_invoice"]},"cashDiscounts":{"type":"array","items":{"properties":{"days":{"type":"number","format":"int64"},"percentage":{"type":"number","format":"float"}},"type":"object"},"maxItems":3,"minItems":0},"documentDiscount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"c1aa815d1c66d5a3cb1e1e633f0d50c1","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/recurring-invoices/bulk-actions":{"get":{"tags":["documents_document-recurring-invoices"],"summary":"Get bulk actions","description":"Get recurring invoice bulk actions","operationId":"documents_list_bulk_actions_7","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"forList","in":"query","description":"filter list actions","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","example":{"archive":"Archive","cancel":"Cancel","delete":"Delete"},"additionalProperties":{"description":"description of the action","type":"string"},"propertyNames":{"enum":["paymentAdd","archive","cancel","cancelPermanently","clone","collectInvoice","convertCNDN","convertCNI","convertDNI","convertIC","convertDN","convertT","convertCN","convert","convertTemplateToContractNote","convertTemplateToCreditNote","convertTemplateToDeliveryNote","convertTI","convertTemplateToQuote","convertToTemplate","createFinal","createInstalments","createPartial","createOnAccount","customerPortalUrl","delete","dissolve","downloadPdf","downloadPaymentConfirmation","dunningPrint","dunningSent","dunningDate","setDunningAmounts","edit","activity","info","email","markApproved","markDeclined","markSent","massDownloadZip","massDunningPrint","massDunningSent","massPrint","massSent","offsetCreditNotes","offsetInvoices","offsetReceipts","offsetSupplierCreditNotes","plannedMail","print","regeneratePdf","resync","restore","save","sendPaymentConfirmation","sendAbaNet","sendDeepSign","sign","signSupplierCreditNote","sync"]}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"133ba048cc8bd19d3ec3662e8ce76c5c","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/recurring-invoices/calculate":{"post":{"tags":["documents_document-recurring-invoices"],"summary":"Calculate amounts of new document","description":"Calculates the amounts of a document for previewing without manipulating any resources","operationId":"documents_create_calculate_4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Document to calculate","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/invoice-calculate.schema.json","description":"A Schema for calculating invoices in AbaNinja over API","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}}},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"invoiceDate":{"type":["string","null"],"format":"date"}},"required":["positions","currencyCode"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Calculation Resource","properties":{"total":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"roundingDifference":{"type":"number","format":"float"},"taxes":{"type":"array","items":{"properties":{"rate":{"type":"number","format":"float"},"value":{"type":"number","format":"float"},"name":{"type":"string"},"baseSum":{"type":"number","format":"float"}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"fecfb8eb5550302a187d837ed5637263","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/supplier-credit-notes/{supplierCreditNoteUuid}":{"get":{"tags":["documents_document-supplier-credit-notes"],"summary":"Get supplier credit note","description":"Get a single supplier credit note","operationId":"documents_get_supplier_credit_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"supplierCreditNoteUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"title":"Supplier Credit Note Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"supplierCreditNoteNumber":{"type":"string"},"supplierCreditNoteDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"documentTotal":{"type":"number","format":"float"},"taxPositions":{"type":"array","items":{"title":"Receipt Tax Position Resource","properties":{"id":{"type":"integer","format":"int64"},"accountNumber":{"type":"integer","format":"int64"},"isTaxIncluded":{"type":"boolean"},"amount":{"type":"number","format":"float"},"taxRate":{"type":"number","format":"float"},"taxRateUuid":{"type":["string","null"],"format":"uuid"}},"type":"object"}},"isTemplate":{"type":"boolean"},"openAmount":{"type":"number","format":"float"},"reference":{"type":"string"},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"type":{"type":"string","enum":["supplier_credit_note"]},"wasTaxIncluded":{"type":"boolean"},"wasRecognitionLimitReached":{"type":"boolean"}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"9116ca8fca3b969df4aaae57c3e4d535","x-required-scopes":["suppliers"]},"patch":{"tags":["documents_document-supplier-credit-notes"],"summary":"Update supplier credit note","description":"Update supplier credit note","operationId":"documents_update_supplier_credit_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"supplierCreditNoteUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update supplier credit note","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/import-supplier-credit-note.update.schema.json","description":"A Schema for updating an imported supplier credit note in AbaNinja over API","type":"object","properties":{"documents":{"type":"array","items":{"type":"object","properties":{"documentData":{"type":"object","description":"Additional Data for the invoice document","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}},"supplierCreditNoteDate":{"type":"string","format":"date"},"dueDate":{"type":"string","format":"date"},"reference":{"type":"string"},"documentTotal":{"type":"number","exclusiveMinimum":0,"description":"Total Amount incl. VAT"},"taxPositions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/tax-position.schema.json","description":"A Schema for tax positions for imported invoices","type":"object","properties":{"id":{"type":["integer","null"],"exclusiveMinimum":0,"deprecated":true,"description":"identifier of the object. \"uuid\" should be used instead"},"uuid":{"type":["string","null"],"format":"uuid"},"accountNumber":{"type":"integer","minimum":1000,"maximum":999999999999,"deprecated":true,"description":"The booking account number. Use bookingAccountUuid instead."},"bookingAccountUuid":{"type":["string","null"],"format":"uuid"},"isTaxIncluded":{"type":"boolean","default":false,"description":"controls if amount already includes tax or not"},"amount":{"type":"number"},"taxRate":{"type":"number","minimum":0,"maximum":100,"deprecated":true,"description":"Tax Rate to apply. Use \"taxRateUuid\" instead"},"taxRateUuid":{"type":["null","string"],"format":"uuid"}},"required":["amount"]},"minItems":1},"wasTaxIncluded":{"type":"boolean","default":false,"description":"Controls whether tax was included during supplier credit note invoicing"}},"required":["currencyCode","receiver","supplierCreditNoteDate","dueDate","documentTotal","taxPositions"]}},"required":["documentData"]},"maxItems":1,"minItems":1}},"required":["documents"],"$defs":{"singleDocument":{"type":"object","properties":{"documentData":{"type":"object","description":"Additional Data for the invoice document","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}},"supplierCreditNoteDate":{"type":"string","format":"date"},"dueDate":{"type":"string","format":"date"},"reference":{"type":"string"},"documentTotal":{"type":"number","exclusiveMinimum":0,"description":"Total Amount incl. VAT"},"taxPositions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/tax-position.schema.json","description":"A Schema for tax positions for imported invoices","type":"object","properties":{"id":{"type":["integer","null"],"exclusiveMinimum":0,"deprecated":true,"description":"identifier of the object. \"uuid\" should be used instead"},"uuid":{"type":["string","null"],"format":"uuid"},"accountNumber":{"type":"integer","minimum":1000,"maximum":999999999999,"deprecated":true,"description":"The booking account number. Use bookingAccountUuid instead."},"bookingAccountUuid":{"type":["string","null"],"format":"uuid"},"isTaxIncluded":{"type":"boolean","default":false,"description":"controls if amount already includes tax or not"},"amount":{"type":"number"},"taxRate":{"type":"number","minimum":0,"maximum":100,"deprecated":true,"description":"Tax Rate to apply. Use \"taxRateUuid\" instead"},"taxRateUuid":{"type":["null","string"],"format":"uuid"}},"required":["amount"]},"minItems":1},"wasTaxIncluded":{"type":"boolean","default":false,"description":"Controls whether tax was included during supplier credit note invoicing"}},"required":["currencyCode","receiver","supplierCreditNoteDate","dueDate","documentTotal","taxPositions"]}},"required":["documentData"]}}}}}},"responses":{"200":{"description":"Supplier credit note updated","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"title":"Supplier Credit Note Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"supplierCreditNoteNumber":{"type":"string"},"supplierCreditNoteDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"documentTotal":{"type":"number","format":"float"},"taxPositions":{"type":"array","items":{"title":"Receipt Tax Position Resource","properties":{"id":{"type":"integer","format":"int64"},"accountNumber":{"type":"integer","format":"int64"},"isTaxIncluded":{"type":"boolean"},"amount":{"type":"number","format":"float"},"taxRate":{"type":"number","format":"float"},"taxRateUuid":{"type":["string","null"],"format":"uuid"}},"type":"object"}},"isTemplate":{"type":"boolean"},"openAmount":{"type":"number","format":"float"},"reference":{"type":"string"},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"type":{"type":"string","enum":["supplier_credit_note"]},"wasTaxIncluded":{"type":"boolean"},"wasRecognitionLimitReached":{"type":"boolean"}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"a6329e81489eec62d7e674368e7492a9","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/supplier-credit-notes/bulk-actions":{"get":{"tags":["documents_document-supplier-credit-notes"],"summary":"Get bulk actions","description":"Get supplier credit note bulk actions","operationId":"documents_list_bulk_actions_8","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"forList","in":"query","description":"filter list actions","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","example":{"archive":"Archive","cancel":"Cancel","delete":"Delete"},"additionalProperties":{"description":"description of the action","type":"string"},"propertyNames":{"enum":["paymentAdd","archive","cancel","cancelPermanently","clone","collectInvoice","convertCNDN","convertCNI","convertDNI","convertIC","convertDN","convertT","convertCN","convert","convertTemplateToContractNote","convertTemplateToCreditNote","convertTemplateToDeliveryNote","convertTI","convertTemplateToQuote","convertToTemplate","createFinal","createInstalments","createPartial","createOnAccount","customerPortalUrl","delete","dissolve","downloadPdf","downloadPaymentConfirmation","dunningPrint","dunningSent","dunningDate","setDunningAmounts","edit","activity","info","email","markApproved","markDeclined","markSent","massDownloadZip","massDunningPrint","massDunningSent","massPrint","massSent","offsetCreditNotes","offsetInvoices","offsetReceipts","offsetSupplierCreditNotes","plannedMail","print","regeneratePdf","resync","restore","save","sendPaymentConfirmation","sendAbaNet","sendDeepSign","sign","signSupplierCreditNote","sync"]}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"21e2d9ace3155762312873f76962c4b2","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/{type}/{invoiceUuid}/preview":{"post":{"tags":["documents_document-invoices","documents_document-contract-notes","documents_document-recurring-invoices","documents_document-quotes","documents_document-delivery-notes","documents_document-credit-notes"],"summary":"Create preview","description":"Creates a new PDF preview for a document or returns the sent PDF if one exists","operationId":"documents_create_preview","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"invoiceUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"type","in":"path","description":"Type of the document","required":true,"schema":{"type":"string","enum":["invoices","contract-notes","recurring-invoices","quotes","delivery-notes","credit-notes"]}}],"requestBody":{"description":"Create a PDF preview for a document overwriting the stored values. Omit to simply return the PDF for stored values.","required":false,"content":{"application/json":{"schema":{"oneOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/invoice.preview.schema.json","title":"Invoices","description":"A Schema for previewing invoices in AbaNinja over API","type":"object","properties":{"documents":{"type":"array","items":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"invoiceDate":{"type":"string","format":"date"},"dueDate":{"type":["null","string"],"format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"paymentInstructions":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/payment-instructions.schema.json","title":"Payment Instructions","description":"Payment Instruction Schema for AbaNinja Invoice Json","oneOf":[{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}],"$defs":{"ibanInstruction":{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},"qrIbanInstruction":{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},"bankAccountReference":{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}}},"pricesIncludeVat":{"type":"boolean","description":"Controls if singlePrice includes vat or not"},"isVariantInvoice":{"type":"boolean","default":false},"documentTotal":{"type":"number","description":"Total Amount incl. VAT","deprecated":true},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"cashDiscounts":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/cash-discount.schema.json","description":"Cash Discount Schema for AbaNinja Invoice Json","type":"object","properties":{"days":{"type":"integer","minimum":1,"maximum":60,"description":"Number of days"},"percentage":{"type":"number","minimum":0.5,"maximum":100}},"required":["days","percentage"]},"description":"Skonto","maxItems":3},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]}},"required":["invoiceDate","paymentInstructions","pricesIncludeVat","positions"],"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]},"minItems":1,"maxItems":1}},"$defs":{"singleInvoice":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"invoiceDate":{"type":"string","format":"date"},"dueDate":{"type":["null","string"],"format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"paymentInstructions":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/payment-instructions.schema.json","title":"Payment Instructions","description":"Payment Instruction Schema for AbaNinja Invoice Json","oneOf":[{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}],"$defs":{"ibanInstruction":{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},"qrIbanInstruction":{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},"bankAccountReference":{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}}},"pricesIncludeVat":{"type":"boolean","description":"Controls if singlePrice includes vat or not"},"isVariantInvoice":{"type":"boolean","default":false},"documentTotal":{"type":"number","description":"Total Amount incl. VAT","deprecated":true},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"cashDiscounts":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/cash-discount.schema.json","description":"Cash Discount Schema for AbaNinja Invoice Json","type":"object","properties":{"days":{"type":"integer","minimum":1,"maximum":60,"description":"Number of days"},"percentage":{"type":"number","minimum":0.5,"maximum":100}},"required":["days","percentage"]},"description":"Skonto","maxItems":3},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]}},"required":["invoiceDate","paymentInstructions","pricesIncludeVat","positions"],"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]}}},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/contract-note.preview.schema.json","title":"Contract notes","description":"A Schema for previewing contract notes in AbaNinja over API","type":"object","properties":{"documents":{"type":"array","items":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"contractNoteDate":{"type":"string","format":"date"},"dueDate":{"type":["null","string"],"format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"paymentInstructions":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/payment-instructions-bank-account.schema.json","title":"Payment Instructions Bank Account","description":"Payment Instruction Schema for AbaNinja Invoice Json without reference","oneOf":[{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"}},"required":["qrIban"]},{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"}},"required":["bankAccountUuid"]}],"$defs":{"ibanInstruction":{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},"qrIbanInstruction":{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"}},"required":["qrIban"]},"bankAccountReference":{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"}},"required":["bankAccountUuid"]}}}]},"pricesIncludeVat":{"type":"boolean","description":"Controls if singlePrice includes vat or not"},"documentTotal":{"type":"number","description":"Total Amount incl. VAT","deprecated":true},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]}},"required":["contractNoteDate","pricesIncludeVat","positions"],"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]},"minItems":1,"maxItems":1}},"$defs":{"singleContractNote":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"contractNoteDate":{"type":"string","format":"date"},"dueDate":{"type":["null","string"],"format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"paymentInstructions":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/payment-instructions-bank-account.schema.json","title":"Payment Instructions Bank Account","description":"Payment Instruction Schema for AbaNinja Invoice Json without reference","oneOf":[{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"}},"required":["qrIban"]},{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"}},"required":["bankAccountUuid"]}],"$defs":{"ibanInstruction":{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},"qrIbanInstruction":{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"}},"required":["qrIban"]},"bankAccountReference":{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"}},"required":["bankAccountUuid"]}}}]},"pricesIncludeVat":{"type":"boolean","description":"Controls if singlePrice includes vat or not"},"documentTotal":{"type":"number","description":"Total Amount incl. VAT","deprecated":true},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]}},"required":["contractNoteDate","pricesIncludeVat","positions"],"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]}}},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/recurring-invoice.preview.schema.json","title":"Recurring invoices","description":"A Schema for previewing recurring invoices in AbaNinja over API","type":"object","properties":{"documents":{"type":"array","items":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}},"startDate":{"type":"string","format":"date"},"endDate":{"type":["null","string"],"format":"date"},"frequency":{"enum":["weekly","two_weeks","four_weeks","monthly","three_months","six_months","annually"]},"isRecurringActive":{"type":"boolean","default":false},"isLastOfMonth":{"type":"boolean","default":false,"description":"send invoice always at end of month. Only has an effect with frequencies monthly, three_months and six_months."},"paymentInstructions":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/payment-instructions.schema.json","title":"Payment Instructions","description":"Payment Instruction Schema for AbaNinja Invoice Json","oneOf":[{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}],"$defs":{"ibanInstruction":{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},"qrIbanInstruction":{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},"bankAccountReference":{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}}},"pricesIncludeVat":{"type":"boolean","description":"Controls if single_price and position_total includes vat or not"},"documentTotal":{"type":"number","description":"Total Amount incl. VAT","deprecated":true},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"cashDiscounts":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/cash-discount.schema.json","description":"Cash Discount Schema for AbaNinja Invoice Json","type":"object","properties":{"days":{"type":"integer","minimum":1,"maximum":60,"description":"Number of days"},"percentage":{"type":"number","minimum":0.5,"maximum":100}},"required":["days","percentage"]},"description":"Skonto","maxItems":3},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"billingPeriod":{"type":"string","enum":["NONE","CURRENT","PREVIOUS","NEXT"],"default":"NONE"}},"required":["receiver","startDate","frequency","paymentInstructions","pricesIncludeVat","positions"]},"minItems":1,"maxItems":1}},"$defs":{"singleRecurringInvoice":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}},"startDate":{"type":"string","format":"date"},"endDate":{"type":["null","string"],"format":"date"},"frequency":{"enum":["weekly","two_weeks","four_weeks","monthly","three_months","six_months","annually"]},"isRecurringActive":{"type":"boolean","default":false},"isLastOfMonth":{"type":"boolean","default":false,"description":"send invoice always at end of month. Only has an effect with frequencies monthly, three_months and six_months."},"paymentInstructions":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/payment-instructions.schema.json","title":"Payment Instructions","description":"Payment Instruction Schema for AbaNinja Invoice Json","oneOf":[{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}],"$defs":{"ibanInstruction":{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},"qrIbanInstruction":{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},"bankAccountReference":{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}}},"pricesIncludeVat":{"type":"boolean","description":"Controls if single_price and position_total includes vat or not"},"documentTotal":{"type":"number","description":"Total Amount incl. VAT","deprecated":true},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"cashDiscounts":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/cash-discount.schema.json","description":"Cash Discount Schema for AbaNinja Invoice Json","type":"object","properties":{"days":{"type":"integer","minimum":1,"maximum":60,"description":"Number of days"},"percentage":{"type":"number","minimum":0.5,"maximum":100}},"required":["days","percentage"]},"description":"Skonto","maxItems":3},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"billingPeriod":{"type":"string","enum":["NONE","CURRENT","PREVIOUS","NEXT"],"default":"NONE"}},"required":["receiver","startDate","frequency","paymentInstructions","pricesIncludeVat","positions"]}}},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/quote.preview.schema.json","title":"Quotes","description":"A Schema for previewing quotes in AbaNinja over API","type":"object","properties":{"documents":{"type":"array","items":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"quoteDate":{"type":"string","format":"date"},"validUntilDate":{"type":["null","string"],"format":"date"},"pricesIncludeVat":{"type":"boolean","description":"Controls if single_price and position_total includes vat or not"},"documentTotal":{"type":"number","description":"Total Amount incl. VAT","deprecated":true},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"signaturePage":{"type":"boolean","default":false},"deepSignSignatureMode":{"type":["string","null"],"enum":["timestamp","advanced","qualified",null]},"signees":{"description":"if set at least one of each signee type (receiver, sender) is required","type":["array","null"],"maxItems":2,"minItems":2,"items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-signee.schema.json","title":"Signee","description":"Signee for documents","type":"object","oneOf":[{"title":"Receiver signee","type":"object","properties":{"type":{"const":"receiver"},"personUuid":{"description":"If the receiver address is a company, a person is needed","type":["null","string"],"format":"uuid"}}},{"title":"Sender signee","type":"object","properties":{"type":{"const":"sender"},"userUuid":{"type":"string","format":"uuid"}},"required":["userUuid"]}],"properties":{"type":{"type":"string","enum":["receiver","sender"]},"signOrder":{"description":"Order of the signature","type":"number","format":"int64"}},"required":["type"],"$defs":{"receiverSignee":{"title":"Receiver signee","type":"object","properties":{"type":{"const":"receiver"},"personUuid":{"description":"If the receiver address is a company, a person is needed","type":["null","string"],"format":"uuid"}}},"senderSignee":{"title":"Sender signee","type":"object","properties":{"type":{"const":"sender"},"userUuid":{"type":"string","format":"uuid"}},"required":["userUuid"]}}}}},"required":["quoteDate","pricesIncludeVat","positions"],"if":{"anyOf":[{"properties":{"signaturePage":{"const":true}},"required":["signaturePage"]},{"properties":{"signees":{"type":"array"}},"required":["signees"]}]},"then":{"properties":{"signees":{"type":"array"},"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["signees","receiver"]},"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]},"minItems":1,"maxItems":1}},"$defs":{"singleQuote":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"quoteDate":{"type":"string","format":"date"},"validUntilDate":{"type":["null","string"],"format":"date"},"pricesIncludeVat":{"type":"boolean","description":"Controls if single_price and position_total includes vat or not"},"documentTotal":{"type":"number","description":"Total Amount incl. VAT","deprecated":true},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"signaturePage":{"type":"boolean","default":false},"deepSignSignatureMode":{"type":["string","null"],"enum":["timestamp","advanced","qualified",null]},"signees":{"description":"if set at least one of each signee type (receiver, sender) is required","type":["array","null"],"maxItems":2,"minItems":2,"items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-signee.schema.json","title":"Signee","description":"Signee for documents","type":"object","oneOf":[{"title":"Receiver signee","type":"object","properties":{"type":{"const":"receiver"},"personUuid":{"description":"If the receiver address is a company, a person is needed","type":["null","string"],"format":"uuid"}}},{"title":"Sender signee","type":"object","properties":{"type":{"const":"sender"},"userUuid":{"type":"string","format":"uuid"}},"required":["userUuid"]}],"properties":{"type":{"type":"string","enum":["receiver","sender"]},"signOrder":{"description":"Order of the signature","type":"number","format":"int64"}},"required":["type"],"$defs":{"receiverSignee":{"title":"Receiver signee","type":"object","properties":{"type":{"const":"receiver"},"personUuid":{"description":"If the receiver address is a company, a person is needed","type":["null","string"],"format":"uuid"}}},"senderSignee":{"title":"Sender signee","type":"object","properties":{"type":{"const":"sender"},"userUuid":{"type":"string","format":"uuid"}},"required":["userUuid"]}}}}},"required":["quoteDate","pricesIncludeVat","positions"],"if":{"anyOf":[{"properties":{"signaturePage":{"const":true}},"required":["signaturePage"]},{"properties":{"signees":{"type":"array"}},"required":["signees"]}]},"then":{"properties":{"signees":{"type":"array"},"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["signees","receiver"]},"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]}}},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/delivery-note.preview.schema.json","title":"Delivery notes","description":"A Schema for previewing delivery notes in AbaNinja over API","type":"object","properties":{"documents":{"type":"array","items":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"deliveryNoteDate":{"type":"string","format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/delivery-note-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber, productDescription and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over unitCode"},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Price, which will be used when converting the delivery note to another document like an invoice"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\". Used only when converting the delivery note to another document like an invoice."},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"],"description":"VAT to use. Is precedented by \"vatUuid\". Used only when converting the delivery note to another document like an invoice."}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber, productDescription and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over unitCode"},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Price, which will be used when converting the delivery note to another document like an invoice"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\". Used only when converting the delivery note to another document like an invoice."},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"],"description":"VAT to use. Is precedented by \"vatUuid\". Used only when converting the delivery note to another document like an invoice."}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1},"showCollapsed":{"type":"boolean","default":true}},"required":["title","kind","items"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber, productDescription and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over unitCode"},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Price, which will be used when converting the delivery note to another document like an invoice"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\". Used only when converting the delivery note to another document like an invoice."},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"],"description":"VAT to use. Is precedented by \"vatUuid\". Used only when converting the delivery note to another document like an invoice."}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber, productDescription and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over unitCode"},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Price, which will be used when converting the delivery note to another document like an invoice"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\". Used only when converting the delivery note to another document like an invoice."},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"],"description":"VAT to use. Is precedented by \"vatUuid\". Used only when converting the delivery note to another document like an invoice."}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1},"showCollapsed":{"type":"boolean","default":true}},"required":["title","kind","items"]}}},"minItems":1}},"required":["deliveryNoteDate","positions"],"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]},"minItems":1,"maxItems":1}},"$defs":{"singleDeliveryNote":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"deliveryNoteDate":{"type":"string","format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/delivery-note-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber, productDescription and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over unitCode"},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Price, which will be used when converting the delivery note to another document like an invoice"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\". Used only when converting the delivery note to another document like an invoice."},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"],"description":"VAT to use. Is precedented by \"vatUuid\". Used only when converting the delivery note to another document like an invoice."}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber, productDescription and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over unitCode"},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Price, which will be used when converting the delivery note to another document like an invoice"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\". Used only when converting the delivery note to another document like an invoice."},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"],"description":"VAT to use. Is precedented by \"vatUuid\". Used only when converting the delivery note to another document like an invoice."}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1},"showCollapsed":{"type":"boolean","default":true}},"required":["title","kind","items"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber, productDescription and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over unitCode"},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Price, which will be used when converting the delivery note to another document like an invoice"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\". Used only when converting the delivery note to another document like an invoice."},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"],"description":"VAT to use. Is precedented by \"vatUuid\". Used only when converting the delivery note to another document like an invoice."}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber, productDescription and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over unitCode"},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Price, which will be used when converting the delivery note to another document like an invoice"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\". Used only when converting the delivery note to another document like an invoice."},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"],"description":"VAT to use. Is precedented by \"vatUuid\". Used only when converting the delivery note to another document like an invoice."}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1},"showCollapsed":{"type":"boolean","default":true}},"required":["title","kind","items"]}}},"minItems":1}},"required":["deliveryNoteDate","positions"],"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]}}},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/credit-note.preview.schema.json","title":"Credit notes","description":"A Schema for previewing credit notes in AbaNinja over API","type":"object","properties":{"documents":{"type":"array","items":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"creditNoteDate":{"type":"string","format":"date"},"dueDate":{"type":["null","string"],"format":"date"},"pricesIncludeVat":{"type":"boolean","description":"Controls if single_price and position_total includes vat or not"},"documentTotal":{"type":"number","description":"Total Amount incl. VAT","deprecated":true},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]}},"required":["creditNoteDate","pricesIncludeVat","positions"],"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]},"minItems":1,"maxItems":1}},"$defs":{"singleCreditNote":{"type":"object","allOf":[{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-general-header.schema.json","description":"Schema for Invoice header properties valid for all invoice types (creditnote, recurring etc.)","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"title":{"type":["null","string"],"maxLength":75},"reference":{"type":["string"],"maxLength":255},"customField1":{"type":["null","string"],"maxLength":255},"customField2":{"type":["null","string"],"maxLength":255},"customField3":{"type":["null","string"],"maxLength":255},"customField4":{"type":["null","string"],"maxLength":255},"terms":{"type":["string"]},"publicNotes":{"type":["null","string"]},"footerText":{"type":["null","string"]}},"required":["currencyCode"]}],"properties":{"isTemplate":{"type":"boolean"},"creditNoteDate":{"type":"string","format":"date"},"dueDate":{"type":["null","string"],"format":"date"},"pricesIncludeVat":{"type":"boolean","description":"Controls if single_price and position_total includes vat or not"},"documentTotal":{"type":"number","description":"Total Amount incl. VAT","deprecated":true},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}},"minItems":1},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]}},"required":["creditNoteDate","pricesIncludeVat","positions"],"anyOf":[{"properties":{"isTemplate":{"const":true},"receiver":{"oneOf":[{"type":"null"},{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}]}},"required":["isTemplate"]},{"properties":{"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}}},"required":["receiver"]}]}}}]}}}},"responses":{"201":{"description":"Created a preview PDF","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Created Preview Resource","description":"Created PDF preview","properties":{"previewUrl":{"type":"string","format":"uri"},"downloadUrl":{"type":"string","format":"uri"},"expiresAt":{"type":["string","null"],"format":"date-time"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"82f90a22d3bd897616be85162928664b","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/{type}/preview/{previewUuid}":{"get":{"tags":["documents_document-invoices","documents_document-contract-notes","documents_document-recurring-invoices","documents_document-quotes","documents_document-delivery-notes","documents_document-credit-notes"],"summary":"Show PDF Preview","description":"Returns a previously created PDF preview file","operationId":"documents_get_preview","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"previewUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"type","in":"path","description":"Type of the document","required":true,"schema":{"type":"string","enum":["invoices","contract-notes","recurring-invoices","quotes","delivery-notes","credit-notes"]}},{"name":"forceDownload","in":"query","description":"If true, then the file shall be sent as Content-Disposition: attachment","required":false,"schema":{"type":"boolean","default":false}},{"name":"cert","in":"query","description":"Signature parameter, generated and returned when creating preview","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","headers":{"Content-Type":{"schema":{"type":"string","enum":["application/pdf"]}},"Content-Disposition":{"description":"\"inline\" or \"attachment\", based on the forceDownload query param","schema":{"type":"string","example":"attachment; filename=\"invoice-preview.pdf\""}}},"content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"403":{"description":"Invalid signature","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Preview not available anymore","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[],"x-legacy-operation-id":"8d06ad9a9255dd0c78752532e7de7c76"}},"/accounts/{accountUuid}/documents/v2/contract-notes/{contractNoteUuid}/actions":{"get":{"tags":["documents_document-contract-notes"],"summary":"Get actions","description":"Get contract note actions","operationId":"documents_list_actions","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"contractNoteUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"forList","in":"query","description":"filter list actions","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","example":{"archive":"Archive","cancel":"Cancel","delete":"Delete"},"additionalProperties":{"description":"description of the action","type":"string"},"propertyNames":{"enum":["paymentAdd","archive","cancel","cancelPermanently","clone","collectInvoice","convertCNDN","convertCNI","convertDNI","convertIC","convertDN","convertT","convertCN","convert","convertTemplateToContractNote","convertTemplateToCreditNote","convertTemplateToDeliveryNote","convertTI","convertTemplateToQuote","convertToTemplate","createFinal","createInstalments","createPartial","createOnAccount","customerPortalUrl","delete","dissolve","downloadPdf","downloadPaymentConfirmation","dunningPrint","dunningSent","dunningDate","setDunningAmounts","edit","activity","info","email","markApproved","markDeclined","markSent","massDownloadZip","massDunningPrint","massDunningSent","massPrint","massSent","offsetCreditNotes","offsetInvoices","offsetReceipts","offsetSupplierCreditNotes","plannedMail","print","regeneratePdf","resync","restore","save","sendPaymentConfirmation","sendAbaNet","sendDeepSign","sign","signSupplierCreditNote","sync"]}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"d1c140ffccc2e11c19438254ad4a2e31","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/calculate":{"post":{"tags":["documents_document-contract-notes"],"summary":"Calculate amounts of an existing document","description":"Calculates the amounts of an existing document for previewing without manipulating any resources","operationId":"documents_create_calculate_7","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Document to calculate","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/invoice-calculate.schema.json","description":"A Schema for calculating invoices in AbaNinja over API","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}}},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"invoiceDate":{"type":["string","null"],"format":"date"}},"required":["positions","currencyCode"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Contract Note Calculation Resource","type":"object","allOf":[{"title":"Calculation Resource","properties":{"total":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"roundingDifference":{"type":"number","format":"float"},"taxes":{"type":"array","items":{"properties":{"rate":{"type":"number","format":"float"},"value":{"type":"number","format":"float"},"name":{"type":"string"},"baseSum":{"type":"number","format":"float"}},"type":"object"}}},"type":"object"},{"properties":{"total":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"roundingDifference":{"type":"number","format":"float"},"taxes":{"type":"array","items":{"properties":{"rate":{"type":"number","format":"float"},"value":{"type":"number","format":"float"},"name":{"type":"string"},"baseSum":{"type":"number","format":"float"}},"type":"object"}},"totalInvoicedAmount":{"description":"sum of all related invoices of this contract note","type":["number","null"],"format":"float"}},"type":"object"}]},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"d12c6622445bdbc4db99c8b20e80d327","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/comments":{"get":{"tags":["documents_document-credit-notes"],"summary":"Get comment collection","description":"fetches comments of a document via pagination","operationId":"documents_list_comments","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Document Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"6e93fdec3c8cee14ef9bc0f66ccb81e6","x-required-scopes":["customers"]},"post":{"tags":["documents_document-credit-notes"],"summary":"Create comment","description":"creates a new comment on a document either for internal or external use","operationId":"documents_create_comments","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Comment to create","required":true,"content":{"application/json":{"schema":{"title":"Create Document Comment Request","required":["comment","type"],"properties":{"comment":{"type":"string","minLength":3},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]}},"type":"object"}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"275b6cf024bbbdc0d849e052e3b81c50","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/files":{"get":{"tags":["documents_document-credit-notes"],"summary":"Get Files","description":"Returns a list of files","operationId":"documents_list_files","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}},{"name":"kind","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Document File Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"archivedReason":{"type":["string","null"],"enum":["SENT_NEW_DOCUMENT","CANCELATION","DUNNING","PAYMENT_OFFSET","PAYMENT_CONFIRMED","PAYMENT_CANCELED","MANUAL_RECREATION"]},"fileSize":{"type":"integer","format":"int64"},"mimeType":{"type":"string"},"kind":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"e1608e02afc72894957bce3e57d8e893","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/archive":{"patch":{"tags":["documents_document-contract-notes"],"summary":"Execute archive bulk action","description":"Marks the document as archived","operationId":"documents_bulk_archive_contract_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"d775dfce02b2896ae9654dbc0524e564","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/collectInvoice":{"patch":{"tags":["documents_document-contract-notes"],"summary":"Execute collectInvoice bulk action","description":"Creates a collective invoice out of the selected items","operationId":"documents_bulk_collect_invoice_contract_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"d5c7dd0a0e35121b16fc6e09f7d8bc9a","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/markSent":{"patch":{"tags":["documents_document-contract-notes"],"summary":"Execute markSent bulk action","description":"Triggers the mark sent action for each document","operationId":"documents_bulk_mark_sent_contract_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"ab43ab995f920c11f0424707f8369c52","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/massDownloadZip":{"patch":{"tags":["documents_document-contract-notes"],"summary":"Execute massDownloadZip bulk action","description":"Zips and downloads each document. The result is sent to the inbox","operationId":"documents_bulk_mass_download_zip_contract_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"string"}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"e7d767ed28b5b3312f3634f2438f2daa","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/massPrint":{"patch":{"tags":["documents_document-contract-notes"],"summary":"Execute massPrint bulk action","description":"Triggers the print action for each document","operationId":"documents_bulk_mass_print_contract_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{},"maxItems":0},{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"printUrl":{"type":"string","format":"uri"},"document":{"properties":{"url":{"type":"string","format":"uri"},"preview_url":{"type":"string","format":"uri"}},"type":"object"}},"type":"object"}]}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"dd1758c6bf7b3dbadac7ebebacb01026","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/massSent":{"patch":{"tags":["documents_document-contract-notes"],"summary":"Execute massSent bulk action","description":"Triggers the send action for each document","operationId":"documents_bulk_mass_sent_contract_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"9fded55d13c56148fbbcd777c0e017f2","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/plannedMail":{"patch":{"tags":["documents_document-contract-notes"],"summary":"Execute plannedMail bulk action","description":"Triggers the plan mail action for each document","operationId":"documents_bulk_planned_mail_contract_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"3b1d285309f492e7a14d4ce2c7b74f62","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/settings/default-conditions":{"get":{"tags":["documents_document-contract-note-settings"],"summary":"Get contract-note default-condition settings","description":"Get contract-note default-condition settings","operationId":"documents_list_default_conditions","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document default-conditions settings resource","properties":{"de":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"en":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"fr":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"it":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"1e9548ca4713c5c8deae937395249279","x-required-scopes":["settings"]},"patch":{"tags":["documents_document-contract-note-settings"],"summary":"Update contract-note default-condition settings","description":"Update contract-note default-condition settings","operationId":"documents_update_default_conditions","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"default-condition settings","required":true,"content":{"application/json":{"schema":{"title":"Update default-condition settings request","required":[],"properties":{"de":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"en":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"fr":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"it":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document default-conditions settings resource","properties":{"de":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"en":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"fr":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"it":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"1368952b076a6b5d200de8444941397d","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/{creditNoteUuid}/actions":{"get":{"tags":["documents_document-credit-notes"],"summary":"Get actions","description":"Get credit note actions","operationId":"documents_list_actions_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"creditNoteUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"forList","in":"query","description":"filter list actions","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","example":{"archive":"Archive","cancel":"Cancel","delete":"Delete"},"additionalProperties":{"description":"description of the action","type":"string"},"propertyNames":{"enum":["paymentAdd","archive","cancel","cancelPermanently","clone","collectInvoice","convertCNDN","convertCNI","convertDNI","convertIC","convertDN","convertT","convertCN","convert","convertTemplateToContractNote","convertTemplateToCreditNote","convertTemplateToDeliveryNote","convertTI","convertTemplateToQuote","convertToTemplate","createFinal","createInstalments","createPartial","createOnAccount","customerPortalUrl","delete","dissolve","downloadPdf","downloadPaymentConfirmation","dunningPrint","dunningSent","dunningDate","setDunningAmounts","edit","activity","info","email","markApproved","markDeclined","markSent","massDownloadZip","massDunningPrint","massDunningSent","massPrint","massSent","offsetCreditNotes","offsetInvoices","offsetReceipts","offsetSupplierCreditNotes","plannedMail","print","regeneratePdf","resync","restore","save","sendPaymentConfirmation","sendAbaNet","sendDeepSign","sign","signSupplierCreditNote","sync"]}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"b678f5939f42c4714d9fb421af5b4b45","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/{documentUuid}/calculate":{"post":{"tags":["documents_document-credit-notes"],"summary":"Calculate amounts of an existing document","description":"Calculates the amounts of an existing document for previewing without manipulating any resources","operationId":"documents_create_calculate_6","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Document to calculate","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/invoice-calculate.schema.json","description":"A Schema for calculating invoices in AbaNinja over API","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}}},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"invoiceDate":{"type":["string","null"],"format":"date"}},"required":["positions","currencyCode"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Calculation Resource","properties":{"total":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"roundingDifference":{"type":"number","format":"float"},"taxes":{"type":"array","items":{"properties":{"rate":{"type":"number","format":"float"},"value":{"type":"number","format":"float"},"name":{"type":"string"},"baseSum":{"type":"number","format":"float"}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"ae3996333fdee330090cf8df08a826f4","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/{documentUuid}/comments":{"get":{"tags":["documents_document-credit-notes"],"summary":"Get comment collection","description":"fetches comments of a document via pagination","operationId":"documents_list_comments_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Document Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"dafd6e5283ffed80b5878c6362de9731","x-required-scopes":["customers"]},"post":{"tags":["documents_document-credit-notes"],"summary":"Create comment","description":"creates a new comment on a document either for internal or external use","operationId":"documents_create_comments_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Comment to create","required":true,"content":{"application/json":{"schema":{"title":"Create Document Comment Request","required":["comment","type"],"properties":{"comment":{"type":"string","minLength":3},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]}},"type":"object"}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"fe1c4d6608bb86eb27c393b2800dc27c","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/{documentUuid}/files":{"get":{"tags":["documents_document-credit-notes"],"summary":"Get Files","description":"Returns a list of files","operationId":"documents_list_files_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}},{"name":"kind","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Document File Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"archivedReason":{"type":["string","null"],"enum":["SENT_NEW_DOCUMENT","CANCELATION","DUNNING","PAYMENT_OFFSET","PAYMENT_CONFIRMED","PAYMENT_CANCELED","MANUAL_RECREATION"]},"fileSize":{"type":"integer","format":"int64"},"mimeType":{"type":"string"},"kind":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"5db6349299eb0e6fa61e614c5a166611","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/bulk-actions/archive":{"patch":{"tags":["documents_document-credit-notes"],"summary":"Execute archive bulk action","description":"Marks the document as archived","operationId":"documents_bulk_archive_credit_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"fe2c354d7e629bf26c5ceebcd370a898","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/bulk-actions/markSent":{"patch":{"tags":["documents_document-credit-notes"],"summary":"Execute markSent bulk action","description":"Triggers the mark sent action for each document","operationId":"documents_bulk_mark_sent_credit_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"d2a22458422f33c7099a67602dadb693","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/bulk-actions/massDownloadZip":{"patch":{"tags":["documents_document-credit-notes"],"summary":"Execute massDownloadZip bulk action","description":"Zips and downloads each document. The result is sent to the inbox","operationId":"documents_bulk_mass_download_zip_credit_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"string"}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"d2d476a0258aac95312c674af13ef6cf","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/bulk-actions/massPrint":{"patch":{"tags":["documents_document-credit-notes"],"summary":"Execute massPrint bulk action","description":"Triggers the print action for each document","operationId":"documents_bulk_mass_print_credit_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{},"maxItems":0},{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"printUrl":{"type":"string","format":"uri"},"document":{"properties":{"url":{"type":"string","format":"uri"},"preview_url":{"type":"string","format":"uri"}},"type":"object"}},"type":"object"}]}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"faaa525f8c485094a9478f6191aa8142","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/bulk-actions/massSent":{"patch":{"tags":["documents_document-credit-notes"],"summary":"Execute massSent bulk action","description":"Triggers the send action for each document","operationId":"documents_bulk_mass_sent_credit_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"b2f6750ceb5c83bde88c68c72e2eaba5","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/bulk-actions/plannedMail":{"patch":{"tags":["documents_document-credit-notes"],"summary":"Execute plannedMail bulk action","description":"Triggers the plan mail action for each document","operationId":"documents_bulk_planned_mail_credit_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"fe64b1c5584a116cd14716caac38e514","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/{deliveryNoteUuid}/actions":{"get":{"tags":["documents_document-delivery-notes"],"summary":"Get actions","description":"Get delivery note actions","operationId":"documents_list_actions_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"deliveryNoteUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"forList","in":"query","description":"filter list actions","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","example":{"archive":"Archive","cancel":"Cancel","delete":"Delete"},"additionalProperties":{"description":"description of the action","type":"string"},"propertyNames":{"enum":["paymentAdd","archive","cancel","cancelPermanently","clone","collectInvoice","convertCNDN","convertCNI","convertDNI","convertIC","convertDN","convertT","convertCN","convert","convertTemplateToContractNote","convertTemplateToCreditNote","convertTemplateToDeliveryNote","convertTI","convertTemplateToQuote","convertToTemplate","createFinal","createInstalments","createPartial","createOnAccount","customerPortalUrl","delete","dissolve","downloadPdf","downloadPaymentConfirmation","dunningPrint","dunningSent","dunningDate","setDunningAmounts","edit","activity","info","email","markApproved","markDeclined","markSent","massDownloadZip","massDunningPrint","massDunningSent","massPrint","massSent","offsetCreditNotes","offsetInvoices","offsetReceipts","offsetSupplierCreditNotes","plannedMail","print","regeneratePdf","resync","restore","save","sendPaymentConfirmation","sendAbaNet","sendDeepSign","sign","signSupplierCreditNote","sync"]}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"70264a0226eb1bc5efebb51665ea8cd8","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/{documentUuid}/comments":{"get":{"tags":["documents_document-delivery-notes"],"summary":"Get comment collection","description":"fetches comments of a document via pagination","operationId":"documents_list_comments_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Document Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"d18eb8dd504c1571ec784e7998bcbe5f","x-required-scopes":["customers"]},"post":{"tags":["documents_document-delivery-notes"],"summary":"Create comment","description":"creates a new comment on a document either for internal or external use","operationId":"documents_create_comments_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Comment to create","required":true,"content":{"application/json":{"schema":{"title":"Create Document Comment Request","required":["comment","type"],"properties":{"comment":{"type":"string","minLength":3},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]}},"type":"object"}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"9209effa08b9e7e3a4240700742c8eb7","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/{documentUuid}/files":{"get":{"tags":["documents_document-delivery-notes"],"summary":"Get Files","description":"Returns a list of files","operationId":"documents_list_files_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}},{"name":"kind","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Document File Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"archivedReason":{"type":["string","null"],"enum":["SENT_NEW_DOCUMENT","CANCELATION","DUNNING","PAYMENT_OFFSET","PAYMENT_CONFIRMED","PAYMENT_CANCELED","MANUAL_RECREATION"]},"fileSize":{"type":"integer","format":"int64"},"mimeType":{"type":"string"},"kind":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"9f80d84e95dd95fff5a99921dd29f47c","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/bulk-actions/archive":{"patch":{"tags":["documents_document-delivery-notes"],"summary":"Execute archive bulk action","description":"Marks the document as archived","operationId":"documents_bulk_archive_delivery_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"eaa505933512cf1a6436a3fca207119e","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/bulk-actions/collectInvoice":{"patch":{"tags":["documents_document-delivery-notes"],"summary":"Execute collectInvoice bulk action","description":"Creates a collective invoice out of the selected items","operationId":"documents_bulk_collect_invoice_delivery_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"8d540243f673767389902dde7c3d481c","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/bulk-actions/markSent":{"patch":{"tags":["documents_document-delivery-notes"],"summary":"Execute markSent bulk action","description":"Triggers the mark sent action for each document","operationId":"documents_bulk_mark_sent_delivery_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"ee177c8191210e7c48aa0e23ba941224","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/bulk-actions/massDownloadZip":{"patch":{"tags":["documents_document-delivery-notes"],"summary":"Execute massDownloadZip bulk action","description":"Zips and downloads each document. The result is sent to the inbox","operationId":"documents_bulk_mass_download_zip_delivery_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"string"}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"5562375bacde3f171ad8b3561ce43369","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/bulk-actions/massPrint":{"patch":{"tags":["documents_document-delivery-notes"],"summary":"Execute massPrint bulk action","description":"Triggers the print action for each document","operationId":"documents_bulk_mass_print_delivery_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{},"maxItems":0},{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"printUrl":{"type":"string","format":"uri"},"document":{"properties":{"url":{"type":"string","format":"uri"},"preview_url":{"type":"string","format":"uri"}},"type":"object"}},"type":"object"}]}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"1a1f8d5730f0c56c1eb53810ad96f05b","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/bulk-actions/massSent":{"patch":{"tags":["documents_document-delivery-notes"],"summary":"Execute massSent bulk action","description":"Triggers the send action for each document","operationId":"documents_bulk_mass_sent_delivery_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"e1d8d6c7863dc40f097267d0b3118f71","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/bulk-actions/plannedMail":{"patch":{"tags":["documents_document-delivery-notes"],"summary":"Execute plannedMail bulk action","description":"Triggers the plan mail action for each document","operationId":"documents_bulk_planned_mail_delivery_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"144db6b1700d8516da9a2d68aa5eb2e1","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/settings/default-conditions":{"get":{"tags":["documents_document-delivery-note-settings"],"summary":"Get delivery-note default-condition settings","description":"Get delivery-note default-condition settings","operationId":"documents_list_default_conditions_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document default-conditions settings resource","properties":{"de":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"en":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"fr":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"it":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"b6d1479c6346c0fcdea00f944aae8187","x-required-scopes":["settings"]},"patch":{"tags":["documents_document-delivery-note-settings"],"summary":"Update delivery-note default-condition settings","description":"Update delivery-note default-condition settings","operationId":"documents_update_default_conditions_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"default-condition settings","required":true,"content":{"application/json":{"schema":{"title":"Update default-condition settings request","required":[],"properties":{"de":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"en":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"fr":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"it":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document default-conditions settings resource","properties":{"de":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"en":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"fr":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"it":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"9af9beaa1162f2cccd0a90cb19e6da39","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/documents/v2/documents/{documentUuid}/document-flow":{"get":{"tags":["documents_document-common"],"summary":"Get document flow","description":"Get the document flow of a document","operationId":"documents_list_document_flow","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful return of a document flow","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Document Flow Item Resource","properties":{"uuid":{"type":"string","format":"uuid"},"documentFlowUuid":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"from":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"subtype":{"type":["string","null"],"enum":["partial","final","on_account","instalment","dunning"]},"isDeleted":{"type":"boolean"},"isTemplate":{"type":"boolean"},"date":{"type":["string","null"],"format":"date"},"number":{"type":"string"},"amount":{"type":"number"},"currency":{"type":["string","null"],"format":"iso-4217"}},"type":"object"},"to":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"subtype":{"type":["string","null"],"enum":["partial","final","on_account","instalment","dunning"]},"isDeleted":{"type":"boolean"},"isTemplate":{"type":"boolean"},"date":{"type":["string","null"],"format":"date"},"number":{"type":"string"},"amount":{"type":"number"},"currency":{"type":["string","null"],"format":"iso-4217"}},"type":"object"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"204":{"description":"No document flow items"},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"21c085a1a741e30dfe2571ab5a41a0e9","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/calculate":{"post":{"tags":["documents_document-invoices"],"summary":"Calculate amounts of an existing document","description":"Calculates the amounts of an existing document for previewing without manipulating any resources","operationId":"documents_create_calculate_8","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Document to calculate","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/invoice-calculate.schema.json","description":"A Schema for calculating invoices in AbaNinja over API","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}}},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"invoiceDate":{"type":["string","null"],"format":"date"}},"required":["positions","currencyCode"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Calculation Resource","properties":{"total":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"roundingDifference":{"type":"number","format":"float"},"taxes":{"type":"array","items":{"properties":{"rate":{"type":"number","format":"float"},"value":{"type":"number","format":"float"},"name":{"type":"string"},"baseSum":{"type":"number","format":"float"}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"99e51274059b24273cc1a7a9d2d7b0f4","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/comments":{"get":{"tags":["documents_document-invoices"],"summary":"Get comment collection","description":"fetches comments of a document via pagination","operationId":"documents_list_comments_4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Document Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"fcfe8946e7cdae82f6870309cd5c1393","x-required-scopes":["customers"]},"post":{"tags":["documents_document-invoices"],"summary":"Create comment","description":"creates a new comment on a document either for internal or external use","operationId":"documents_create_comments_4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Comment to create","required":true,"content":{"application/json":{"schema":{"title":"Create Document Comment Request","required":["comment","type"],"properties":{"comment":{"type":"string","minLength":3},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]}},"type":"object"}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"8ea4767deb924e56186994aba0ad53a2","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/files":{"get":{"tags":["documents_document-invoices"],"summary":"Get Files","description":"Returns a list of files","operationId":"documents_list_files_4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}},{"name":"kind","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Document File Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"archivedReason":{"type":["string","null"],"enum":["SENT_NEW_DOCUMENT","CANCELATION","DUNNING","PAYMENT_OFFSET","PAYMENT_CONFIRMED","PAYMENT_CANCELED","MANUAL_RECREATION"]},"fileSize":{"type":"integer","format":"int64"},"mimeType":{"type":"string"},"kind":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"6fa6ff32d1f63e5d77e0047570be0030","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{invoiceUuid}/actions":{"get":{"tags":["documents_document-invoices"],"summary":"Get actions","description":"Get invoice actions","operationId":"documents_list_actions_4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"invoiceUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"forList","in":"query","description":"filter list actions","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","example":{"archive":"Archive","cancel":"Cancel","delete":"Delete"},"additionalProperties":{"description":"description of the action","type":"string"},"propertyNames":{"enum":["paymentAdd","archive","cancel","cancelPermanently","clone","collectInvoice","convertCNDN","convertCNI","convertDNI","convertIC","convertDN","convertT","convertCN","convert","convertTemplateToContractNote","convertTemplateToCreditNote","convertTemplateToDeliveryNote","convertTI","convertTemplateToQuote","convertToTemplate","createFinal","createInstalments","createPartial","createOnAccount","customerPortalUrl","delete","dissolve","downloadPdf","downloadPaymentConfirmation","dunningPrint","dunningSent","dunningDate","setDunningAmounts","edit","activity","info","email","markApproved","markDeclined","markSent","massDownloadZip","massDunningPrint","massDunningSent","massPrint","massSent","offsetCreditNotes","offsetInvoices","offsetReceipts","offsetSupplierCreditNotes","plannedMail","print","regeneratePdf","resync","restore","save","sendPaymentConfirmation","sendAbaNet","sendDeepSign","sign","signSupplierCreditNote","sync"]}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"66e7004c366931541983e1f9eedc3ac5","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{invoiceUuid}/dunning-preview":{"post":{"tags":["documents_document-invoices"],"summary":"Create dunning preview","description":"Create a PDF preview for a dunning","operationId":"documents_create_dunning_preview","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"invoiceUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create a PDF preview for a dunning","required":true,"content":{"application/json":{"schema":{"title":"CreateDunningPdfPreviewRequest","required":["dunningLevel"],"properties":{"dunningLevel":{"type":"integer","enum":[1,2,3]}},"type":"object"}}}},"responses":{"201":{"description":"Created a preview PDF","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Created Preview Resource","description":"Created PDF preview","properties":{"previewUrl":{"type":"string","format":"uri"},"downloadUrl":{"type":"string","format":"uri"},"expiresAt":{"type":["string","null"],"format":"date-time"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"da94c9c1a86eaff6ce08ec6a22a7a660","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{invoiceUuid}/dunnings":{"get":{"tags":["documents_document-invoices"],"summary":"Get Dunnings","description":"Lists all active dunnings of a document","operationId":"documents_list_dunnings","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"invoiceUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Invoice Collection Item Resource","description":"Resource used in collections","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"number","format":"int64","deprecated":true},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"type":{"type":"string","enum":["invoice"]},"subtype":{"type":["string","null"],"enum":["partial","final","on_account","instalment","dunning"]},"reference":{"type":"string"},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"invoiceDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"receiver":{"oneOf":[{"title":"Lite Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"customerNumber":{"type":["string","null"]},"name":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"}},"type":"object"},{"title":"Lite Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"customerNumber":{"type":["string","null"]},"name":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"}},"type":"object"}]},"documentTotal":{"type":"number","format":"float"},"nextDunningDate":{"type":["string","null"],"format":"date"},"customDunningDate":{"type":["string","null"],"format":"date"},"dunningLevel":{"type":"string","enum":["REMINDER","FIRST_DUNNING","FINAL_DUNNING","NO_DUNNING"]},"invoiceNumber":{"description":"Equals to importedInvoiceNumber if set, otherwise systemInvoiceNumber","type":"string","deprecated":true},"importedInvoiceNumber":{"description":"The recognized invoiceNumber of the imported document","type":["string","null"]},"systemInvoiceNumber":{"description":"The invoiceNumber generated by AbaNinja","type":"string"},"isArchived":{"type":"boolean"},"isCancelled":{"type":"boolean"},"isImported":{"type":"boolean"},"openAmount":{"type":"number","format":"float"},"updatedAt":{"type":"string","format":"date-time"},"isTemplate":{"type":"boolean"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"f03419e7c01e18b5fe495ac542484858","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/bulk-actions/archive":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute archive bulk action","description":"Marks the document as archived","operationId":"documents_bulk_archive_invoices","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"997a4ab335ebf2f8e6c949f0e89b8959","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/bulk-actions/collectInvoice":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute collectInvoice bulk action","description":"Creates a collective invoice out of the selected items","operationId":"documents_bulk_collect_invoice_invoices","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"bd898195fb417fb24f664667ec39308e","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/bulk-actions/markSent":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute markSent bulk action","description":"Triggers the mark sent action for each document","operationId":"documents_bulk_mark_sent_invoices","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"15a53f6fad0938faefaa4527c4013e61","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/bulk-actions/massDownloadZip":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute massDownloadZip bulk action","description":"Zips and downloads each document. The result is sent to the inbox","operationId":"documents_bulk_mass_download_zip_invoices","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"string"}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"b219f23419c1d956d6f6c4be3ec5be60","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/bulk-actions/massDunningPrint":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute massDunningPrint bulk action","description":"Triggers the print dunning action for each document","operationId":"documents_bulk_mass_dunning_print_invoices","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{},"maxItems":0},{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"document":{"properties":{"url":{"type":"string","format":"uri"},"preview_url":{"type":"string","format":"uri"}},"type":"object"}},"type":"object"}]}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"14cb5f4cdf980f903d1c2dcdece79bb6","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/bulk-actions/massDunningSent":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute massDunningSent bulk action","description":"Triggers the send dunning action for each document","operationId":"documents_bulk_mass_dunning_sent_invoices","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{},"maxItems":0},{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"document":{"properties":{"url":{"type":"string","format":"uri"},"preview_url":{"type":"string","format":"uri"}},"type":"object"}},"type":"object"}]}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"01436644d3e31ef4e525db0d165d58f9","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/bulk-actions/massPrint":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute massPrint bulk action","description":"Triggers the print action for each document","operationId":"documents_bulk_mass_print_invoices","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{},"maxItems":0},{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"printUrl":{"type":"string","format":"uri"},"document":{"properties":{"url":{"type":"string","format":"uri"},"preview_url":{"type":"string","format":"uri"}},"type":"object"}},"type":"object"}]}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"218e514b971420e8b48c1591caa7d1a2","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/bulk-actions/massSent":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute massSent bulk action","description":"Triggers the send action for each document","operationId":"documents_bulk_mass_sent_invoices","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"42a1ebc75935d36bee650f96a88ea3e1","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/bulk-actions/plannedMail":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute plannedMail bulk action","description":"Triggers the plan mail action for each document","operationId":"documents_bulk_planned_mail_invoices","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"1c652b7f187c9b8f069bb1f6e0175b34","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/import/{invoiceUuid}":{"patch":{"tags":["documents_document-invoices"],"summary":"Update imported invoice","description":"Update imported invoice from PDF","operationId":"documents_update_import","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"invoiceUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update imported invoice","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/import-invoice.update.schema.json","description":"A Schema for updating an imported invoice in AbaNinja over API","type":"object","properties":{"documents":{"type":"array","items":{"type":"object","properties":{"documentData":{"type":"object","description":"Additional Data for the invoice document","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}},"invoiceNumber":{"type":["null","string"]},"invoiceDate":{"type":"string","format":"date"},"dueDate":{"type":"string","format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"paymentInstructions":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/payment-instructions.schema.json","title":"Payment Instructions","description":"Payment Instruction Schema for AbaNinja Invoice Json","oneOf":[{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}],"$defs":{"ibanInstruction":{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},"qrIbanInstruction":{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},"bankAccountReference":{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}}},"documentTotal":{"type":"number","description":"Total Amount incl. VAT"},"taxPositions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/tax-position.schema.json","description":"A Schema for tax positions for imported invoices","type":"object","properties":{"id":{"type":["integer","null"],"exclusiveMinimum":0,"deprecated":true,"description":"identifier of the object. \"uuid\" should be used instead"},"uuid":{"type":["string","null"],"format":"uuid"},"accountNumber":{"type":"integer","minimum":1000,"maximum":999999999999,"deprecated":true,"description":"The booking account number. Use bookingAccountUuid instead."},"bookingAccountUuid":{"type":["string","null"],"format":"uuid"},"isTaxIncluded":{"type":"boolean","default":false,"description":"controls if amount already includes tax or not"},"amount":{"type":"number"},"taxRate":{"type":"number","minimum":0,"maximum":100,"deprecated":true,"description":"Tax Rate to apply. Use \"taxRateUuid\" instead"},"taxRateUuid":{"type":["null","string"],"format":"uuid"}},"required":["amount"]},"minItems":1},"reference":{"type":["string"],"maxLength":255},"publicNotes":{"type":["null","string"]},"hasCustomPaymentSlip":{"type":"boolean","default":false,"description":"if the invoice has a custom payment slip (true) or if it will be generated by AbaNinja (false)"}},"required":["currencyCode","receiver","invoiceDate","dueDate","paymentInstructions","documentTotal","taxPositions"]}},"required":["documentData"]},"maxItems":1,"minItems":1}},"required":["documents"],"$defs":{"singleDocument":{"type":"object","properties":{"documentData":{"type":"object","description":"Additional Data for the invoice document","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"receiver":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json","description":"Invoice Receiver for AbaNinja Invoice Json","type":"object","oneOf":[{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}],"$defs":{"personAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"}},"required":["addressUuid","personUuid"]},"companyAddress":{"type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"additionalReceivers":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false}}},"required":["addressUuid","companyUuid"]},"additionalCompanyReceiver":{"type":"object","properties":{"personUuid":{"type":"string","format":"uuid","description":"UUID of contact person inside given company"}},"required":["personUuid"],"additionalProperties":false},"customerNumberReceiver":{"type":"object","properties":{"customerNumber":{"type":"string"}},"required":["customerNumber"]}}},"invoiceNumber":{"type":["null","string"]},"invoiceDate":{"type":"string","format":"date"},"dueDate":{"type":"string","format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"paymentInstructions":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/payment-instructions.schema.json","title":"Payment Instructions","description":"Payment Instruction Schema for AbaNinja Invoice Json","oneOf":[{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}],"$defs":{"ibanInstruction":{"title":"IBAN","type":"object","properties":{"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"reference":{"type":["null","string"],"pattern":"^RF[0-9]{2}[A-Za-z0-9]{1,21}$","description":"SCOR Reference"}},"required":["iban"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}},"qrIbanInstruction":{"title":"QR-IBAN","type":"object","properties":{"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"reference":{"type":["null","string"],"pattern":"^[0-9]{2,27}$","description":"QRR Reference"}},"required":["qrIban"]},"bankAccountReference":{"title":"Bank Account UUID","type":"object","properties":{"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"},"reference":{"type":["null","string"],"pattern":"(^[0-9]{2,27}$)|(^RF[0-9]{2}[A-Za-z0-9]{1,21}$)","description":"QRR or SCOR Reference"}},"required":["bankAccountUuid"]}}},"documentTotal":{"type":"number","description":"Total Amount incl. VAT"},"taxPositions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/tax-position.schema.json","description":"A Schema for tax positions for imported invoices","type":"object","properties":{"id":{"type":["integer","null"],"exclusiveMinimum":0,"deprecated":true,"description":"identifier of the object. \"uuid\" should be used instead"},"uuid":{"type":["string","null"],"format":"uuid"},"accountNumber":{"type":"integer","minimum":1000,"maximum":999999999999,"deprecated":true,"description":"The booking account number. Use bookingAccountUuid instead."},"bookingAccountUuid":{"type":["string","null"],"format":"uuid"},"isTaxIncluded":{"type":"boolean","default":false,"description":"controls if amount already includes tax or not"},"amount":{"type":"number"},"taxRate":{"type":"number","minimum":0,"maximum":100,"deprecated":true,"description":"Tax Rate to apply. Use \"taxRateUuid\" instead"},"taxRateUuid":{"type":["null","string"],"format":"uuid"}},"required":["amount"]},"minItems":1},"reference":{"type":["string"],"maxLength":255},"publicNotes":{"type":["null","string"]},"hasCustomPaymentSlip":{"type":"boolean","default":false,"description":"if the invoice has a custom payment slip (true) or if it will be generated by AbaNinja (false)"}},"required":["currencyCode","receiver","invoiceDate","dueDate","paymentInstructions","documentTotal","taxPositions"]}},"required":["documentData"]}}}}}},"responses":{"200":{"description":"Imported invoice updated","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"documents":{"type":"array","items":{"title":"Imported Invoice Resource","properties":{"documentUrl":{"type":["string","null"],"format":"uri"},"documentData":{"properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"reference":{"type":"string"},"publicNotes":{"type":["string","null"]},"receiver":{"oneOf":[{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},{"type":"null"}]},"invoiceNumber":{"description":"Equals to importedInvoiceNumber if set, otherwise systemInvoiceNumber","type":"string","deprecated":true},"importedInvoiceNumber":{"description":"The recognized invoiceNumber of the imported document","type":["string","null"]},"systemInvoiceNumber":{"description":"The invoiceNumber generated by AbaNinja","type":"string"},"invoiceDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"nextDunningDate":{"type":["string","null"],"format":"date"},"customDunningDate":{"type":["string","null"],"format":"date"},"dunningLevel":{"type":"string","enum":["REMINDER","FIRST_DUNNING","FINAL_DUNNING","NO_DUNNING"]},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"paymentInstructions":{"allOf":[{"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Bank Account Iban Resource","description":"Payment instructions bank account using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction Bank Account QrIban Resource","description":"Payment instructions bank account using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"}},"type":"object"}]}],"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Iban Resource","description":"Payment instructions using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]},"reference":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction QrIban Resource","description":"Payment instructions using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"},"reference":{"type":["string","null"]}},"type":"object"}]},"documentTotal":{"type":"number","format":"float"},"taxPositions":{"type":"array","items":{"title":"Tax Position Resource","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"number","format":"int64","deprecated":true},"accountNumber":{"type":["number","null"],"format":"int64","deprecated":true},"bookingAccountUuid":{"type":["string","null"],"format":"uuid"},"isTaxIncluded":{"type":"boolean"},"amount":{"type":"number","format":"float"},"taxRate":{"type":"number","format":"float","deprecated":true},"vatUuid":{"type":["string","null"],"format":"uuid","deprecated":true},"taxRateUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"}},"type":"object"}},"isTemplate":{"type":"boolean"},"openAmount":{"type":"number","format":"float"},"type":{"type":"string","enum":["invoice"]},"subtype":{"type":["string","null"],"enum":["partial","final","on_account","instalment","dunning"]},"abanetSendAt":{"type":["string","null"],"format":"date-time"},"abanetConfirmedAt":{"type":["string","null"],"format":"date-time"},"wasRecognitionLimitReached":{"type":"boolean"},"hasCustomPaymentSlip":{"description":"if the invoice has a custom payment slip (true) or if it will be generated by AbaNinja (false)","type":"boolean"}},"type":"object"}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"8b093251e6f795a2c9eea3c4654a74a7","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/settings/conditions":{"get":{"tags":["documents_document-invoice-settings"],"summary":"Get invoice payment-condition setting","description":"Get invoice payment-condition setting","operationId":"documents_list_conditions","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Payment Condition Settings Resource","properties":{"paymentTerms":{"type":["number","null"],"format":"int32"},"paymentConditions":{"type":"array","items":{"required":["condition"],"properties":{"condition":{"type":"number","enum":[1,2,3]},"amount":{"type":["number","null"],"format":"float"},"days":{"type":["number","null"],"format":"int32"}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"674a7b0719936a0da13e27af9a3ffa92","x-required-scopes":["settings"]},"patch":{"tags":["documents_document-invoice-settings"],"summary":"Update invoice payment-condition setting","description":"Update invoice payment-condition setting","operationId":"documents_update_conditions","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"payment-conditions settings","required":true,"content":{"application/json":{"schema":{"title":"Update condition settings request","required":[],"properties":{"paymentTerms":{"type":["number","null"],"format":"int32"},"paymentConditions":{"type":"array","items":{"required":["condition"],"properties":{"condition":{"type":"number","enum":[1,2,3]},"amount":{"type":"number","format":"float"},"days":{"type":"number","format":"int32"}},"type":"object"}}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Payment Condition Settings Resource","properties":{"paymentTerms":{"type":["number","null"],"format":"int32"},"paymentConditions":{"type":"array","items":{"required":["condition"],"properties":{"condition":{"type":"number","enum":[1,2,3]},"amount":{"type":["number","null"],"format":"float"},"days":{"type":["number","null"],"format":"int32"}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"83b21ac75caf80912adc7a1c9463fd56","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/documents/v2/invoices/settings/default-conditions":{"get":{"tags":["documents_document-invoice-settings"],"summary":"Get invoice default-condition settings","description":"Get invoice default-condition settings","operationId":"documents_list_default_conditions_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document default-conditions settings resource","properties":{"de":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"en":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"fr":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"it":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"5e7f045877040458d5ad0de0201d3bca","x-required-scopes":["settings"]},"patch":{"tags":["documents_document-invoice-settings"],"summary":"Update invoice default-condition settings","description":"Update invoice default-condition settings","operationId":"documents_update_default_conditions_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"default-condition settings","required":true,"content":{"application/json":{"schema":{"title":"Update default-condition settings request","required":[],"properties":{"de":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"en":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"fr":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"it":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document default-conditions settings resource","properties":{"de":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"en":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"fr":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"it":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"3a860d16bad0ec900190074558839ae0","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/documents/v2/invoices/settings/dunnings":{"get":{"tags":["documents_document-invoice-settings"],"summary":"Get Dunning Settings","description":"Returns all dunning settings","operationId":"documents_list_dunnings_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"DunningSettingsResourceSchema","properties":{"enableDunning":{"type":"boolean"},"enableDunningAmount":{"type":"boolean"},"dunningType":{"type":"integer","enum":[1,2]},"dunningLevel1":{"title":"DunningLevelSettingsResource","properties":{"isEnabled":{"type":"boolean"},"numberOfDays":{"type":"integer"},"direction":{"type":"integer","enum":[1,2]},"field":{"type":"integer","enum":[1,2]},"dunningAmount":{"description":"Amount for the dunning level. If null the previous level's amount will be used if set.","type":["number","null"],"minimum":0},"isPrintActive":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"en":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"fr":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"it":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"dunningLevel2":{"title":"DunningLevelSettingsResource","properties":{"isEnabled":{"type":"boolean"},"numberOfDays":{"type":"integer"},"direction":{"type":"integer","enum":[1,2]},"field":{"type":"integer","enum":[1,2]},"dunningAmount":{"description":"Amount for the dunning level. If null the previous level's amount will be used if set.","type":["number","null"],"minimum":0},"isPrintActive":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"en":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"fr":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"it":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"dunningLevel3":{"title":"DunningLevelSettingsResource","properties":{"isEnabled":{"type":"boolean"},"numberOfDays":{"type":"integer"},"direction":{"type":"integer","enum":[1,2]},"field":{"type":"integer","enum":[1,2]},"dunningAmount":{"description":"Amount for the dunning level. If null the previous level's amount will be used if set.","type":["number","null"],"minimum":0},"isPrintActive":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"en":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"fr":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"it":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"1cc4d2bcac25f4737d9bc0f721e14a83","x-required-scopes":["settings"]},"patch":{"tags":["documents_document-invoice-settings"],"summary":"Update Dunning Settings","description":"Updates the accounts dunning settings","operationId":"documents_update_dunnings","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update the settings","required":true,"content":{"application/json":{"schema":{"title":"Update Dunning Settings Request","required":[],"properties":{"enableDunning":{"type":"boolean"},"enableDunningAmount":{"type":"boolean"},"dunningType":{"type":"integer","enum":[1,2]},"dunningLevel1":{"properties":{"isEnabled":{"type":"boolean"},"numberOfDays":{"type":"integer"},"direction":{"type":"integer","enum":[1,2]},"field":{"type":"integer","enum":[1,2]},"dunningAmount":{"description":"Amount for the dunning level. If null the previous level's amount will be used if set.","type":["number","null"],"minimum":0},"isPrintActive":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string","maxLength":100}},"type":"object"},"en":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string","maxLength":100}},"type":"object"},"fr":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string","maxLength":100}},"type":"object"},"it":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string","maxLength":100}},"type":"object"}},"type":"object"}},"type":"object"},"dunningLevel2":{"properties":{"isEnabled":{"type":"boolean"},"numberOfDays":{"type":"integer"},"direction":{"type":"integer","enum":[1,2]},"field":{"type":"integer","enum":[1,2]},"dunningAmount":{"description":"Amount for the dunning level. If null the previous level's amount will be used if set.","type":["number","null"],"minimum":0},"isPrintActive":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string","maxLength":100}},"type":"object"},"en":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string","maxLength":100}},"type":"object"},"fr":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string","maxLength":100}},"type":"object"},"it":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string","maxLength":100}},"type":"object"}},"type":"object"}},"type":"object"},"dunningLevel3":{"properties":{"isEnabled":{"type":"boolean"},"numberOfDays":{"type":"integer"},"direction":{"type":"integer","enum":[1,2]},"field":{"type":"integer","enum":[1,2]},"dunningAmount":{"description":"Amount for the dunning level. If null the previous level's amount will be used if set.","type":["number","null"],"minimum":0},"isPrintActive":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string","maxLength":100}},"type":"object"},"en":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string","maxLength":100}},"type":"object"},"fr":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string","maxLength":100}},"type":"object"},"it":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string","maxLength":100}},"type":"object"}},"type":"object"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"DunningSettingsResourceSchema","properties":{"enableDunning":{"type":"boolean"},"enableDunningAmount":{"type":"boolean"},"dunningType":{"type":"integer","enum":[1,2]},"dunningLevel1":{"title":"DunningLevelSettingsResource","properties":{"isEnabled":{"type":"boolean"},"numberOfDays":{"type":"integer"},"direction":{"type":"integer","enum":[1,2]},"field":{"type":"integer","enum":[1,2]},"dunningAmount":{"description":"Amount for the dunning level. If null the previous level's amount will be used if set.","type":["number","null"],"minimum":0},"isPrintActive":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"en":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"fr":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"it":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"dunningLevel2":{"title":"DunningLevelSettingsResource","properties":{"isEnabled":{"type":"boolean"},"numberOfDays":{"type":"integer"},"direction":{"type":"integer","enum":[1,2]},"field":{"type":"integer","enum":[1,2]},"dunningAmount":{"description":"Amount for the dunning level. If null the previous level's amount will be used if set.","type":["number","null"],"minimum":0},"isPrintActive":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"en":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"fr":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"it":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"dunningLevel3":{"title":"DunningLevelSettingsResource","properties":{"isEnabled":{"type":"boolean"},"numberOfDays":{"type":"integer"},"direction":{"type":"integer","enum":[1,2]},"field":{"type":"integer","enum":[1,2]},"dunningAmount":{"description":"Amount for the dunning level. If null the previous level's amount will be used if set.","type":["number","null"],"minimum":0},"isPrintActive":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"en":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"fr":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"it":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"bef43cc22918cc3dbaeb167898970b5d","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/documents/v2/invoices/settings/payment-slip":{"get":{"tags":["documents_document-invoice-settings"],"summary":"Get payment slip settings","description":"Get invoices payment slip settings","operationId":"documents_list_payment_slip","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Payment Slip Settings","properties":{"newPage":{"type":"boolean"},"showAmount":{"type":"boolean"},"addAdditionalProcedures":{"type":"boolean"},"additionalProcedures1":{"type":["string","null"]},"additionalProcedures2":{"type":["string","null"]},"enableAdvertisementImage":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"fc22ea92b07600a88a26a7579429465e","x-required-scopes":["settings"]},"patch":{"tags":["documents_document-invoice-settings"],"summary":"Update payment slip settings","description":"Update invoices payment slip settings","operationId":"documents_update_payment_slip","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"payment slip settings","required":true,"content":{"application/json":{"schema":{"title":"Update payment slip request","required":[],"properties":{"newPage":{"type":"boolean"},"showAmount":{"type":"boolean"},"addAdditionalProcedures":{"type":"boolean"},"additionalProcedures1":{"type":["string","null"]},"additionalProcedures2":{"type":["string","null"]},"enableAdvertisementImage":{"type":"boolean"}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Payment Slip Settings","properties":{"newPage":{"type":"boolean"},"showAmount":{"type":"boolean"},"addAdditionalProcedures":{"type":"boolean"},"additionalProcedures1":{"type":["string","null"]},"additionalProcedures2":{"type":["string","null"]},"enableAdvertisementImage":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"de427db7137c89b0d76d3ff7142d3dca","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/documents/v2/queue/{queueUuid}/abort":{"post":{"tags":["documents_document-common"],"summary":"Abort queue","description":"Abort the document-mass-import queue. No other items will be processed. Can only be done as long as the queue is not aborted, finished or failed.","operationId":"documents_create_abort","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"queueUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Mass Document Import Queue Resource","description":"Describes the status of an document mass import","properties":{"uuid":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"total":{"type":"integer"},"successful":{"type":"integer"},"failed":{"type":"integer"},"status":{"type":"string","enum":["pending","failed","finished","aborted"]},"details":{"type":["array","null"],"items":{"title":"Mass Document Json Import Detail Resource","properties":{"status":{"type":"string","enum":["pending","failed","finished","aborted"]},"message":{"type":["string","null"]},"invoice":{"oneOf":[{"title":"Imported Invoice Resource","properties":{"documentUrl":{"type":["string","null"],"format":"uri"},"documentData":{"properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"reference":{"type":"string"},"publicNotes":{"type":["string","null"]},"receiver":{"oneOf":[{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},{"type":"null"}]},"invoiceNumber":{"description":"Equals to importedInvoiceNumber if set, otherwise systemInvoiceNumber","type":"string","deprecated":true},"importedInvoiceNumber":{"description":"The recognized invoiceNumber of the imported document","type":["string","null"]},"systemInvoiceNumber":{"description":"The invoiceNumber generated by AbaNinja","type":"string"},"invoiceDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"nextDunningDate":{"type":["string","null"],"format":"date"},"customDunningDate":{"type":["string","null"],"format":"date"},"dunningLevel":{"type":"string","enum":["REMINDER","FIRST_DUNNING","FINAL_DUNNING","NO_DUNNING"]},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"paymentInstructions":{"allOf":[{"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Bank Account Iban Resource","description":"Payment instructions bank account using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction Bank Account QrIban Resource","description":"Payment instructions bank account using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"}},"type":"object"}]}],"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Iban Resource","description":"Payment instructions using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]},"reference":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction QrIban Resource","description":"Payment instructions using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"},"reference":{"type":["string","null"]}},"type":"object"}]},"documentTotal":{"type":"number","format":"float"},"taxPositions":{"type":"array","items":{"title":"Tax Position Resource","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"number","format":"int64","deprecated":true},"accountNumber":{"type":["number","null"],"format":"int64","deprecated":true},"bookingAccountUuid":{"type":["string","null"],"format":"uuid"},"isTaxIncluded":{"type":"boolean"},"amount":{"type":"number","format":"float"},"taxRate":{"type":"number","format":"float","deprecated":true},"vatUuid":{"type":["string","null"],"format":"uuid","deprecated":true},"taxRateUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"}},"type":"object"}},"isTemplate":{"type":"boolean"},"openAmount":{"type":"number","format":"float"},"type":{"type":"string","enum":["invoice"]},"subtype":{"type":["string","null"],"enum":["partial","final","on_account","instalment","dunning"]},"abanetSendAt":{"type":["string","null"],"format":"date-time"},"abanetConfirmedAt":{"type":["string","null"],"format":"date-time"},"wasRecognitionLimitReached":{"type":"boolean"},"hasCustomPaymentSlip":{"description":"if the invoice has a custom payment slip (true) or if it will be generated by AbaNinja (false)","type":"boolean"}},"type":"object"}},"type":"object"},{"title":"Invoice Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"invoiceDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"nextDunningDate":{"type":["string","null"],"format":"date"},"customDunningDate":{"type":["string","null"],"format":"date"},"dunningLevel":{"type":"string","enum":["REMINDER","FIRST_DUNNING","FINAL_DUNNING","NO_DUNNING"]},"paymentInstructions":{"allOf":[{"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Bank Account Iban Resource","description":"Payment instructions bank account using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction Bank Account QrIban Resource","description":"Payment instructions bank account using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"}},"type":"object"}]}],"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Iban Resource","description":"Payment instructions using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]},"reference":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction QrIban Resource","description":"Payment instructions using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"},"reference":{"type":["string","null"]}},"type":"object"}]},"pricesIncludeVat":{"type":"boolean"},"isVariantInvoice":{"type":"boolean"},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"isCollectiveBill":{"type":"boolean"},"invoiceNumber":{"description":"Equals to importedInvoiceNumber if set, otherwise systemInvoiceNumber","type":"string","deprecated":true},"importedInvoiceNumber":{"description":"The recognized invoiceNumber of the imported document","type":["string","null"]},"systemInvoiceNumber":{"description":"The invoiceNumber generated by AbaNinja","type":"string"},"openAmount":{"type":"number","format":"float"},"type":{"type":"string","enum":["invoice"]},"subtype":{"type":["string","null"],"enum":["partial","final","on_account","instalment","dunning"]},"abanetSendAt":{"type":["string","null"],"format":"date-time"},"abanetConfirmedAt":{"type":["string","null"],"format":"date-time"},"bookedAt":{"type":["string","null"],"format":"date-time"},"syncedAt":{"type":["string","null"],"format":"date-time"},"syncMessage":{"type":["string","null"]},"syncStatus":{"type":["string","null"],"enum":["OK","FAILED","INCORRECT_STATE","GENERAL_ERROR","CONNECTION_ERROR","BLOCKED_PREVIOUS_NOT_SYNCED"]},"cashDiscounts":{"type":"array","items":{"properties":{"days":{"type":"number","format":"int64"},"percentage":{"type":"number","format":"float"}},"type":"object"},"maxItems":3,"minItems":0},"documentDiscount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"},{"title":"Recurring Invoice Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"startDate":{"type":["string","null"],"format":"date"},"endDate":{"type":["string","null"],"format":"date"},"nextSendDate":{"type":["string","null"],"format":"date"},"frequency":{"type":["string","null"],"enum":["weekly","two_weeks","four_weeks","monthly","three_months","six_months","annually"]},"isRecurringActive":{"type":"boolean"},"isLastOfMonth":{"type":"boolean"},"paymentInstructions":{"allOf":[{"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Bank Account Iban Resource","description":"Payment instructions bank account using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction Bank Account QrIban Resource","description":"Payment instructions bank account using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"}},"type":"object"}]}],"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Iban Resource","description":"Payment instructions using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]},"reference":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction QrIban Resource","description":"Payment instructions using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"},"reference":{"type":["string","null"]}},"type":"object"}]},"pricesIncludeVat":{"type":"boolean"},"paymentTerms":{"type":["integer","null"],"deprecated":true},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"recurringInvoiceNumber":{"type":"string"},"type":{"type":"string","enum":["recurring_invoice"]},"cashDiscounts":{"type":"array","items":{"properties":{"days":{"type":"number","format":"int64"},"percentage":{"type":"number","format":"float"}},"type":"object"},"maxItems":3,"minItems":0},"documentDiscount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"},{"title":"Credit Note Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"creditNoteDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"pricesIncludeVat":{"type":"boolean"},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"creditNoteNumber":{"type":"string"},"openAmount":{"type":"number","format":"float"},"abanetSendAt":{"type":["string","null"],"format":"date-time"},"abanetConfirmedAt":{"type":["string","null"],"format":"date-time"},"type":{"type":"string","enum":["credit_note"]},"documentDiscount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"},{"title":"Quote Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"quoteDate":{"type":["string","null"],"format":"date"},"validUntilDate":{"type":["string","null"],"format":"date"},"pricesIncludeVat":{"type":"boolean"},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"quoteNumber":{"type":"string"},"type":{"type":"string","enum":["quote"]},"signaturePage":{"type":"boolean"},"deepSignSignatureMode":{"type":["string","null"],"enum":["timestamp","advanced","qualified"]},"signees":{"type":["array","null"],"items":{"title":"Signee Resource","properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["receiver","sender"]},"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"userUuid":{"type":["string","null"],"format":"uuid"},"signOrder":{"type":"number","format":"int64"},"companyName":{"type":["string","null"]},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"},"completedAt":{"type":["string","null"],"format":"date-time"},"signStatus":{"type":"string","enum":["pending","signed","rejected"]},"comment":{"type":["string","null"]}},"type":"object"}},"documentDiscount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"},{"title":"Delivery Note Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"deliveryNoteDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"deliveryNoteNumber":{"type":"string"},"type":{"type":"string","enum":["delivery_note"]},"documentDiscount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"},{"title":"Contract Note Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"title":{"type":["string","null"]},"reference":{"type":"string"},"sentStatus":{"type":"string","enum":["OPEN","SENDING","ERROR","SENT"]},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"customField1":{"type":["string","null"]},"customField2":{"type":["string","null"]},"customField3":{"type":["string","null"]},"customField4":{"type":["string","null"]},"terms":{"type":"string"},"publicNotes":{"type":["string","null"]},"footerText":{"type":["string","null"]},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"contractNoteDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"paymentInstructions":{"oneOf":[{"type":"array","items":{},"maxItems":0},{"title":"Payment Instruction Bank Account Iban Resource","description":"Payment instructions bank account using a common IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]}},"type":"object"},{"title":"Payment Instruction Bank Account QrIban Resource","description":"Payment instructions bank account using a QR IBAN","properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"qrIban":{"type":"string"}},"type":"object"}]},"pricesIncludeVat":{"type":"boolean"},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Divider Position Resource","description":"used to add a horizontal divider between the items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["divider"]}},"type":"object"},{"title":"Group Position Resource","description":"used to group product items","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["group"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"items":{"type":"array","items":{"oneOf":[{"title":"Delivery Note Product Position Resource","description":"A position belonging to a product or service for a delivery note","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"description":"Price, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"positionTotal":{"description":"Total amount, which will be used when converting the delivery note to another document like an invoice","type":"number","format":"float"},"discount":{"description":"Discount, which will be used when converting the delivery note to another document like an invoice","oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"description":"UUID of the VAT linked. Used only when converting the delivery note to another document like an invoice.","type":["string","null"],"format":"uuid"},"vat":{"description":"Used VAT. Used only when converting the delivery note to another document like an invoice.","properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"quantity":{"type":["number","null"],"format":"float"},"unitUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"}]}}},"type":"object"},{"title":"Page Break Position Resource","description":"used to start a new page","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["page_break"]}},"type":"object"},{"title":"Product Position Resource","description":"A position belonging to a product or service for a invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["product"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"quantity":{"type":["number","null"],"format":"float"},"unitCode":{"type":"string"},"unitUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"properties":{"percentage":{"type":"number","format":"float"},"amount":{"type":["number","null"],"format":"float"}},"type":"object"},"employeeActivityUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityEmployeeUuid":{"type":["string","null"],"format":"uuid"},"employeeActivityStartDate":{"type":["string","null"],"format":"date-time"},"relatedInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]},"originalInvoice":{"properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"number":{"type":"string"}},"type":["object","null"]}},"type":"object"},{"title":"Section Total Position Resource","description":"used to display the total for the section","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["section_total"]},"title":{"type":"string"}},"type":"object"},{"title":"Sub Title Position Resource","description":"used to display sub-titles in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["subtitle"]},"title":{"type":"string"}},"type":"object"},{"title":"Text Position Resource","description":"used to display text in the invoice","properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"text":{"type":"string"}},"type":"object"}]}},"isTemplate":{"type":"boolean"},"contractNoteNumber":{"type":"string"},"type":{"type":"string","enum":["invoice"]},"documentDiscount":{"oneOf":[{"properties":{"amount":{"type":"number","format":"float"}},"type":"object"},{"properties":{"percentage":{"type":"number","format":"float"}},"type":"object"}]}},"type":"object"},{"title":"Supplier Credit Note Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"currencyCodeRecognized":{"description":"when importing invoices and detecting the currency, this field contains the detected value","type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"receiver":{"oneOf":[{"title":"Receiver Company Resource","description":"Receiver resource for a company","properties":{"addressUuid":{"type":"string","format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"contactPersonUuid":{"type":["string","null"],"format":"uuid"},"additionalReceivers":{"type":"array","items":{"properties":{"personUuid":{"type":"string","format":"uuid"}},"type":"object"}},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"},{"title":"Receiver Person Resource","description":"Receiver resource for a person","properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"networkUuid":{"type":["string","null"],"format":"uuid"},"networkKey":{"type":["string","null"]},"networkName":{"type":["string","null"]},"deliveryAddressUuid":{"type":["string","null"],"format":"uuid"},"receiverInformation":{"title":"Receiver Information Resource","description":"Receiver information resource","properties":{"customerNumber":{"type":["string","null"],"readOnly":true},"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"format":"email","readOnly":true},"language":{"type":["string","null"],"readOnly":true,"enum":["de","en","fr","it"]},"deliveryAddress":{"properties":{"companyName":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"nameWithSalutation":{"type":["string","null"],"readOnly":true},"careOfAddress":{"type":["string","null"],"readOnly":true},"address":{"type":["string","null"],"readOnly":true},"extension":{"type":["string","null"],"readOnly":true},"houseNumber":{"type":["string","null"],"readOnly":true},"zipCode":{"type":["string","null"],"readOnly":true},"city":{"type":["string","null"],"readOnly":true},"countryCode":{"type":["string","null"],"readOnly":true}},"type":"object","readOnly":true},"additionalReceivers":{"type":"array","items":{"properties":{"fullName":{"type":["string","null"],"readOnly":true},"email":{"type":["string","null"],"readOnly":true}},"type":"object"},"readOnly":true}},"type":"object"}},"type":"object"}]},"supplierCreditNoteNumber":{"type":"string"},"supplierCreditNoteDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"documentTotal":{"type":"number","format":"float"},"taxPositions":{"type":"array","items":{"title":"Receipt Tax Position Resource","properties":{"id":{"type":"integer","format":"int64"},"accountNumber":{"type":"integer","format":"int64"},"isTaxIncluded":{"type":"boolean"},"amount":{"type":"number","format":"float"},"taxRate":{"type":"number","format":"float"},"taxRateUuid":{"type":["string","null"],"format":"uuid"}},"type":"object"}},"isTemplate":{"type":"boolean"},"openAmount":{"type":"number","format":"float"},"reference":{"type":"string"},"status":{"type":"string","enum":["draft","open","sending","send-failed","sent","viewed","approved","declined","partial","paid","in-payment","collected","planned","pending","archived","cancelled","converted","due","reminder","first-dunning","second-dunning","final-dunning","inactive","active","inbox","expired","done","assign","awaiting-payment","error"]},"type":{"type":"string","enum":["supplier_credit_note"]},"wasTaxIncluded":{"type":"boolean"},"wasRecognitionLimitReached":{"type":"boolean"}},"type":"object"},{"type":"null"}]}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad Request, for instance when queue is already done","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers","https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"40da8d8e8ec62c60a0121acaeed189b2","x-required-scopes":["customers","suppliers"]}},"/accounts/{accountUuid}/documents/v2/quotes/{documentUuid}/calculate":{"post":{"tags":["documents_document-quotes"],"summary":"Calculate amounts of an existing document","description":"Calculates the amounts of an existing document for previewing without manipulating any resources","operationId":"documents_create_calculate_10","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Document to calculate","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/invoice-calculate.schema.json","description":"A Schema for calculating invoices in AbaNinja over API","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}}},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"invoiceDate":{"type":["string","null"],"format":"date"}},"required":["positions","currencyCode"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Calculation Resource","properties":{"total":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"roundingDifference":{"type":"number","format":"float"},"taxes":{"type":"array","items":{"properties":{"rate":{"type":"number","format":"float"},"value":{"type":"number","format":"float"},"name":{"type":"string"},"baseSum":{"type":"number","format":"float"}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"20b55f67e404cd85a0374fcccc508e62","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/{documentUuid}/comments":{"get":{"tags":["documents_document-quotes"],"summary":"Get comment collection","description":"fetches comments of a document via pagination","operationId":"documents_list_comments_5","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Document Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"cfeee45601cf0c973e2e544db0cac940","x-required-scopes":["customers"]},"post":{"tags":["documents_document-quotes"],"summary":"Create comment","description":"creates a new comment on a document either for internal or external use","operationId":"documents_create_comments_5","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Comment to create","required":true,"content":{"application/json":{"schema":{"title":"Create Document Comment Request","required":["comment","type"],"properties":{"comment":{"type":"string","minLength":3},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]}},"type":"object"}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"5393f05c0e9e865c66aadd280b69f8e4","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/{documentUuid}/files":{"get":{"tags":["documents_document-quotes"],"summary":"Get Files","description":"Returns a list of files","operationId":"documents_list_files_6","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}},{"name":"kind","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Document File Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"archivedReason":{"type":["string","null"],"enum":["SENT_NEW_DOCUMENT","CANCELATION","DUNNING","PAYMENT_OFFSET","PAYMENT_CONFIRMED","PAYMENT_CANCELED","MANUAL_RECREATION"]},"fileSize":{"type":"integer","format":"int64"},"mimeType":{"type":"string"},"kind":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"fc5d3beeb7aad72dc70541e08a7d52fd","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/{quoteUuid}/actions":{"get":{"tags":["documents_document-quotes"],"summary":"Get actions","description":"Get quote actions","operationId":"documents_list_actions_5","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"quoteUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"forList","in":"query","description":"filter list actions","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","example":{"archive":"Archive","cancel":"Cancel","delete":"Delete"},"additionalProperties":{"description":"description of the action","type":"string"},"propertyNames":{"enum":["paymentAdd","archive","cancel","cancelPermanently","clone","collectInvoice","convertCNDN","convertCNI","convertDNI","convertIC","convertDN","convertT","convertCN","convert","convertTemplateToContractNote","convertTemplateToCreditNote","convertTemplateToDeliveryNote","convertTI","convertTemplateToQuote","convertToTemplate","createFinal","createInstalments","createPartial","createOnAccount","customerPortalUrl","delete","dissolve","downloadPdf","downloadPaymentConfirmation","dunningPrint","dunningSent","dunningDate","setDunningAmounts","edit","activity","info","email","markApproved","markDeclined","markSent","massDownloadZip","massDunningPrint","massDunningSent","massPrint","massSent","offsetCreditNotes","offsetInvoices","offsetReceipts","offsetSupplierCreditNotes","plannedMail","print","regeneratePdf","resync","restore","save","sendPaymentConfirmation","sendAbaNet","sendDeepSign","sign","signSupplierCreditNote","sync"]}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"4a2325ee67a277dd71e3ac2aa4dc5fa0","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/bulk-actions/archive":{"patch":{"tags":["documents_document-quotes"],"summary":"Execute archive bulk action","description":"Marks the document as archived","operationId":"documents_bulk_archive_quotes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"03a08dc65c5f005e8f10fe4f20ff6207","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/bulk-actions/collectInvoice":{"patch":{"tags":["documents_document-quotes"],"summary":"Execute collectInvoice bulk action","description":"Creates a collective invoice out of the selected items","operationId":"documents_bulk_collect_invoice_quotes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"b867147f00e36791587324bba4f3748c","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/bulk-actions/markSent":{"patch":{"tags":["documents_document-quotes"],"summary":"Execute markSent bulk action","description":"Triggers the mark sent action for each document","operationId":"documents_bulk_mark_sent_quotes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"d1346280988e3a025672c36d03e3e30f","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/bulk-actions/massDownloadZip":{"patch":{"tags":["documents_document-quotes"],"summary":"Execute massDownloadZip bulk action","description":"Zips and downloads each document. The result is sent to the inbox","operationId":"documents_bulk_mass_download_zip_quotes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"string"}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"f37992f149b84bc30ad2a6125832f61a","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/bulk-actions/massPrint":{"patch":{"tags":["documents_document-quotes"],"summary":"Execute massPrint bulk action","description":"Triggers the print action for each document","operationId":"documents_bulk_mass_print_quotes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{},"maxItems":0},{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"printUrl":{"type":"string","format":"uri"},"document":{"properties":{"url":{"type":"string","format":"uri"},"preview_url":{"type":"string","format":"uri"}},"type":"object"}},"type":"object"}]}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"9c01da3a853c0e61d0a79dd0fa078195","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/bulk-actions/massSent":{"patch":{"tags":["documents_document-quotes"],"summary":"Execute massSent bulk action","description":"Triggers the send action for each document","operationId":"documents_bulk_mass_sent_quotes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"f4bf0433a511d42c7adfcbe6b81862cb","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/bulk-actions/plannedMail":{"patch":{"tags":["documents_document-quotes"],"summary":"Execute plannedMail bulk action","description":"Triggers the plan mail action for each document","operationId":"documents_bulk_planned_mail_quotes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"5ac657e33dd9c94deb040e857a8ea086","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/settings/auto-conversion":{"get":{"tags":["documents_document-quote-settings"],"summary":"Get quote auto-conversion setting","description":"Get quote auto-conversion setting","operationId":"documents_list_auto_conversion","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Auto-conversion setting resource","properties":{"autoConversion":{"type":"string","enum":["NO_CONVERSION","INVOICE","CONTRACT_NOTE"]}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"23d017865d47f912af02c53749d64432","x-required-scopes":["settings"]},"patch":{"tags":["documents_document-quote-settings"],"summary":"Update quote auto-conversion setting","description":"Update quote auto-conversion setting","operationId":"documents_update_auto_conversion","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"auto-conversion settings","required":true,"content":{"application/json":{"schema":{"title":"Update auto-conversion request","required":["autoConversion"],"properties":{"autoConversion":{"type":"string","enum":["NO_CONVERSION","INVOICE","CONTRACT_NOTE"]}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Auto-conversion setting resource","properties":{"autoConversion":{"type":"string","enum":["NO_CONVERSION","INVOICE","CONTRACT_NOTE"]}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"a9b1254a071534efba8a04ef18b4f6df","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/documents/v2/quotes/settings/default-conditions":{"get":{"tags":["documents_document-quote-settings"],"summary":"Get quote default-condition settings","description":"Get quote default-condition settings","operationId":"documents_list_default_conditions_4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document default-conditions settings resource","properties":{"de":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"en":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"fr":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"it":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"53b5db087b8c37cb8c0f5b5140883eb9","x-required-scopes":["settings"]},"patch":{"tags":["documents_document-quote-settings"],"summary":"Update quote default-condition settings","description":"Update quote default-condition settings","operationId":"documents_update_default_conditions_4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"default-condition settings","required":true,"content":{"application/json":{"schema":{"title":"Update default-condition settings request","required":[],"properties":{"de":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"en":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"fr":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"it":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document default-conditions settings resource","properties":{"de":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"en":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"fr":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"},"it":{"properties":{"defaultConditions":{"type":["string","null"]}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"3233748c693c80f4f9eb3a62514ff7d1","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/documents/v2/quotes/settings/signature-page":{"get":{"tags":["documents_document-quote-settings"],"summary":"Get quote signature page settings","description":"Get quote signature page settings","operationId":"documents_list_signature_page","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Signature page setting resource","properties":{"isSignaturePageActive":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"423cddafd08bc46ba8787c33d3ed8ac7","x-required-scopes":["settings"]},"patch":{"tags":["documents_document-quote-settings"],"summary":"Update quote signature page settings","description":"Update quote signature page settings","operationId":"documents_update_signature_page","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"signature page settings","required":true,"content":{"application/json":{"schema":{"title":"Update Signature Page Request","required":["isSignaturePageActive"],"properties":{"isSignaturePageActive":{"type":"boolean"}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Signature page setting resource","properties":{"isSignaturePageActive":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"49b597a94ccde72c3a607db336b95a14","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/documents/v2/receipts/{documentUuid}/comments":{"get":{"tags":["documents_document-receipts"],"summary":"Get comment collection","description":"fetches comments of a document via pagination","operationId":"documents_list_comments_7","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Document Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"71ffcf413f348957f3f056af5b0a0c17","x-required-scopes":["suppliers"]},"post":{"tags":["documents_document-receipts"],"summary":"Create comment","description":"creates a new comment on a document either for internal or external use","operationId":"documents_create_comments_7","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Comment to create","required":true,"content":{"application/json":{"schema":{"title":"Create Document Comment Request","required":["comment","type"],"properties":{"comment":{"type":"string","minLength":3},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]}},"type":"object"}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"228804ef7851f039dfb0c2a51c80aa86","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/receipts/{documentUuid}/files":{"get":{"tags":["documents_document-receipts"],"summary":"Get Files","description":"Returns a list of files","operationId":"documents_list_files_7","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}},{"name":"kind","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Document File Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"archivedReason":{"type":["string","null"],"enum":["SENT_NEW_DOCUMENT","CANCELATION","DUNNING","PAYMENT_OFFSET","PAYMENT_CONFIRMED","PAYMENT_CANCELED","MANUAL_RECREATION"]},"fileSize":{"type":"integer","format":"int64"},"mimeType":{"type":"string"},"kind":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"54b308940ec87e9108c4d3025b4fea8c","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/receipts/{receiptUuid}/actions":{"get":{"tags":["documents_document-receipts"],"summary":"Get actions","description":"Get receipt actions","operationId":"documents_list_actions_6","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"receiptUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"forList","in":"query","description":"filter list actions","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","example":{"archive":"Archive","cancel":"Cancel","delete":"Delete"},"additionalProperties":{"description":"description of the action","type":"string"},"propertyNames":{"enum":["paymentAdd","archive","cancel","cancelPermanently","clone","collectInvoice","convertCNDN","convertCNI","convertDNI","convertIC","convertDN","convertT","convertCN","convert","convertTemplateToContractNote","convertTemplateToCreditNote","convertTemplateToDeliveryNote","convertTI","convertTemplateToQuote","convertToTemplate","createFinal","createInstalments","createPartial","createOnAccount","customerPortalUrl","delete","dissolve","downloadPdf","downloadPaymentConfirmation","dunningPrint","dunningSent","dunningDate","setDunningAmounts","edit","activity","info","email","markApproved","markDeclined","markSent","massDownloadZip","massDunningPrint","massDunningSent","massPrint","massSent","offsetCreditNotes","offsetInvoices","offsetReceipts","offsetSupplierCreditNotes","plannedMail","print","regeneratePdf","resync","restore","save","sendPaymentConfirmation","sendAbaNet","sendDeepSign","sign","signSupplierCreditNote","sync"]}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"4cb5d3790b087611a957b0e16220164b","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/receipts/bulk-actions/archive":{"patch":{"tags":["documents_document-receipts"],"summary":"Execute archive bulk action","description":"Marks the document as archived","operationId":"documents_bulk_archive_receipts","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"ddcf484a77361e7d4ef775d486d02675","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/recurring-invoices/{documentUuid}/calculate":{"post":{"tags":["documents_document-recurring-invoices"],"summary":"Calculate amounts of an existing document","description":"Calculates the amounts of an existing document for previewing without manipulating any resources","operationId":"documents_create_calculate_9","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Document to calculate","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/invoice-calculate.schema.json","description":"A Schema for calculating invoices in AbaNinja over API","type":"object","properties":{"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$"},"positions":{"type":"array","items":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-position.schema.json","description":"Schema for an invoice position item for the AbaNinja API","type":"object","properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"},"uuid":{"type":["string","null"],"format":"uuid","description":"UUID to use. Especially needed for updating positions without re-creating them"}},"oneOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]},{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]}],"$defs":{"productPosition":{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]},"subtitlePosition":{"type":"object","properties":{"kind":{"const":"subtitle"},"title":{"type":"string","maximum":255}},"required":["kind","title"]},"textPosition":{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","maximum":255}},"required":["kind","text"]},"sectionTotalPosition":{"type":"object","properties":{"kind":{"const":"section_total"},"title":{"type":"string","maximum":255}},"required":["kind"]},"dividerPosition":{"type":"object","properties":{"kind":{"const":"divider"}},"required":["kind"]},"pageBreakPosition":{"type":"object","properties":{"kind":{"const":"page_break"}},"required":["kind"]},"groupPosition":{"type":"object","properties":{"kind":{"const":"group"},"title":{"type":"string","maximum":255},"items":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"properties":{"productUuid":{"type":"string","format":"uuid","description":"The product to use. Will use productNumber and unit of the given product. Takes precedence \"unitUuid\" and \"unitCode\""},"productNumber":false,"productDescription":{"type":["null","string"]}},"required":["productUuid"]},{"properties":{"productUuid":false,"productNumber":{"type":["string","null"],"maxLength":255,"description":"The productNumber to set. If an existing products number is used, the actual product will be linked and its unit will be used. Takes precedence over \"unitUuid\" and \"unitCode\""},"productDescription":{"type":["string","null"],"description":"Required if there is no existing product with the given productNumber or the productNumber is not sent"}},"required":["singlePrice","productDescription"]}],"properties":{"kind":{"const":"product"},"unitUuid":{"type":["null","string"],"format":"uuid","description":"UUID of Unit. Defaults to the unit of the product or C62 - Pieces. Takes precedence over \"unitCode\""},"unitCode":{"type":["null","string"],"description":"ISO Code for Unit. Default: unit of the product if given or C62 - Pieces","default":"C62","deprecated":true},"quantity":{"type":["number","null"],"default":1},"singlePrice":{"type":["number","null"],"description":"Defaults to the products price if given. Otherwise 0.00."},"discount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"vatUuid":{"type":["null","string"],"format":"uuid","description":"UUID of VAT to use. Takes precedence over \"vat\""},"vat":{"type":["null","object"],"properties":{"percentage":{"type":"number","minimum":0,"maximum":100}},"required":["percentage"]}},"required":["kind"]}],"properties":{"positionNumber":{"type":"integer","minimum":1,"description":"Defines order of the position inside position table. 1=first position, 2=second position. Must be a unique value otherwise unexpected sorting can occur"}}},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}}}},"documentDiscount":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/discount-object.schema.json","description":"Discount Object Schema for AbaNinja Invoice Json","oneOf":[{"title":"Percentage discount","description":"The discount is a percentage of the total value","type":"object","properties":{"percentage":{"type":"number","minimum":0}},"required":["percentage"]},{"title":"Numeric discount","description":"A discount of a specific number","type":"object","properties":{"amount":{"type":"number","minimum":0}},"required":["amount"]},{"type":"null"}]},"invoiceDate":{"type":["string","null"],"format":"date"}},"required":["positions","currencyCode"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Calculation Resource","properties":{"total":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"roundingDifference":{"type":"number","format":"float"},"taxes":{"type":"array","items":{"properties":{"rate":{"type":"number","format":"float"},"value":{"type":"number","format":"float"},"name":{"type":"string"},"baseSum":{"type":"number","format":"float"}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"cf68adfa85b798bfac343c10366cdfa6","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/recurring-invoices/{documentUuid}/comments":{"get":{"tags":["documents_document-recurring-invoices"],"summary":"Get comment collection","description":"fetches comments of a document via pagination","operationId":"documents_list_comments_6","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Document Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"95791f2a7ad52d23f3ed2ab62c57b60e","x-required-scopes":["customers"]},"post":{"tags":["documents_document-recurring-invoices"],"summary":"Create comment","description":"creates a new comment on a document either for internal or external use","operationId":"documents_create_comments_6","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Comment to create","required":true,"content":{"application/json":{"schema":{"title":"Create Document Comment Request","required":["comment","type"],"properties":{"comment":{"type":"string","minLength":3},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]}},"type":"object"}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"599f3ba010f9f8bf972681da94b2f108","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/recurring-invoices/{documentUuid}/files":{"get":{"tags":["documents_document-recurring-invoices"],"summary":"Get Files","description":"Returns a list of files","operationId":"documents_list_files_5","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}},{"name":"kind","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Document File Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"archivedReason":{"type":["string","null"],"enum":["SENT_NEW_DOCUMENT","CANCELATION","DUNNING","PAYMENT_OFFSET","PAYMENT_CONFIRMED","PAYMENT_CANCELED","MANUAL_RECREATION"]},"fileSize":{"type":"integer","format":"int64"},"mimeType":{"type":"string"},"kind":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"8b88fc431da9a5f07872f3afb1b1bf50","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/recurring-invoices/{recurringInvoiceUuid}/actions":{"get":{"tags":["documents_document-recurring-invoices"],"summary":"Get actions","description":"Get recurring invoice actions","operationId":"documents_list_actions_7","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"recurringInvoiceUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"forList","in":"query","description":"filter list actions","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","example":{"archive":"Archive","cancel":"Cancel","delete":"Delete"},"additionalProperties":{"description":"description of the action","type":"string"},"propertyNames":{"enum":["paymentAdd","archive","cancel","cancelPermanently","clone","collectInvoice","convertCNDN","convertCNI","convertDNI","convertIC","convertDN","convertT","convertCN","convert","convertTemplateToContractNote","convertTemplateToCreditNote","convertTemplateToDeliveryNote","convertTI","convertTemplateToQuote","convertToTemplate","createFinal","createInstalments","createPartial","createOnAccount","customerPortalUrl","delete","dissolve","downloadPdf","downloadPaymentConfirmation","dunningPrint","dunningSent","dunningDate","setDunningAmounts","edit","activity","info","email","markApproved","markDeclined","markSent","massDownloadZip","massDunningPrint","massDunningSent","massPrint","massSent","offsetCreditNotes","offsetInvoices","offsetReceipts","offsetSupplierCreditNotes","plannedMail","print","regeneratePdf","resync","restore","save","sendPaymentConfirmation","sendAbaNet","sendDeepSign","sign","signSupplierCreditNote","sync"]}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"fdd840f3cb592a50844bf53e4b749117","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/recurring-invoices/bulk-actions/archive":{"patch":{"tags":["documents_document-recurring-invoices"],"summary":"Execute archive bulk action","description":"Marks the document as archived","operationId":"documents_bulk_archive_recurring_invoices","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"e804352cea922c679e758b6ebd5c3eb4","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/supplier-credit-notes/{documentUuid}/comments":{"get":{"tags":["documents_document-supplier-credit-notes"],"summary":"Get comment collection","description":"fetches comments of a document via pagination","operationId":"documents_list_comments_8","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Document Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"a3329fc80844a21df6bdf9c1b7edb0ad","x-required-scopes":["suppliers"]},"post":{"tags":["documents_document-supplier-credit-notes"],"summary":"Create comment","description":"creates a new comment on a document either for internal or external use","operationId":"documents_create_comments_8","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Comment to create","required":true,"content":{"application/json":{"schema":{"title":"Create Document Comment Request","required":["comment","type"],"properties":{"comment":{"type":"string","minLength":3},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]}},"type":"object"}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"ad1731875ea3f42f165d14bdd9ee5f45","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/supplier-credit-notes/{documentUuid}/files":{"get":{"tags":["documents_document-supplier-credit-notes"],"summary":"Get Files","description":"Returns a list of files","operationId":"documents_list_files_8","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}},{"name":"kind","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Document File Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"archivedReason":{"type":["string","null"],"enum":["SENT_NEW_DOCUMENT","CANCELATION","DUNNING","PAYMENT_OFFSET","PAYMENT_CONFIRMED","PAYMENT_CANCELED","MANUAL_RECREATION"]},"fileSize":{"type":"integer","format":"int64"},"mimeType":{"type":"string"},"kind":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"17f6c2db6b91aee06242f738668afbb3","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/supplier-credit-notes/{supplierCreditNoteUuid}/actions":{"get":{"tags":["documents_document-supplier-credit-notes"],"summary":"Get actions","description":"Get supplier credit note actions","operationId":"documents_list_actions_8","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"supplierCreditNoteUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"forList","in":"query","description":"filter list actions","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","example":{"archive":"Archive","cancel":"Cancel","delete":"Delete"},"additionalProperties":{"description":"description of the action","type":"string"},"propertyNames":{"enum":["paymentAdd","archive","cancel","cancelPermanently","clone","collectInvoice","convertCNDN","convertCNI","convertDNI","convertIC","convertDN","convertT","convertCN","convert","convertTemplateToContractNote","convertTemplateToCreditNote","convertTemplateToDeliveryNote","convertTI","convertTemplateToQuote","convertToTemplate","createFinal","createInstalments","createPartial","createOnAccount","customerPortalUrl","delete","dissolve","downloadPdf","downloadPaymentConfirmation","dunningPrint","dunningSent","dunningDate","setDunningAmounts","edit","activity","info","email","markApproved","markDeclined","markSent","massDownloadZip","massDunningPrint","massDunningSent","massPrint","massSent","offsetCreditNotes","offsetInvoices","offsetReceipts","offsetSupplierCreditNotes","plannedMail","print","regeneratePdf","resync","restore","save","sendPaymentConfirmation","sendAbaNet","sendDeepSign","sign","signSupplierCreditNote","sync"]}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"df66c280b0cf204eb815db25a74609f4","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/supplier-credit-notes/bulk-actions/archive":{"patch":{"tags":["documents_document-supplier-credit-notes"],"summary":"Execute archive bulk action","description":"Marks the document as archived","operationId":"documents_bulk_archive_supplier_credit_notes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"documentUuids":{"type":"array","items":{"type":"string","format":"uuid"}}},"type":"object"}}}},"responses":{"200":{"description":"Successfully bulk executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"a7d77acb376d713d2fe4fdc5a608e95b","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/archive":{"patch":{"tags":["documents_document-contract-notes"],"summary":"Execute archive action","description":"Archives the document","operationId":"documents_update_archive","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"0eb9ca76c4484ed1808e4a72a654a189","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/cancel":{"patch":{"tags":["documents_document-contract-notes"],"summary":"Execute cancel action","description":"Cancels and moves the document back to draft","operationId":"documents_update_cancel","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"84c4a5560b34964ef4f283ab5e6cfdcc","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/cancelPermanently":{"patch":{"tags":["documents_document-contract-notes"],"summary":"Execute cancelPermanently action","description":"Cancels the document permanently. It cannot be edited afterwards","operationId":"documents_update_cancelPermanently","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"c2610d329641dc51888400bf05e806d6","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/clone":{"patch":{"tags":["documents_document-contract-notes"],"summary":"Execute clone action","description":"Creates a copy of the document","operationId":"documents_update_clone","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"2cddc3df9c7e77631d5c748417ec096d","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/convertCNDN":{"patch":{"tags":["documents_document-contract-notes"],"summary":"Execute convertCNDN action","description":"Creates a delivery note out of a contract note","operationId":"documents_update_convertCNDN","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"8b573cdfa7e966a5344f02b1b347832f","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/convertCNI":{"patch":{"tags":["documents_document-contract-notes"],"summary":"Execute convertCNI action","description":"Creates an invoice out of a contract note","operationId":"documents_update_convertCNI","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"bcbb9442eee895202c09f0b8724f7ead","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/convertTemplateToContractNote":{"patch":{"tags":["documents_document-contract-notes"],"summary":"Execute convertTemplateToContractNote action","description":"Creates a contract note out of a template","operationId":"documents_update_convertTemplateToContractNote","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"1793c378362888fae08cbf480ee1efe7","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/convertToTemplate":{"patch":{"tags":["documents_document-contract-notes"],"summary":"Execute convertToTemplate action","description":"Creates a template out of a document","operationId":"documents_update_convertToTemplate","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"1ad83574394c4b9c516a395bee0da885","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/createFinal":{"patch":{"tags":["documents_document-contract-notes"],"summary":"Execute createFinal action","description":"Creates a final invoice for a contract note","operationId":"documents_update_createFinal","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Create Final Invoice Action Request","required":["relatedInvoiceDate","relatedDueDate"],"properties":{"relatedInvoiceDate":{"type":"string","format":"date"},"relatedDueDate":{"type":"string","format":"date"}},"type":"object"}}}},"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"printUrl":{"type":"string","format":"uri"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"31b6060aceacc5e52f8d6418812c40b0","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/createPartial":{"patch":{"tags":["documents_document-contract-notes"],"summary":"Execute createPartial action","description":"Create a partial invoice for a contract note","operationId":"documents_update_createPartial","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Create Partial Invoice Action Request","required":["relatedInvoiceDate","relatedDueDate"],"properties":{"invoiceItemUuids":{"type":"array","items":{"type":"string","format":"uuid"}},"relatedInvoiceDate":{"type":"string","format":"date"},"relatedDueDate":{"type":"string","format":"date"}},"type":"object"}}}},"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"printUrl":{"type":"string","format":"uri"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"d49b0a8be28cca18297f7cd187ba0e7e","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/delete":{"patch":{"tags":["documents_document-contract-notes"],"summary":"Execute delete action","description":"Deletes a document","operationId":"documents_update_delete","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"282d2e59f3d157f18bec421ffab2e758","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/downloadPdf":{"patch":{"tags":["documents_document-contract-notes"],"summary":"Execute downloadPdf action","description":"Gets the download uri for the document's pdf","operationId":"documents_update_downloadPdf","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"downloadUrl":{"type":"string","format":"uri"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"87e57abc12c12e1de1aff47e48c84679","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/email":{"patch":{"tags":["documents_document-contract-notes"],"summary":"Execute email action","description":"Sends the document via email","operationId":"documents_update_email","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"9bf378f2f88f2189b8b9be80ad24a9a6","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/markSent":{"patch":{"tags":["documents_document-contract-notes"],"summary":"Execute markSent action","description":"Marks the invoice as sent","operationId":"documents_update_markSent","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"ab4a32cc0aa5af7f6e3c4847bd34aa5b","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/plannedMail":{"patch":{"tags":["documents_document-contract-notes"],"summary":"Execute plannedMail action","description":"Schedules the email for sending the document","operationId":"documents_update_plannedMail","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"eaf94f3236dcb490db90f7b152c070bb","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/print":{"patch":{"tags":["documents_document-contract-notes"],"summary":"Execute print action","description":"Creates the PDF for printing","operationId":"documents_update_print","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"printUrl":{"type":"string","format":"uri"},"document":{"properties":{"url":{"type":"string","format":"uri"},"preview_url":{"type":"string","format":"uri"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"c2d71ec24d0a7d2c5939b2780e441d89","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/restore":{"patch":{"tags":["documents_document-contract-notes"],"summary":"Execute restore action","description":"Restores an archived document","operationId":"documents_update_restore","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"48853704acf74e6d79d5661691fb7736","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/comments/{commentUuid}":{"get":{"tags":["documents_document-credit-notes"],"summary":"Get comment","description":"fetches a single comment of a document","operationId":"documents_get_comments","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"commentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"db057e816e35fe030daeb2fb402f40b1","x-required-scopes":["customers"]},"delete":{"tags":["documents_document-credit-notes"],"summary":"Delete comment","description":"deletes a comment of a document, which cannot be restored anymore afterwards.","operationId":"documents_delete_comments","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"commentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"ce39fa51ac98063284e9a308eee0442d","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/files/{fileUuid}":{"get":{"tags":["documents_document-credit-notes"],"summary":"Get File","description":"Returns a file","operationId":"documents_get_files","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"fileUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document File Detail Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"archivedReason":{"type":["string","null"],"enum":["SENT_NEW_DOCUMENT","CANCELATION","DUNNING","PAYMENT_OFFSET","PAYMENT_CONFIRMED","PAYMENT_CANCELED","MANUAL_RECREATION"]},"fileSize":{"type":"integer","format":"int64"},"mimeType":{"type":"string"},"kind":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]},"fileUrl":{"type":["string","null"],"format":"uri"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"d2da2ff7af91df5ac2c3aed92ec47812","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/settings/number-ranges/contract-notes":{"get":{"tags":["documents_document-contract-note-settings"],"summary":"Get contract-note number range settings","description":"Get contract-note number range settings","operationId":"documents_list_contract_notes_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Number range settings resource","properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"5ef222a9ae8562a7609350bacf6f16bf","x-required-scopes":["settings"]},"patch":{"tags":["documents_document-contract-note-settings"],"summary":"Update contract-note number range settings","description":"Update contract-note number range settings","operationId":"documents_update_contract_notes_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"number range settings","required":true,"content":{"application/json":{"schema":{"title":"Update number range request","required":[],"properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Number range settings resource","properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"6ad4e3301064d03212571b9de0225ce0","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/settings/number-ranges/templates":{"get":{"tags":["documents_document-contract-note-settings"],"summary":"Get contract-note template number range settings","description":"Get contract-note template number range settings","operationId":"documents_list_templates","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Number range settings resource","properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"4bc1a25c0d58796d821cbaadff284b89","x-required-scopes":["settings"]},"patch":{"tags":["documents_document-contract-note-settings"],"summary":"Update contract-note template number range settings","description":"Update contract-note template number range settings","operationId":"documents_update_templates","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"number range settings","required":true,"content":{"application/json":{"schema":{"title":"Update number range request","required":[],"properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Number range settings resource","properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"c5820e339514f1d956d8efc15e341743","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/{documentUuid}/actions/archive":{"patch":{"tags":["documents_document-credit-notes"],"summary":"Execute archive action","description":"Archives the document","operationId":"documents_update_archive_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"9c29d3ec687c12e5594a8f5132714ef4","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/{documentUuid}/actions/cancel":{"patch":{"tags":["documents_document-credit-notes"],"summary":"Execute cancel action","description":"Cancels and moves the document back to draft","operationId":"documents_update_cancel_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"745d2554fcd01041f0569ba0e9b999e6","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/{documentUuid}/actions/cancelPermanently":{"patch":{"tags":["documents_document-credit-notes"],"summary":"Execute cancelPermanently action","description":"Cancels the document permanently. It cannot be edited afterwards","operationId":"documents_update_cancelPermanently_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"356a0c2bc49f35aeeaae7b31f6f6c039","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/{documentUuid}/actions/clone":{"patch":{"tags":["documents_document-credit-notes"],"summary":"Execute clone action","description":"Creates a copy of the document","operationId":"documents_update_clone_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"ed358e5d1ed717b97a2f8f2c0f6338ab","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/{documentUuid}/actions/convertTemplateToCreditNote":{"patch":{"tags":["documents_document-credit-notes"],"summary":"Execute convertTemplateToCreditNote action","description":"Creates a credit note out of a template","operationId":"documents_update_convertTemplateToCreditNote","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"e0f3dd0dae90fe91e4cd9c1bc491b1b5","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/{documentUuid}/actions/convertToTemplate":{"patch":{"tags":["documents_document-credit-notes"],"summary":"Execute convertToTemplate action","description":"Creates a template out of a document","operationId":"documents_update_convertToTemplate_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"fffe1558d66524f62ac62366e545448d","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/{documentUuid}/actions/delete":{"patch":{"tags":["documents_document-credit-notes"],"summary":"Execute delete action","description":"Deletes a document","operationId":"documents_update_delete_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"dbe2043a22182066b14cd2cd734766e5","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/{documentUuid}/actions/downloadPdf":{"patch":{"tags":["documents_document-credit-notes"],"summary":"Execute downloadPdf action","description":"Gets the download uri for the document's pdf","operationId":"documents_update_downloadPdf_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"downloadUrl":{"type":"string","format":"uri"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"2003fad7d935be263eacfc80459ba596","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/{documentUuid}/actions/email":{"patch":{"tags":["documents_document-credit-notes"],"summary":"Execute email action","description":"Sends the document via email","operationId":"documents_update_email_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"f577eabc3e631061064b610d1f8b1f62","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/{documentUuid}/actions/markSent":{"patch":{"tags":["documents_document-credit-notes"],"summary":"Execute markSent action","description":"Marks the invoice as sent","operationId":"documents_update_markSent_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"5bd1014b8da59d5f8d5c1b93766f80b9","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/{documentUuid}/actions/plannedMail":{"patch":{"tags":["documents_document-credit-notes"],"summary":"Execute plannedMail action","description":"Schedules the email for sending the document","operationId":"documents_update_plannedMail_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"3d0f557e559803c829b786ee937fbb4a","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/{documentUuid}/actions/print":{"patch":{"tags":["documents_document-credit-notes"],"summary":"Execute print action","description":"Creates the PDF for printing","operationId":"documents_update_print_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"printUrl":{"type":"string","format":"uri"},"document":{"properties":{"url":{"type":"string","format":"uri"},"preview_url":{"type":"string","format":"uri"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"f275cb53ca4503b1a5f77297ed9151b9","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/{documentUuid}/actions/regeneratePdf":{"patch":{"tags":["documents_document-credit-notes"],"summary":"Execute regeneratePdf action","description":"Regenerates the documents PDF","operationId":"documents_update_regeneratePdf","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Regenerate PDF Action Resource","type":"object","allOf":[{"title":"Document File Detail Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"archivedReason":{"type":["string","null"],"enum":["SENT_NEW_DOCUMENT","CANCELATION","DUNNING","PAYMENT_OFFSET","PAYMENT_CONFIRMED","PAYMENT_CANCELED","MANUAL_RECREATION"]},"fileSize":{"type":"integer","format":"int64"},"mimeType":{"type":"string"},"kind":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]},"fileUrl":{"type":["string","null"],"format":"uri"}},"type":"object"},{"properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"archivedReason":{"type":["string","null"],"enum":["SENT_NEW_DOCUMENT","CANCELATION","DUNNING","PAYMENT_OFFSET","PAYMENT_CONFIRMED","PAYMENT_CANCELED","MANUAL_RECREATION"]},"fileSize":{"type":"integer","format":"int64"},"mimeType":{"type":"string"},"kind":{"type":"string","enum":["invoice"]},"fileUrl":{"type":["string","null"],"format":"uri"}},"type":"object"}]},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"ae2d89127f6c8aaabaf47cc747a9192d","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/{documentUuid}/actions/restore":{"patch":{"tags":["documents_document-credit-notes"],"summary":"Execute restore action","description":"Restores an archived document","operationId":"documents_update_restore_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"c1b6bfecd85342060993400213df873e","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/{documentUuid}/actions/resync":{"patch":{"tags":["documents_document-credit-notes"],"summary":"Execute resync action","description":"Resyncs the document to Abacus","operationId":"documents_update_resync","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"e38ca9b6a93c32946877508b710b9acb","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/{documentUuid}/actions/sync":{"patch":{"tags":["documents_document-credit-notes"],"summary":"Execute sync action","description":"Syncs the document to Abacus","operationId":"documents_update_sync","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"095683c92aad4c8be306ec144853f6c0","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/{documentUuid}/comments/{commentUuid}":{"get":{"tags":["documents_document-credit-notes"],"summary":"Get comment","description":"fetches a single comment of a document","operationId":"documents_get_comments_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"commentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"78655290141161f26936bf449c5737ff","x-required-scopes":["customers"]},"delete":{"tags":["documents_document-credit-notes"],"summary":"Delete comment","description":"deletes a comment of a document, which cannot be restored anymore afterwards.","operationId":"documents_delete_comments_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"commentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"d4071e58e1532e1cce86b47f56100c98","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/{documentUuid}/files/{fileUuid}":{"get":{"tags":["documents_document-credit-notes"],"summary":"Get File","description":"Returns a file","operationId":"documents_get_files_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"fileUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document File Detail Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"archivedReason":{"type":["string","null"],"enum":["SENT_NEW_DOCUMENT","CANCELATION","DUNNING","PAYMENT_OFFSET","PAYMENT_CONFIRMED","PAYMENT_CANCELED","MANUAL_RECREATION"]},"fileSize":{"type":"integer","format":"int64"},"mimeType":{"type":"string"},"kind":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]},"fileUrl":{"type":["string","null"],"format":"uri"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"395b1365065a89ec03368ef2d2d96b32","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/settings/number-ranges/credit-notes":{"get":{"tags":["documents_document-credit-note-settings"],"summary":"Get credit-note number range settings","description":"Get credit-note number range settings","operationId":"documents_list_credit_notes_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Number range settings resource","properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"70da8bad0e6870c73a9a09650b36484d","x-required-scopes":["settings"]},"patch":{"tags":["documents_document-credit-note-settings"],"summary":"Update credit-note number range settings","description":"Update credit-note number range settings","operationId":"documents_update_credit_notes_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"number range settings","required":true,"content":{"application/json":{"schema":{"title":"Update number range request","required":[],"properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Number range settings resource","properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"4e0909e094c30540d071b237b2b4c3ff","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/documents/v2/credit-notes/settings/number-ranges/templates":{"get":{"tags":["documents_document-credit-note-settings"],"summary":"Get credit-note template number range settings","description":"Get credit-note template number range settings","operationId":"documents_list_templates_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Number range settings resource","properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"46e5eb40ea25a5763cc4ef4818fb15ed","x-required-scopes":["settings"]},"patch":{"tags":["documents_document-credit-note-settings"],"summary":"Update credit-note template number range settings","description":"Update credit-note template number range settings","operationId":"documents_update_templates_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"number range settings","required":true,"content":{"application/json":{"schema":{"title":"Update number range request","required":[],"properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Number range settings resource","properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"7951d17c35d1d9182a219f59fd133f21","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/{documentUuid}/actions/archive":{"patch":{"tags":["documents_document-delivery-notes"],"summary":"Execute archive action","description":"Archives the document","operationId":"documents_update_archive_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"9604886119348d47c793d6029645fb01","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/{documentUuid}/actions/cancel":{"patch":{"tags":["documents_document-delivery-notes"],"summary":"Execute cancel action","description":"Cancels and moves the document back to draft","operationId":"documents_update_cancel_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"9eec65fb9fe532a4a7ffa65f0ac4b8a8","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/{documentUuid}/actions/cancelPermanently":{"patch":{"tags":["documents_document-delivery-notes"],"summary":"Execute cancelPermanently action","description":"Cancels the document permanently. It cannot be edited afterwards","operationId":"documents_update_cancelPermanently_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"3df47a0b38185ee313f68832abf1741b","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/{documentUuid}/actions/clone":{"patch":{"tags":["documents_document-delivery-notes"],"summary":"Execute clone action","description":"Creates a copy of the document","operationId":"documents_update_clone_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"41f1d9a3775fa02854fa295820ed0c1d","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/{documentUuid}/actions/convertDNI":{"patch":{"tags":["documents_document-delivery-notes"],"summary":"Execute convertDNI action","description":"Creates an invoice out of a delivery note","operationId":"documents_update_convertDNI","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"4e5cde5d3aa689cb108ad8acbe4724ec","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/{documentUuid}/actions/convertTemplateToDeliveryNote":{"patch":{"tags":["documents_document-delivery-notes"],"summary":"Execute convertTemplateToDeliveryNote action","description":"Creates a delivery note out of a template","operationId":"documents_update_convertTemplateToDeliveryNote","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"acffe954fa67286b531e276cf6c53c93","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/{documentUuid}/actions/convertToTemplate":{"patch":{"tags":["documents_document-delivery-notes"],"summary":"Execute convertToTemplate action","description":"Creates a template out of a document","operationId":"documents_update_convertToTemplate_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"458d90ab2109753eab99a6883653e939","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/{documentUuid}/actions/delete":{"patch":{"tags":["documents_document-delivery-notes"],"summary":"Execute delete action","description":"Deletes a document","operationId":"documents_update_delete_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"f005b7623c57aca143ffd16c5bdd771d","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/{documentUuid}/actions/downloadPdf":{"patch":{"tags":["documents_document-delivery-notes"],"summary":"Execute downloadPdf action","description":"Gets the download uri for the document's pdf","operationId":"documents_update_downloadPdf_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"downloadUrl":{"type":"string","format":"uri"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"a9f8fb8f7d5bea9a5a21e3c795f1bf5f","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/{documentUuid}/actions/email":{"patch":{"tags":["documents_document-delivery-notes"],"summary":"Execute email action","description":"Sends the document via email","operationId":"documents_update_email_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"8dc0252cbc9be58162bcad2bad5501f2","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/{documentUuid}/actions/markSent":{"patch":{"tags":["documents_document-delivery-notes"],"summary":"Execute markSent action","description":"Marks the invoice as sent","operationId":"documents_update_markSent_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"ef4434d1b13fd6d879428f73438af260","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/{documentUuid}/actions/plannedMail":{"patch":{"tags":["documents_document-delivery-notes"],"summary":"Execute plannedMail action","description":"Schedules the email for sending the document","operationId":"documents_update_plannedMail_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"24daa376f8dc897e0d587f634cdbc54f","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/{documentUuid}/actions/print":{"patch":{"tags":["documents_document-delivery-notes"],"summary":"Execute print action","description":"Creates the PDF for printing","operationId":"documents_update_print_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"printUrl":{"type":"string","format":"uri"},"document":{"properties":{"url":{"type":"string","format":"uri"},"preview_url":{"type":"string","format":"uri"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"b3277a46262e46006829fb60ccf2595b","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/{documentUuid}/actions/restore":{"patch":{"tags":["documents_document-delivery-notes"],"summary":"Execute restore action","description":"Restores an archived document","operationId":"documents_update_restore_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"99634e4d2866f5fcb86b61feb56bfddf","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/{documentUuid}/comments/{commentUuid}":{"get":{"tags":["documents_document-delivery-notes"],"summary":"Get comment","description":"fetches a single comment of a document","operationId":"documents_get_comments_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"commentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"5b9b9676dd4983dc2e3d77809c396dd5","x-required-scopes":["customers"]},"delete":{"tags":["documents_document-delivery-notes"],"summary":"Delete comment","description":"deletes a comment of a document, which cannot be restored anymore afterwards.","operationId":"documents_delete_comments_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"commentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"1d7bb970ded9f45618099a9620eeecf1","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/{documentUuid}/files/{fileUuid}":{"get":{"tags":["documents_document-delivery-notes"],"summary":"Get File","description":"Returns a file","operationId":"documents_get_files_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"fileUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document File Detail Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"archivedReason":{"type":["string","null"],"enum":["SENT_NEW_DOCUMENT","CANCELATION","DUNNING","PAYMENT_OFFSET","PAYMENT_CONFIRMED","PAYMENT_CANCELED","MANUAL_RECREATION"]},"fileSize":{"type":"integer","format":"int64"},"mimeType":{"type":"string"},"kind":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]},"fileUrl":{"type":["string","null"],"format":"uri"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"48aa66d129666da319e5e38be5b87436","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/settings/number-ranges/delivery-notes":{"get":{"tags":["documents_document-delivery-note-settings"],"summary":"Get delivery-note number range settings","description":"Get delivery-note number range settings","operationId":"documents_list_delivery_notes_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Number range settings resource","properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"3cfd127993df6bb4473f01f8dea3efe9","x-required-scopes":["settings"]},"patch":{"tags":["documents_document-delivery-note-settings"],"summary":"Update delivery-note number range settings","description":"Update delivery-note number range settings","operationId":"documents_update_delivery_notes_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"number range settings","required":true,"content":{"application/json":{"schema":{"title":"Update number range request","required":[],"properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Number range settings resource","properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"6f4b947ea2c2687f9fffee32c48753ae","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/documents/v2/delivery-notes/settings/number-ranges/templates":{"get":{"tags":["documents_document-delivery-note-settings"],"summary":"Get delivery-note template number range settings","description":"Get delivery-note template number range settings","operationId":"documents_list_templates_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Number range settings resource","properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"dd874820340f2c04f504c78a20c65969","x-required-scopes":["settings"]},"patch":{"tags":["documents_document-delivery-note-settings"],"summary":"Update delivery-note template number range settings","description":"Update delivery-note template number range settings","operationId":"documents_update_templates_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"number range settings","required":true,"content":{"application/json":{"schema":{"title":"Update number range request","required":[],"properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Number range settings resource","properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"bd823d7f15f52bc17bf675b6f0ef41c8","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/archive":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute archive action","description":"Archives the document","operationId":"documents_update_archive_4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"663588a0e9b605f975f7c06fad85c1e3","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/cancel":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute cancel action","description":"Cancels and moves the document back to draft","operationId":"documents_update_cancel_4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"3486047b02134ea6de9eb49efd267467","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/cancelPermanently":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute cancelPermanently action","description":"Cancels the document permanently. It cannot be edited afterwards","operationId":"documents_update_cancelPermanently_4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"870aae031c0f44f6ff30520f17cefb35","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/clone":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute clone action","description":"Creates a copy of the document","operationId":"documents_update_clone_4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"c3ab8cdce79d8bfe4f3711eaf9a036ef","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/convertDN":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute convertDN action","description":"Creates a delivery note out of an invoice","operationId":"documents_update_convertDN","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"f8364a3288eccd05a3079a7374ec92f8","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/convertIC":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute convertIC action","description":"Creates a credit note out of an invoice","operationId":"documents_update_convertIC","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"6184deef3d65f64c4877902b020c39f8","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/convertT":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute convertT action","description":"Creates a template out of an invoice","operationId":"documents_update_convertT","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"807340c402941fd2e8eab88016ee2d21","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/convertTI":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute convertTI action","description":"Creates an invoice out of a template","operationId":"documents_update_convertTI","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"438f824700679f2190a1497578824c03","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/convertToTemplate":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute convertToTemplate action","description":"Creates a template out of a document","operationId":"documents_update_convertToTemplate_4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"87cfcf25b8b562d95104ee0cb4c97a58","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/customerPortalUrl":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute customerPortalUrl action","description":"Gets the customer portal link","operationId":"documents_update_customerPortalUrl","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"customerPortalUrl":{"type":"string","format":"uri"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"0f3ce353b7da6688991bdc2f9959e4f9","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/delete":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute delete action","description":"Deletes a document","operationId":"documents_update_delete_4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"38d676479c7a9dde054de80be270bf04","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/downloadPaymentConfirmation":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute downloadPaymentConfirmation action","description":"Gets the download uri for the document's payment confirmation","operationId":"documents_update_downloadPaymentConfirmation","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"downloadUrl":{"type":"string","format":"uri"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"0e00c0dfdd2e82285544004c5c9e9ded","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/downloadPdf":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute downloadPdf action","description":"Gets the download uri for the document's pdf","operationId":"documents_update_downloadPdf_4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"downloadUrl":{"type":"string","format":"uri"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"56bc5f6af6a1ad379454dbf0df77b73d","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/dunningDate":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute dunningDate action","description":"Sets the custom dunning date","operationId":"documents_update_dunningDate","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Set Custom Dunning Date Request","required":["customDunningDate"],"properties":{"customDunningDate":{"type":["string","null"],"format":"date"}},"type":"object"}}}},"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"b99d8d59092591b74e513d413d39afeb","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/dunningPrint":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute dunningPrint action","description":"Prints the dunning letter for the invoice","operationId":"documents_update_dunningPrint","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"printUrl":{"type":"string","format":"uri"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"e04aa1c7102efedf8d34dba5793f83c4","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/dunningSent":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute dunningSent action","description":"Sends the dunning letter for the invoice","operationId":"documents_update_dunningSent","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"document":{"properties":{"url":{"type":"string","format":"uri"},"preview_url":{"type":"string","format":"uri"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"92878dde0284b794a1dc05cbc98b47c8","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/email":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute email action","description":"Sends the document via email","operationId":"documents_update_email_4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"2433fb158d93b4c498bab24301e4c888","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/markSent":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute markSent action","description":"Marks the invoice as sent","operationId":"documents_update_markSent_4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"04a12d2b30be9421a7f60307fd7e4488","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/plannedMail":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute plannedMail action","description":"Schedules the email for sending the document","operationId":"documents_update_plannedMail_4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"36e82e2d01cadc3a8bccfafcdf48ddbd","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/print":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute print action","description":"Creates the PDF for printing","operationId":"documents_update_print_4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"printUrl":{"type":"string","format":"uri"},"document":{"properties":{"url":{"type":"string","format":"uri"},"preview_url":{"type":"string","format":"uri"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"1d407671477d931cd02bee780eb74755","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/regeneratePdf":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute regeneratePdf action","description":"Regenerates the documents PDF","operationId":"documents_update_regeneratePdf_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Regenerate PDF Action Resource","type":"object","allOf":[{"title":"Document File Detail Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"archivedReason":{"type":["string","null"],"enum":["SENT_NEW_DOCUMENT","CANCELATION","DUNNING","PAYMENT_OFFSET","PAYMENT_CONFIRMED","PAYMENT_CANCELED","MANUAL_RECREATION"]},"fileSize":{"type":"integer","format":"int64"},"mimeType":{"type":"string"},"kind":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]},"fileUrl":{"type":["string","null"],"format":"uri"}},"type":"object"},{"properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"archivedReason":{"type":["string","null"],"enum":["SENT_NEW_DOCUMENT","CANCELATION","DUNNING","PAYMENT_OFFSET","PAYMENT_CONFIRMED","PAYMENT_CANCELED","MANUAL_RECREATION"]},"fileSize":{"type":"integer","format":"int64"},"mimeType":{"type":"string"},"kind":{"type":"string","enum":["invoice"]},"fileUrl":{"type":["string","null"],"format":"uri"}},"type":"object"}]},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"67cd13b5f58df1ddacaf34fb5c991cc1","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/restore":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute restore action","description":"Restores an archived document","operationId":"documents_update_restore_4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"a5f6683fb32ed87ad5b647e25945c95f","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/resync":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute resync action","description":"Resyncs the document to Abacus","operationId":"documents_update_resync_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"4bf66bb1ea29aff18c739b17e67bc75d","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/sendAbaNet":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute sendAbaNet action","description":"Sends the invoice via AbaNet","operationId":"documents_update_sendAbaNet","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"4cccc2f37b8bd1c44fa40d9bda226328","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/sendPaymentConfirmation":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute sendPaymentConfirmation action","description":"Sends the payment confirmation","operationId":"documents_update_sendPaymentConfirmation","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"1d6f0597684a337ea861bf349627f8e4","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/setDunningAmounts":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute setDunningAmounts action","description":"Sets the dunning amounts for the invoice","operationId":"documents_update_setDunningAmounts","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Set Dunning Amounts Request","required":[],"properties":{"customDunningAmount1":{"description":"Amount for first reminder. Must be omitted if reminder was already sent. If null the account settings will be used.","type":["number","null"],"minimum":0},"customDunningAmount2":{"description":"Amount for second reminder. Must be greater or equal than the first reminder amount. Must be omitted if reminder was already sent. If null the account settings will be used.","type":["number","null"],"minimum":0},"customDunningAmount3":{"description":"Amount for third reminder. Must be greater or equal than the second reminder amount. If null the account settings will be used.","type":["number","null"],"minimum":0}},"type":"object"}}}},"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request due to decreasing amounts or attempt to set an amount for a level already sent","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"63f8e6ff979662f86f5532432314afd5","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/actions/sync":{"patch":{"tags":["documents_document-invoices"],"summary":"Execute sync action","description":"Syncs the document to Abacus","operationId":"documents_update_sync_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"861d0384badcbc91775cd25a8b7a7076","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/comments/{commentUuid}":{"get":{"tags":["documents_document-invoices"],"summary":"Get comment","description":"fetches a single comment of a document","operationId":"documents_get_comments_4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"commentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"60ff2b8a2b7765a049d9abe35b28a96f","x-required-scopes":["customers"]},"delete":{"tags":["documents_document-invoices"],"summary":"Delete comment","description":"deletes a comment of a document, which cannot be restored anymore afterwards.","operationId":"documents_delete_comments_4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"commentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"8ffac14216176568f6e2bb1b4bef3360","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/{documentUuid}/files/{fileUuid}":{"get":{"tags":["documents_document-invoices"],"summary":"Get File","description":"Returns a file","operationId":"documents_get_files_4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"fileUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document File Detail Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"archivedReason":{"type":["string","null"],"enum":["SENT_NEW_DOCUMENT","CANCELATION","DUNNING","PAYMENT_OFFSET","PAYMENT_CONFIRMED","PAYMENT_CANCELED","MANUAL_RECREATION"]},"fileSize":{"type":"integer","format":"int64"},"mimeType":{"type":"string"},"kind":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]},"fileUrl":{"type":["string","null"],"format":"uri"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"7d437f6465c7b2a47debc52a72a5d6d0","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/invoices/settings/dunnings/dunning-level-1":{"get":{"tags":["documents_document-invoice-settings"],"summary":"Get First Dunning Settings","description":"Returns the first dunning settings","operationId":"documents_list_dunning_level_1","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"DunningLevelSettingsResource","properties":{"isEnabled":{"type":"boolean"},"numberOfDays":{"type":"integer"},"direction":{"type":"integer","enum":[1,2]},"field":{"type":"integer","enum":[1,2]},"dunningAmount":{"description":"Amount for the dunning level. If null the previous level's amount will be used if set.","type":["number","null"],"minimum":0},"isPrintActive":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"en":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"fr":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"it":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"347bda51ae111ece19d9bcb24659782c","x-required-scopes":["settings"]},"patch":{"tags":["documents_document-invoice-settings"],"summary":"Update First Dunning Settings","description":"Updates the first dunning settings","operationId":"documents_update_dunning_level_1","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update the first dunning settings","required":true,"content":{"application/json":{"schema":{"title":"Update Dunning Level Settings Request","required":[],"properties":{"isEnabled":{"type":"boolean"},"numberOfDays":{"type":"integer"},"direction":{"type":"integer","enum":[1,2]},"field":{"type":"integer","enum":[1,2]},"dunningAmount":{"description":"Amount for the dunning level. If null the previous level's amount will be used if set.","type":["number","null"],"minimum":0},"isPrintActive":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string","maxLength":100}},"type":"object"},"en":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string","maxLength":100}},"type":"object"},"fr":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string","maxLength":100}},"type":"object"},"it":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string","maxLength":100}},"type":"object"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"DunningLevelSettingsResource","properties":{"isEnabled":{"type":"boolean"},"numberOfDays":{"type":"integer"},"direction":{"type":"integer","enum":[1,2]},"field":{"type":"integer","enum":[1,2]},"dunningAmount":{"description":"Amount for the dunning level. If null the previous level's amount will be used if set.","type":["number","null"],"minimum":0},"isPrintActive":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"en":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"fr":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"it":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"b41ac4707113a29e73eb055544d935b8","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/documents/v2/invoices/settings/dunnings/dunning-level-2":{"get":{"tags":["documents_document-invoice-settings"],"summary":"Get Second Dunning Settings","description":"Returns the second dunning settings","operationId":"documents_list_dunning_level_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"DunningLevelSettingsResource","properties":{"isEnabled":{"type":"boolean"},"numberOfDays":{"type":"integer"},"direction":{"type":"integer","enum":[1,2]},"field":{"type":"integer","enum":[1,2]},"dunningAmount":{"description":"Amount for the dunning level. If null the previous level's amount will be used if set.","type":["number","null"],"minimum":0},"isPrintActive":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"en":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"fr":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"it":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"f481b328066b1aa826c617ad26f5d0a5","x-required-scopes":["settings"]},"patch":{"tags":["documents_document-invoice-settings"],"summary":"Update Second Dunning Settings","description":"Updates the second dunning settings","operationId":"documents_update_dunning_level_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update the second dunning settings","required":true,"content":{"application/json":{"schema":{"title":"Update Dunning Level Settings Request","required":[],"properties":{"isEnabled":{"type":"boolean"},"numberOfDays":{"type":"integer"},"direction":{"type":"integer","enum":[1,2]},"field":{"type":"integer","enum":[1,2]},"dunningAmount":{"description":"Amount for the dunning level. If null the previous level's amount will be used if set.","type":["number","null"],"minimum":0},"isPrintActive":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string","maxLength":100}},"type":"object"},"en":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string","maxLength":100}},"type":"object"},"fr":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string","maxLength":100}},"type":"object"},"it":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string","maxLength":100}},"type":"object"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"DunningLevelSettingsResource","properties":{"isEnabled":{"type":"boolean"},"numberOfDays":{"type":"integer"},"direction":{"type":"integer","enum":[1,2]},"field":{"type":"integer","enum":[1,2]},"dunningAmount":{"description":"Amount for the dunning level. If null the previous level's amount will be used if set.","type":["number","null"],"minimum":0},"isPrintActive":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"en":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"fr":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"it":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"450e540997d6a676f7472b27b246ca14","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/documents/v2/invoices/settings/dunnings/dunning-level-3":{"get":{"tags":["documents_document-invoice-settings"],"summary":"Get Third Dunning Settings","description":"Returns the third dunning settings","operationId":"documents_list_dunning_level_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"DunningLevelSettingsResource","properties":{"isEnabled":{"type":"boolean"},"numberOfDays":{"type":"integer"},"direction":{"type":"integer","enum":[1,2]},"field":{"type":"integer","enum":[1,2]},"dunningAmount":{"description":"Amount for the dunning level. If null the previous level's amount will be used if set.","type":["number","null"],"minimum":0},"isPrintActive":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"en":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"fr":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"it":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"8b617449fb12b84607f63848ce5b9986","x-required-scopes":["settings"]},"patch":{"tags":["documents_document-invoice-settings"],"summary":"Update Third Dunning Settings","description":"Updates the third dunning settings","operationId":"documents_update_dunning_level_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update the third dunning settings","required":true,"content":{"application/json":{"schema":{"title":"Update Dunning Level Settings Request","required":[],"properties":{"isEnabled":{"type":"boolean"},"numberOfDays":{"type":"integer"},"direction":{"type":"integer","enum":[1,2]},"field":{"type":"integer","enum":[1,2]},"dunningAmount":{"description":"Amount for the dunning level. If null the previous level's amount will be used if set.","type":["number","null"],"minimum":0},"isPrintActive":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string","maxLength":100}},"type":"object"},"en":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string","maxLength":100}},"type":"object"},"fr":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string","maxLength":100}},"type":"object"},"it":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string","maxLength":100}},"type":"object"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"DunningLevelSettingsResource","properties":{"isEnabled":{"type":"boolean"},"numberOfDays":{"type":"integer"},"direction":{"type":"integer","enum":[1,2]},"field":{"type":"integer","enum":[1,2]},"dunningAmount":{"description":"Amount for the dunning level. If null the previous level's amount will be used if set.","type":["number","null"],"minimum":0},"isPrintActive":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"en":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"fr":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"},"it":{"properties":{"emailSubject":{"type":"string"},"emailTemplate":{"type":"string"},"dunningLetter":{"type":"string"},"dunningAmountLabel":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"f5008337d8130712c6148e41ebf50f9f","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/documents/v2/invoices/settings/number-ranges/invoices":{"get":{"tags":["documents_document-invoice-settings"],"summary":"Get invoice number range settings","description":"Get invoice number range settings","operationId":"documents_list_invoices_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Number range settings resource","properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"5e3028dccba6c7dea3f810f6c2845b8e","x-required-scopes":["settings"]},"patch":{"tags":["documents_document-invoice-settings"],"summary":"Update invoice number range settings","description":"Update invoice number range settings","operationId":"documents_update_invoices_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"number range settings","required":true,"content":{"application/json":{"schema":{"title":"Update number range request","required":[],"properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Number range settings resource","properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"5875e014a17ff7183c38c756a4f07fe1","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/documents/v2/invoices/settings/number-ranges/recurring-invoices":{"get":{"tags":["documents_document-invoice-settings"],"summary":"Get recurring invoice number range settings","description":"Get recurring invoice number range settings","operationId":"documents_list_recurring_invoices","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Number range settings resource","properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"44233205ce2171d6b0cacb3d030ad35b","x-required-scopes":["settings"]},"patch":{"tags":["documents_document-invoice-settings"],"summary":"Update recurring invoice number range settings","description":"Update recurring invoice number range settings","operationId":"documents_update_recurring_invoices","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"number range settings","required":true,"content":{"application/json":{"schema":{"title":"Update number range request","required":[],"properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Number range settings resource","properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"3a1dda1d06a69c7a32411e507604ae0b","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/documents/v2/invoices/settings/number-ranges/templates":{"get":{"tags":["documents_document-invoice-settings"],"summary":"Get invoice template number range settings","description":"Get invoice template number range settings","operationId":"documents_list_templates_4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Number range settings resource","properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"4bb5fe2732bcedd1a6a1e8e66178c7c9","x-required-scopes":["settings"]},"patch":{"tags":["documents_document-invoice-settings"],"summary":"Update invoice template number range settings","description":"Update invoice template number range settings","operationId":"documents_update_templates_4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"number range settings","required":true,"content":{"application/json":{"schema":{"title":"Update number range request","required":[],"properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Number range settings resource","properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"b5ac5e274c519cf752ec249f766bdf09","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/documents/v2/quotes/{documentUuid}/actions/archive":{"patch":{"tags":["documents_document-quotes"],"summary":"Execute archive action","description":"Archives the document","operationId":"documents_update_archive_5","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"b482c3bf0379d400cc6f2b50fd9feb26","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/{documentUuid}/actions/cancel":{"patch":{"tags":["documents_document-quotes"],"summary":"Execute cancel action","description":"Cancels and moves the document back to draft","operationId":"documents_update_cancel_5","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"c1a9ffa395662f9cc8f32646407ed97a","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/{documentUuid}/actions/cancelPermanently":{"patch":{"tags":["documents_document-quotes"],"summary":"Execute cancelPermanently action","description":"Cancels the document permanently. It cannot be edited afterwards","operationId":"documents_update_cancelPermanently_5","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"efc593d83a1cf2081d60a8ce367e4d7b","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/{documentUuid}/actions/clone":{"patch":{"tags":["documents_document-quotes"],"summary":"Execute clone action","description":"Creates a copy of the document","operationId":"documents_update_clone_5","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"2d730ba1bfb547af30d47fa8e694347e","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/{documentUuid}/actions/convert":{"patch":{"tags":["documents_document-quotes"],"summary":"Execute convert action","description":"Creates an invoice out of a quote","operationId":"documents_update_convert","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"6fed8cf5c26254e11f801d0b1491b811","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/{documentUuid}/actions/convertCN":{"patch":{"tags":["documents_document-quotes"],"summary":"Execute convertCN action","description":"Creates a contract note out of a quote","operationId":"documents_update_convertCN","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"e6fcaba3655787901814435e690b91c8","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/{documentUuid}/actions/convertTemplateToQuote":{"patch":{"tags":["documents_document-quotes"],"summary":"Execute convertTemplateToQuote action","description":"Creates a quote out of a template","operationId":"documents_update_convertTemplateToQuote","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"80d18c066436d7d7cfaad14ba8977962","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/{documentUuid}/actions/convertToTemplate":{"patch":{"tags":["documents_document-quotes"],"summary":"Execute convertToTemplate action","description":"Creates a template out of a document","operationId":"documents_update_convertToTemplate_5","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"fb67e7db3ca2de6774b9da626f60257e","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/{documentUuid}/actions/delete":{"patch":{"tags":["documents_document-quotes"],"summary":"Execute delete action","description":"Deletes a document","operationId":"documents_update_delete_5","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"731e33ab0f59280d0844299128478342","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/{documentUuid}/actions/downloadPdf":{"patch":{"tags":["documents_document-quotes"],"summary":"Execute downloadPdf action","description":"Gets the download uri for the document's pdf","operationId":"documents_update_downloadPdf_5","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"downloadUrl":{"type":"string","format":"uri"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"afb1ce91d84f775c6ae9bdbefcf19b41","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/{documentUuid}/actions/email":{"patch":{"tags":["documents_document-quotes"],"summary":"Execute email action","description":"Sends the document via email","operationId":"documents_update_email_5","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"dcd92cf95daf28c56a025d29463e4832","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/{documentUuid}/actions/markApproved":{"patch":{"tags":["documents_document-quotes"],"summary":"Execute markApproved action","description":"Marks the quote as approved","operationId":"documents_update_markApproved","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"defa7e5e54ea7daf0712a2a545bfce3d","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/{documentUuid}/actions/markDeclined":{"patch":{"tags":["documents_document-quotes"],"summary":"Execute markDeclined action","description":"Marks the quote as declined","operationId":"documents_update_markDeclined","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"50ee1822d3ec42aa8b0875c9db4989e9","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/{documentUuid}/actions/markSent":{"patch":{"tags":["documents_document-quotes"],"summary":"Execute markSent action","description":"Marks the invoice as sent","operationId":"documents_update_markSent_5","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"09c2fa33c3e845c1ab6d78f4214657d7","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/{documentUuid}/actions/plannedMail":{"patch":{"tags":["documents_document-quotes"],"summary":"Execute plannedMail action","description":"Schedules the email for sending the document","operationId":"documents_update_plannedMail_5","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"318d2e1e159dacadd2b602f141bb71ab","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/{documentUuid}/actions/print":{"patch":{"tags":["documents_document-quotes"],"summary":"Execute print action","description":"Creates the PDF for printing","operationId":"documents_update_print_5","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"printUrl":{"type":"string","format":"uri"},"document":{"properties":{"url":{"type":"string","format":"uri"},"preview_url":{"type":"string","format":"uri"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"fe9d0c87aeaed21fdaf2266f4fecf3fd","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/{documentUuid}/actions/restore":{"patch":{"tags":["documents_document-quotes"],"summary":"Execute restore action","description":"Restores an archived document","operationId":"documents_update_restore_5","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"68412d1763b2e56ba5cba8869f0a929c","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/{documentUuid}/comments/{commentUuid}":{"get":{"tags":["documents_document-quotes"],"summary":"Get comment","description":"fetches a single comment of a document","operationId":"documents_get_comments_5","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"commentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"90612a596911ddaf3b1035d3f0ad9dff","x-required-scopes":["customers"]},"delete":{"tags":["documents_document-quotes"],"summary":"Delete comment","description":"deletes a comment of a document, which cannot be restored anymore afterwards.","operationId":"documents_delete_comments_5","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"commentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"c85c8b4ff9a794c86c15806fee93c61c","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/{documentUuid}/files/{fileUuid}":{"get":{"tags":["documents_document-quotes"],"summary":"Get File","description":"Returns a file","operationId":"documents_get_files_6","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"fileUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document File Detail Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"archivedReason":{"type":["string","null"],"enum":["SENT_NEW_DOCUMENT","CANCELATION","DUNNING","PAYMENT_OFFSET","PAYMENT_CONFIRMED","PAYMENT_CANCELED","MANUAL_RECREATION"]},"fileSize":{"type":"integer","format":"int64"},"mimeType":{"type":"string"},"kind":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]},"fileUrl":{"type":["string","null"],"format":"uri"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"70005b91514661ef6028347bbbe94b46","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/quotes/settings/number-ranges/quotes":{"get":{"tags":["documents_document-quote-settings"],"summary":"Get quote number range settings","description":"Get quote number range settings","operationId":"documents_list_quotes_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Number range settings resource","properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"4ca6f2a50597cab7b78aa347a1a8cdb8","x-required-scopes":["settings"]},"patch":{"tags":["documents_document-quote-settings"],"summary":"Update quote number range settings","description":"Update quote number range settings","operationId":"documents_update_quotes_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"number range settings","required":true,"content":{"application/json":{"schema":{"title":"Update number range request","required":[],"properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Number range settings resource","properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"f823b6a4f730600a9cb74a9082a0eb45","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/documents/v2/quotes/settings/number-ranges/templates":{"get":{"tags":["documents_document-quote-settings"],"summary":"Get quote template number range settings","description":"Get quote template number range settings","operationId":"documents_list_templates_5","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Number range settings resource","properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"19b986f2e1c56e400f0ed76748829d68","x-required-scopes":["settings"]},"patch":{"tags":["documents_document-quote-settings"],"summary":"Update quote template number range settings","description":"Update quote template number range settings","operationId":"documents_update_templates_5","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"number range settings","required":true,"content":{"application/json":{"schema":{"title":"Update number range request","required":[],"properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Number range settings resource","properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"39c1288cd84c405b76f34701fcebd085","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/documents/v2/receipts/{documentUuid}/actions/archive":{"patch":{"tags":["documents_document-receipts"],"summary":"Execute archive action","description":"Archives the document","operationId":"documents_update_archive_6","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"74804b7052f3f1e20c3c6f9f1159483d","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/receipts/{documentUuid}/actions/cancel":{"patch":{"tags":["documents_document-receipts"],"summary":"Execute cancel action","description":"Cancels and moves the document back to draft","operationId":"documents_update_cancel_6","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"3e3abdcd0882610cbb23fda6a427a492","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/receipts/{documentUuid}/actions/cancelPermanently":{"patch":{"tags":["documents_document-receipts"],"summary":"Execute cancelPermanently action","description":"Cancels the document permanently. It cannot be edited afterwards","operationId":"documents_update_cancelPermanently_6","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"de5497d70febdf69b862799566af102a","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/receipts/{documentUuid}/actions/delete":{"patch":{"tags":["documents_document-receipts"],"summary":"Execute delete action","description":"Deletes a document","operationId":"documents_update_delete_6","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"f825877211b5995991958200320b566e","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/receipts/{documentUuid}/actions/offsetSupplierCreditNotes":{"patch":{"tags":["documents_document-receipts"],"summary":"Execute offsetSupplierCreditNotes action","description":"Offsets supplier credit notes to the receipt","operationId":"documents_update_offsetSupplierCreditNotes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Offset Supplier Credit Notes Action Request","required":["supplierCreditNoteUuids"],"properties":{"supplierCreditNoteUuids":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1},"valutaDate":{"type":["string","null"],"format":"date"}},"type":"object"}}}},"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"counter":{"type":"integer"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"25dfd6aad7f73e210b6754c110fd9085","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/receipts/{documentUuid}/actions/regeneratePdf":{"patch":{"tags":["documents_document-receipts"],"summary":"Execute regeneratePdf action","description":"Regenerates the documents PDF","operationId":"documents_update_regeneratePdf_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Regenerate PDF Action Resource","type":"object","allOf":[{"title":"Document File Detail Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"archivedReason":{"type":["string","null"],"enum":["SENT_NEW_DOCUMENT","CANCELATION","DUNNING","PAYMENT_OFFSET","PAYMENT_CONFIRMED","PAYMENT_CANCELED","MANUAL_RECREATION"]},"fileSize":{"type":"integer","format":"int64"},"mimeType":{"type":"string"},"kind":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]},"fileUrl":{"type":["string","null"],"format":"uri"}},"type":"object"},{"properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"archivedReason":{"type":["string","null"],"enum":["SENT_NEW_DOCUMENT","CANCELATION","DUNNING","PAYMENT_OFFSET","PAYMENT_CONFIRMED","PAYMENT_CANCELED","MANUAL_RECREATION"]},"fileSize":{"type":"integer","format":"int64"},"mimeType":{"type":"string"},"kind":{"type":"string","enum":["invoice"]},"fileUrl":{"type":["string","null"],"format":"uri"}},"type":"object"}]},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"25e204ff4e09579d5dd4bfa54a42f19d","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/receipts/{documentUuid}/actions/restore":{"patch":{"tags":["documents_document-receipts"],"summary":"Execute restore action","description":"Restores an archived document","operationId":"documents_update_restore_6","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"7fe2661f7244e881191cd63f57b814eb","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/receipts/{documentUuid}/actions/resync":{"patch":{"tags":["documents_document-receipts"],"summary":"Execute resync action","description":"Resyncs the document to Abacus","operationId":"documents_update_resync_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"673f3a908b0038f428e0c49ff0d0c65d","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/receipts/{documentUuid}/actions/sync":{"patch":{"tags":["documents_document-receipts"],"summary":"Execute sync action","description":"Syncs the document to Abacus","operationId":"documents_update_sync_3","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"86c6c5bf8e669d1826d881edc0c46d37","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/receipts/{documentUuid}/comments/{commentUuid}":{"get":{"tags":["documents_document-receipts"],"summary":"Get comment","description":"fetches a single comment of a document","operationId":"documents_get_comments_7","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"commentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"89969bba0821407998910f1a724f91ed","x-required-scopes":["suppliers"]},"delete":{"tags":["documents_document-receipts"],"summary":"Delete comment","description":"deletes a comment of a document, which cannot be restored anymore afterwards.","operationId":"documents_delete_comments_7","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"commentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"035ae904f7f1f5fde8d5bad70ca800af","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/receipts/{documentUuid}/files/{fileUuid}":{"get":{"tags":["documents_document-receipts"],"summary":"Get File","description":"Returns a file","operationId":"documents_get_files_7","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"fileUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document File Detail Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"archivedReason":{"type":["string","null"],"enum":["SENT_NEW_DOCUMENT","CANCELATION","DUNNING","PAYMENT_OFFSET","PAYMENT_CONFIRMED","PAYMENT_CANCELED","MANUAL_RECREATION"]},"fileSize":{"type":"integer","format":"int64"},"mimeType":{"type":"string"},"kind":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]},"fileUrl":{"type":["string","null"],"format":"uri"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"f863a51d5a343ee563004b237539e5ed","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/receipts/settings/auto-processing/abaclik":{"get":{"tags":["documents_document-receipt-settings"],"summary":"Get AbaClik auto-processing settings","description":"Get AbaClik auto-processing settings","operationId":"documents_list_abaclik","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Auto-processing setting resource","properties":{"limit":{"type":"number","format":"float","minimum":1},"isActive":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"7199f6a4aa05dc3d64176f89a56dfef6","x-required-scopes":["settings"]},"patch":{"tags":["documents_document-receipt-settings"],"summary":"Update AbaClik auto-processing settings","description":"Update AbaClik auto-processing settings","operationId":"documents_update_abaclik","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"auto-processing settings","required":true,"content":{"application/json":{"schema":{"title":"Update auto-processing setting request","required":[],"properties":{"limit":{"type":"number","format":"float","minimum":1},"isActive":{"type":"boolean"},"isAutoImportActive":{"description":"Skip Editor in AbaNinja","type":"boolean","default":false}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Auto-processing setting resource","properties":{"limit":{"type":"number","format":"float","minimum":1},"isActive":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"fe5c852e9b01a3461d646193d3445a59","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/documents/v2/receipts/settings/auto-processing/deepcloud":{"get":{"tags":["documents_document-receipt-settings"],"summary":"Get DeepCloud auto-processing settings","description":"Get DeepCloud auto-processing settings","operationId":"documents_list_deepcloud","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Auto-processing setting resource","properties":{"limit":{"type":"number","format":"float","minimum":1},"isActive":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"5917d27f2775bb6afc69292a21db9496","x-required-scopes":["settings"]},"patch":{"tags":["documents_document-receipt-settings"],"summary":"Update DeepCloud auto-processing settings","description":"Update DeepCloud auto-processing settings","operationId":"documents_update_deepcloud","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"auto-processing settings","required":true,"content":{"application/json":{"schema":{"title":"Update auto-processing setting request","required":[],"properties":{"limit":{"type":"number","format":"float","minimum":1},"isActive":{"type":"boolean"},"isAutoImportActive":{"description":"Skip Editor in AbaNinja","type":"boolean","default":false}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Auto-processing setting resource","properties":{"limit":{"type":"number","format":"float","minimum":1},"isActive":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"6c21038abc011ec09de077a66c519dfb","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/documents/v2/receipts/settings/number-ranges/receipts":{"get":{"tags":["documents_document-receipt-settings"],"summary":"Get receipt number range settings","description":"Get receipt number range settings","operationId":"documents_list_receipts_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Number range settings resource","properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"40c1d49ec0a2c741a318dac41b0afc0f","x-required-scopes":["settings"]},"patch":{"tags":["documents_document-receipt-settings"],"summary":"Update receipt number range settings","description":"Update receipt number range settings","operationId":"documents_update_receipts","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"number range settings","required":true,"content":{"application/json":{"schema":{"title":"Update number range request","required":[],"properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Number range settings resource","properties":{"counter":{"type":"number","format":"int64","minimum":1},"pattern":{"type":"string"},"padding":{"type":"number","format":"int64","maximum":8,"minimum":1}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"679c075a20c73f0c30945fe5328408b6","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/documents/v2/recurring-invoices/{documentUuid}/actions/archive":{"patch":{"tags":["documents_document-recurring-invoices"],"summary":"Execute archive action","description":"Archives the document","operationId":"documents_update_archive_7","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"c02a264c5adb9724453b80cb3a0e12ce","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/recurring-invoices/{documentUuid}/actions/cancel":{"patch":{"tags":["documents_document-recurring-invoices"],"summary":"Execute cancel action","description":"Cancels and moves the document back to draft","operationId":"documents_update_cancel_7","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"11c0e0f0d30e6229df83b9a5c3b996c0","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/recurring-invoices/{documentUuid}/actions/cancelPermanently":{"patch":{"tags":["documents_document-recurring-invoices"],"summary":"Execute cancelPermanently action","description":"Cancels the document permanently. It cannot be edited afterwards","operationId":"documents_update_cancelPermanently_7","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"c79a05cfbac16cdbdc437d1d74d705e8","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/recurring-invoices/{documentUuid}/actions/clone":{"patch":{"tags":["documents_document-recurring-invoices"],"summary":"Execute clone action","description":"Creates a copy of the document","operationId":"documents_update_clone_6","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isTemplate":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"c2ffafd519c664250d06da8b1abe706e","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/recurring-invoices/{documentUuid}/actions/delete":{"patch":{"tags":["documents_document-recurring-invoices"],"summary":"Execute delete action","description":"Deletes a document","operationId":"documents_update_delete_7","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"af6ca697e5a8093820541904b166988e","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/recurring-invoices/{documentUuid}/actions/restore":{"patch":{"tags":["documents_document-recurring-invoices"],"summary":"Execute restore action","description":"Restores an archived document","operationId":"documents_update_restore_7","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"9d5b484083830f7cda89dfbf73923215","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/recurring-invoices/{documentUuid}/comments/{commentUuid}":{"get":{"tags":["documents_document-recurring-invoices"],"summary":"Get comment","description":"fetches a single comment of a document","operationId":"documents_get_comments_6","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"commentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"a0661ee987e4eaa1afd23310f54dc9e5","x-required-scopes":["customers"]},"delete":{"tags":["documents_document-recurring-invoices"],"summary":"Delete comment","description":"deletes a comment of a document, which cannot be restored anymore afterwards.","operationId":"documents_delete_comments_6","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"commentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"de243a9c105add749aaaf6ba9695a7e9","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/recurring-invoices/{documentUuid}/files/{fileUuid}":{"get":{"tags":["documents_document-recurring-invoices"],"summary":"Get File","description":"Returns a file","operationId":"documents_get_files_5","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"fileUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document File Detail Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"archivedReason":{"type":["string","null"],"enum":["SENT_NEW_DOCUMENT","CANCELATION","DUNNING","PAYMENT_OFFSET","PAYMENT_CONFIRMED","PAYMENT_CANCELED","MANUAL_RECREATION"]},"fileSize":{"type":"integer","format":"int64"},"mimeType":{"type":"string"},"kind":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]},"fileUrl":{"type":["string","null"],"format":"uri"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"c0e4f093ef0d3d51a091ac1561f4ef3e","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/supplier-credit-notes/{documentUuid}/actions/archive":{"patch":{"tags":["documents_document-supplier-credit-notes"],"summary":"Execute archive action","description":"Archives the document","operationId":"documents_update_archive_8","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"d2f3fdc080ba0c56f7d64ba6e4c5ceb3","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/supplier-credit-notes/{documentUuid}/actions/cancel":{"patch":{"tags":["documents_document-supplier-credit-notes"],"summary":"Execute cancel action","description":"Cancels and moves the document back to draft","operationId":"documents_update_cancel_8","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"feeff3afc04fa21efca52ff4c72f4115","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/supplier-credit-notes/{documentUuid}/actions/cancelPermanently":{"patch":{"tags":["documents_document-supplier-credit-notes"],"summary":"Execute cancelPermanently action","description":"Cancels the document permanently. It cannot be edited afterwards","operationId":"documents_update_cancelPermanently_8","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"5587ade0f7025e5a09e607cb19db7891","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/supplier-credit-notes/{documentUuid}/actions/delete":{"patch":{"tags":["documents_document-supplier-credit-notes"],"summary":"Execute delete action","description":"Deletes a document","operationId":"documents_update_delete_8","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"00742682c635331975f11d6834ec45cd","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/supplier-credit-notes/{documentUuid}/actions/offsetReceipts":{"patch":{"tags":["documents_document-supplier-credit-notes"],"summary":"Execute offsetReceipts action","description":"Offsets the supplier credit note to receipts","operationId":"documents_update_offsetReceipts","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Offset Receipts Action Request","required":["receiptUuids"],"properties":{"receiptUuids":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1},"valutaDate":{"type":["string","null"],"format":"date"}},"type":"object"}}}},"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"counter":{"type":"integer"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"0e78cc7af4a2419bcff378c31ea979ca","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/supplier-credit-notes/{documentUuid}/actions/restore":{"patch":{"tags":["documents_document-supplier-credit-notes"],"summary":"Execute restore action","description":"Restores an archived document","operationId":"documents_update_restore_8","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"properties":{"type":{"type":"string","enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"cac5b7b7cc41abe603bdd862f8ec033a","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/supplier-credit-notes/{documentUuid}/actions/signSupplierCreditNote":{"patch":{"tags":["documents_document-supplier-credit-notes"],"summary":"Execute signSupplierCreditNote action","description":"Signs the supplier credit note","operationId":"documents_update_signSupplierCreditNote","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successfully executed action","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"6ae3a62019b66946e55b9347e945482b","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/supplier-credit-notes/{documentUuid}/comments/{commentUuid}":{"get":{"tags":["documents_document-supplier-credit-notes"],"summary":"Get comment","description":"fetches a single comment of a document","operationId":"documents_get_comments_8","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"commentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"description":"Defines if it is only for internal use or if customers can see the comments","type":"string","enum":["intern","extern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"a0bc2e74696ac3195c714e15198868d8","x-required-scopes":["suppliers"]},"delete":{"tags":["documents_document-supplier-credit-notes"],"summary":"Delete comment","description":"deletes a comment of a document, which cannot be restored anymore afterwards.","operationId":"documents_delete_comments_8","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"commentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"f95cd544b46a9f4fb33dc21969a99ee0","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/documents/v2/supplier-credit-notes/{documentUuid}/files/{fileUuid}":{"get":{"tags":["documents_document-supplier-credit-notes"],"summary":"Get File","description":"Returns a file","operationId":"documents_get_files_8","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"documentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"fileUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Document File Detail Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"archivedReason":{"type":["string","null"],"enum":["SENT_NEW_DOCUMENT","CANCELATION","DUNNING","PAYMENT_OFFSET","PAYMENT_CONFIRMED","PAYMENT_CANCELED","MANUAL_RECREATION"]},"fileSize":{"type":"integer","format":"int64"},"mimeType":{"type":"string"},"kind":{"type":"string","enum":["invoice","invoice_attachment","invoice_payments","imported_invoice"]},"fileUrl":{"type":["string","null"],"format":"uri"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/suppliers"]}],"x-legacy-operation-id":"074f9f42a959c5fc5b68d0e4cfa7afdf","x-required-scopes":["suppliers"]}},"/accounts/{accountUuid}/exports/v2/exports":{"get":{"tags":["exports_exports"],"summary":"Get exports","description":"Get exports with current state","operationId":"exports_list_exports","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}},{"name":"type","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["WAREHOUSE_STOCKS_ALL","WAREHOUSE_PRODUCT_RESERVATIONS"]},"minimum":0}},{"name":"expired","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Export Resource","properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["WAREHOUSE_STOCKS_ALL","WAREHOUSE_PRODUCT_RESERVATIONS"]},"status":{"type":"string","enum":["QUEUED","RUNNING","FINISHED","FAILED"]},"name":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"},"startedAt":{"type":["string","null"],"format":"date-time"},"finishedAt":{"type":["string","null"],"format":"date-time"},"expiresAt":{"type":["string","null"],"format":"date-time"},"isExpired":{"type":"boolean"}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":[]}],"x-legacy-operation-id":"afbe28436acbd9c37d689255e95c9118"}},"/accounts/{accountUuid}/exports/v2/exports/{exportUuid}":{"get":{"tags":["exports_exports"],"summary":"Get export item","description":"Get export item with current state","operationId":"exports_get_exports","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"exportUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Export Download Resource","properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["WAREHOUSE_STOCKS_ALL","WAREHOUSE_PRODUCT_RESERVATIONS"]},"status":{"type":"string","enum":["QUEUED","RUNNING","FINISHED","FAILED"]},"name":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"},"startedAt":{"type":["string","null"],"format":"date-time"},"finishedAt":{"type":["string","null"],"format":"date-time"},"expiresAt":{"type":["string","null"],"format":"date-time"},"isExpired":{"type":"boolean"},"downloadUrl":{"type":["string","null"],"format":"uri"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":[]}],"x-legacy-operation-id":"4764db15ddef6a4872e93d7a1fec0c50"}},"/accounts/{accountUuid}/finances/v2/bank-accounts":{"get":{"tags":["finances_bank-accounts"],"summary":"Get bank accounts","description":"Get bank accounts of account","operationId":"finances_list_bank_accounts","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Bank Account Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":["string","null"]},"bankName":{"type":["string","null"]},"bankAddress":{"type":["string","null"]},"bankCity":{"type":["string","null"]},"iban":{"type":["string","null"]},"bic":{"type":["string","null"]},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"qrBill":{"properties":{"active":{"type":"boolean"},"qrIban":{"type":["string","null"]},"besrId":{"type":["string","null"]}},"type":"object"},"isActive":{"type":"boolean"},"isDefault":{"type":"boolean"},"bankId":{"type":"number","format":"int64"},"bankLastSync":{"type":["string","null"],"format":"date-time"},"bankSyncStatus":{"type":["string","null"]},"bankConnectionType":{"type":["string","null"],"enum":["ABABANK","BLINK","DEEPCLOUD","OAUTH","YAPEAL","TEMPORARY"]},"accAccountUuid":{"type":"string","format":"uuid"},"paymentOrderExportStatusSetting":{"type":"string","enum":["PENDENT","FINISHED"]},"eBankingImportSetting":{"type":"string","enum":["ALL","CREDITS_ONLY","DEBITS_ONLY"]},"eBankingImportPayrolls":{"type":"boolean"},"eBankingImportCollectivePayments":{"type":"boolean"},"id":{"type":"number","format":"int64","deprecated":true}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"2f50ca4206d23e7df2c4784dd244a9f3","x-required-scopes":["finances"]},"post":{"tags":["finances_bank-accounts"],"summary":"Create bank account","description":"Create a bank account for an account","operationId":"finances_create_bank_accounts","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create bank account","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/bank-account.schema.json","description":"A Schema for creating bank accounts in AbaNinja","type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"bankName":{"type":["null","string"],"maxLength":255},"bankAddress":{"type":["null","string"],"maxLength":255},"bankCity":{"type":["null","string"],"maxLength":255,"description":"postal code & town of the bank institute"},"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}$"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$","example":"CHF"},"qrBill":{"type":"object","properties":{"active":{"type":"boolean","default":false},"qrIban":{"type":["null","string"],"pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}"},"besrId":{"type":["null","string"],"pattern":"^[0-9]{6,8}$"}}},"isActive":{"type":"boolean","default":true,"description":"Activate/Deactivate bank account for usage in AbaNinja. Default: active"},"isDefault":{"type":"boolean","default":false,"description":"Set if bank account should be used as default."},"paymentOrderExportStatusSetting":{"type":"string","default":"FINISHED","description":"Set the status of the payment orders for this bank account when they are exported manually","enum":["FINISHED","PENDENT"]},"eBankingImportSetting":{"type":"string","default":"ALL","description":"Set which transaction types will be imported when a bank statement file is imported.","enum":["ALL","CREDITS_ONLY","DEBITS_ONLY"]},"eBankingImportPayrolls":{"type":"boolean","default":true,"description":"Control whether or not payroll transactions should be imported. Note: eBankingImportSetting has priority over this"},"eBankingImportCollectivePayments":{"type":"boolean","default":true,"description":"Control whether or not collective payment transactions should be imported. Note: eBankingImportSetting has priority over this"}},"required":["name","iban","currencyCode"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Bank Account Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":["string","null"]},"bankName":{"type":["string","null"]},"bankAddress":{"type":["string","null"]},"bankCity":{"type":["string","null"]},"iban":{"type":["string","null"]},"bic":{"type":["string","null"]},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"qrBill":{"properties":{"active":{"type":"boolean"},"qrIban":{"type":["string","null"]},"besrId":{"type":["string","null"]}},"type":"object"},"isActive":{"type":"boolean"},"isDefault":{"type":"boolean"},"bankId":{"type":"number","format":"int64"},"bankLastSync":{"type":["string","null"],"format":"date-time"},"bankSyncStatus":{"type":["string","null"]},"bankConnectionType":{"type":["string","null"],"enum":["ABABANK","BLINK","DEEPCLOUD","OAUTH","YAPEAL","TEMPORARY"]},"accAccountUuid":{"type":"string","format":"uuid"},"paymentOrderExportStatusSetting":{"type":"string","enum":["PENDENT","FINISHED"]},"eBankingImportSetting":{"type":"string","enum":["ALL","CREDITS_ONLY","DEBITS_ONLY"]},"eBankingImportPayrolls":{"type":"boolean"},"eBankingImportCollectivePayments":{"type":"boolean"},"id":{"type":"number","format":"int64","deprecated":true}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"da821be7b9aed2f563a4c75800341229","x-required-scopes":["finances"]}},"/accounts/{accountUuid}/finances/v2/bank-files":{"get":{"tags":["finances_bank-files"],"summary":"Get bank files","description":"Get a list of bank files","operationId":"finances_list_bank_files","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Bank File Resource","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"integer","deprecated":true},"fileName":{"type":"string"},"fileType":{"type":["string","null"]},"isImported":{"type":"boolean"},"createdAt":{"type":["string","null"],"format":"date-time"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"e1569efcda5d69f2c014e4b2fdeb131b","x-required-scopes":["finances"]}},"/accounts/{accountUuid}/finances/v2/payment-order-files":{"get":{"tags":["finances_bank-files"],"summary":"Get payment orders","description":"Get payment order files","operationId":"finances_list_payment_order_files","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Payment order file resource","properties":{"uuid":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date"},"availableUntil":{"type":"string","format":"date"},"bankAccountIban":{"type":"string"},"bankAccountDescription":{"type":"string"}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"d620f2409a5341a068a1e6b5a2dd36d1","x-required-scopes":["finances"]}},"/accounts/{accountUuid}/finances/v2/payments":{"get":{"tags":["finances_payments"],"summary":"Get payments","description":"Retrieve a paginated list of all payments of the account","operationId":"8a2ca2d2a4f0ee4836a8309b47b0b4e4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"pagination limit","required":false,"schema":{"type":"number","format":"int64","maximum":1000,"minimum":1}},{"name":"page","in":"query","description":"pagination page","required":false,"schema":{"type":"number","format":"int64","default":1,"minimum":1}}],"responses":{"200":{"description":"List of payments","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PaymentLiteResource"}},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"},"post":{"tags":["finances_payments"],"summary":"Create payment","description":"Create a new payment","operationId":"21deb2507b21bdd2f87e074e5894f81d","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create payment","required":true,"content":{"application/json":{"schema":{"type":"object","description":"Schema: payment.schema"}}}},"responses":{"201":{"description":"Payment created","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{"$ref":"#/components/schemas/PaymentResource"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Bad Request":{"summary":"Bad Request","value":{"detail":[],"type":"validation_error","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Bad request or validation error","status":400}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"}},"/accounts/{accountUuid}/finances/v2/bank-accounts/{bankAccountUuid}":{"get":{"tags":["finances_bank-accounts"],"summary":"Get bank account","description":"Get bank account of account","operationId":"finances_get_bank_accounts","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"bankAccountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Bank Account Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":["string","null"]},"bankName":{"type":["string","null"]},"bankAddress":{"type":["string","null"]},"bankCity":{"type":["string","null"]},"iban":{"type":["string","null"]},"bic":{"type":["string","null"]},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"qrBill":{"properties":{"active":{"type":"boolean"},"qrIban":{"type":["string","null"]},"besrId":{"type":["string","null"]}},"type":"object"},"isActive":{"type":"boolean"},"isDefault":{"type":"boolean"},"bankId":{"type":"number","format":"int64"},"bankLastSync":{"type":["string","null"],"format":"date-time"},"bankSyncStatus":{"type":["string","null"]},"bankConnectionType":{"type":["string","null"],"enum":["ABABANK","BLINK","DEEPCLOUD","OAUTH","YAPEAL","TEMPORARY"]},"accAccountUuid":{"type":"string","format":"uuid"},"paymentOrderExportStatusSetting":{"type":"string","enum":["PENDENT","FINISHED"]},"eBankingImportSetting":{"type":"string","enum":["ALL","CREDITS_ONLY","DEBITS_ONLY"]},"eBankingImportPayrolls":{"type":"boolean"},"eBankingImportCollectivePayments":{"type":"boolean"},"id":{"type":"number","format":"int64","deprecated":true}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"28db5c076b14ff5e52055ada9aae42a1","x-required-scopes":["finances"]},"patch":{"tags":["finances_bank-accounts"],"summary":"Update bank account","description":"Update a bank account for an account","operationId":"finances_update_bank_accounts","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"bankAccountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update bank account","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/bank-account.schema.json","description":"A Schema for creating bank accounts in AbaNinja","type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"bankName":{"type":["null","string"],"maxLength":255},"bankAddress":{"type":["null","string"],"maxLength":255},"bankCity":{"type":["null","string"],"maxLength":255,"description":"postal code & town of the bank institute"},"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}$"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$","example":"CHF"},"qrBill":{"type":"object","properties":{"active":{"type":"boolean","default":false},"qrIban":{"type":["null","string"],"pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}"},"besrId":{"type":["null","string"],"pattern":"^[0-9]{6,8}$"}}},"isActive":{"type":"boolean","default":true,"description":"Activate/Deactivate bank account for usage in AbaNinja. Default: active"},"isDefault":{"type":"boolean","default":false,"description":"Set if bank account should be used as default."},"paymentOrderExportStatusSetting":{"type":"string","default":"FINISHED","description":"Set the status of the payment orders for this bank account when they are exported manually","enum":["FINISHED","PENDENT"]},"eBankingImportSetting":{"type":"string","default":"ALL","description":"Set which transaction types will be imported when a bank statement file is imported.","enum":["ALL","CREDITS_ONLY","DEBITS_ONLY"]},"eBankingImportPayrolls":{"type":"boolean","default":true,"description":"Control whether or not payroll transactions should be imported. Note: eBankingImportSetting has priority over this"},"eBankingImportCollectivePayments":{"type":"boolean","default":true,"description":"Control whether or not collective payment transactions should be imported. Note: eBankingImportSetting has priority over this"}},"required":["name","iban","currencyCode"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Bank Account Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":["string","null"]},"bankName":{"type":["string","null"]},"bankAddress":{"type":["string","null"]},"bankCity":{"type":["string","null"]},"iban":{"type":["string","null"]},"bic":{"type":["string","null"]},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"qrBill":{"properties":{"active":{"type":"boolean"},"qrIban":{"type":["string","null"]},"besrId":{"type":["string","null"]}},"type":"object"},"isActive":{"type":"boolean"},"isDefault":{"type":"boolean"},"bankId":{"type":"number","format":"int64"},"bankLastSync":{"type":["string","null"],"format":"date-time"},"bankSyncStatus":{"type":["string","null"]},"bankConnectionType":{"type":["string","null"],"enum":["ABABANK","BLINK","DEEPCLOUD","OAUTH","YAPEAL","TEMPORARY"]},"accAccountUuid":{"type":"string","format":"uuid"},"paymentOrderExportStatusSetting":{"type":"string","enum":["PENDENT","FINISHED"]},"eBankingImportSetting":{"type":"string","enum":["ALL","CREDITS_ONLY","DEBITS_ONLY"]},"eBankingImportPayrolls":{"type":"boolean"},"eBankingImportCollectivePayments":{"type":"boolean"},"id":{"type":"number","format":"int64","deprecated":true}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"8c8cfe73399698203bfc2f4d95f97e3a","x-required-scopes":["finances"]},"delete":{"tags":["finances_bank-accounts"],"summary":"Delete bank account","description":"Delete a bank account for an account","operationId":"finances_delete_bank_accounts","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"bankAccountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"10aa535b7ce17c7ddf0f6294e837bcaf","x-required-scopes":["finances"]}},"/accounts/{accountUuid}/finances/v2/bank-files/{bankFileUuid}":{"get":{"tags":["finances_bank-files"],"summary":"Get bank file","description":"Get a single bank file","operationId":"finances_get_bank_files","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"bankFileUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Bank File Resource","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"integer","deprecated":true},"fileName":{"type":"string"},"fileType":{"type":["string","null"]},"isImported":{"type":"boolean"},"createdAt":{"type":["string","null"],"format":"date-time"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"b602843aec013d1d870d0b963272921f","x-required-scopes":["finances"]}},"/accounts/{accountUuid}/finances/v2/payment-order-files/{paymentOrderFileUuid}":{"get":{"tags":["finances_bank-files"],"summary":"Get file entries","description":"Get entries of a payment order file","operationId":"finances_get_payment_order_files","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentOrderFileUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Payment order resource","properties":{"status":{"type":"string","enum":["PENDING","ACCEPTED","CHANGED","EXPORTED","DECLINED","ERROR"]},"statusMessage":{"type":["string","null"]},"paymentAmount":{"type":["number","null"],"format":"double"},"paymentCurrencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"paymentDate":{"type":["string","null"],"format":"date"},"paymentReceiver":{"type":["string","null"]}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"90e8a3e3bc4108f5935dd40f529aa9a2","x-required-scopes":["finances"]}},"/accounts/{accountUuid}/finances/v2/payments/{paymentUuid}":{"get":{"tags":["finances_payments"],"summary":"Get payment","description":"Get data of a single payment","operationId":"7c18a0be695232e203e87065878f12f6","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","description":"uuid of the payment to retrieve","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The requested payment","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{"$ref":"#/components/schemas/PaymentResource"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Not found":{"summary":"Not found","value":{"detail":[],"type":"not_found","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Payment not found","status":404}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"},"patch":{"tags":["finances_payments"],"summary":"Update payment","operationId":"f5f4718f17dce304bb058f584bb1e1f4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","description":"the uuid of the payment to update","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create payment","required":true,"content":{"application/json":{"schema":{"type":"object","description":"Schema: payment.schema"}}}},"responses":{"200":{"description":"Payment updated","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{"$ref":"#/components/schemas/PaymentResource"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Bad Request":{"summary":"Bad Request","value":{"detail":[],"type":"validation_error","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Bad request or validation error","status":400}}}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Not found":{"summary":"Not found","value":{"detail":[],"type":"not_found","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Payment not found","status":404}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"},"delete":{"tags":["finances_payments"],"summary":"Delete payment","description":"Delete the given payment","operationId":"d68e398d007e30862a272208958f6119","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","description":"Uuid of the payment to delete.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Payment deleted","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Bad Request":{"summary":"Bad Request","value":{"detail":[],"type":"validation_error","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Bad request or validation error","status":400}}}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Not found":{"summary":"Not found","value":{"detail":[],"type":"not_found","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Payment not found","status":404}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"}},"/accounts/{accountUuid}/finances/v2/bank-files/{bankFileUuid}/amounts":{"get":{"tags":["finances_bank-files"],"summary":"Get bank file amounts","description":"Get a single bank file amounts","operationId":"finances_list_amounts","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"bankFileUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Bank File Amount Resource","properties":{"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"amount":{"type":"number","format":"float"},"dummy":{"type":"number","format":"float"},"ignored":{"type":"number","format":"float"},"imported":{"type":"number","format":"float"},"matched":{"type":"number","format":"float"},"noMatching":{"type":"number","format":"float"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"003dc5439cb20076f66c697ed1283110","x-required-scopes":["finances"]}},"/accounts/{accountUuid}/finances/v2/bank-files/{bankFileUuid}/entries":{"get":{"tags":["finances_bank-files"],"summary":"Get entries","description":"Get bank files entries","operationId":"finances_list_entries","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"bankFileUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Bank File Entry Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"accountCurrency":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"amount":{"type":"number","format":"float"},"chargedAmount":{"type":"number","format":"float"},"direction":{"type":"string","enum":["IN","OUT"]},"exchangeRate":{"type":["number","null"],"format":"float"},"isCollective":{"type":"boolean"},"isIgnored":{"type":"boolean"},"isPayroll":{"type":"boolean"},"outReference":{"type":["string","null"]},"reference":{"type":"string"},"status":{"type":"string","enum":["duplicate","ignored","matched","no_matching_invoice"]},"invoiceUuid":{"type":["string","null"],"format":"uuid"},"invoiceId":{"type":["integer","null"],"deprecated":true},"invoiceType":{"type":["string","null"],"enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"invoiceNumber":{"type":["string","null"]},"invoiceIsImported":{"type":["boolean","null"]},"additionalInfo":{"type":["string","null"]},"addressName":{"type":["string","null"]},"valueDate":{"type":["string","null"],"format":"date-time"}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"4547b32d439efa2442215c5c69c513a1","x-required-scopes":["finances"]}},"/accounts/{accountUuid}/finances/v2/payment-order-files/{paymentOrderFileUuid}/download-feedback-file":{"get":{"tags":["finances_bank-files"],"summary":"Download feedback file","description":"Download feedback file (PAIN002)","operationId":"finances_list_download_feedback_file","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentOrderFileUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","headers":{"Content-Type":{"schema":{"type":"string","enum":["application/xml"]}},"Content-Length":{"schema":{"type":"integer"}}},"content":{"application/xml":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"File not found or expired","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"f52d7d2f3e773f40b1117d76c59bfb1c","x-required-scopes":["finances"]}},"/accounts/{accountUuid}/finances/v2/payment-order-files/{paymentOrderFileUuid}/download-file":{"get":{"tags":["finances_bank-files"],"summary":"Download file","description":"Download payment order file (PAIN001)","operationId":"finances_list_download_file","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentOrderFileUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","headers":{"Content-Type":{"schema":{"type":"string","enum":["application/zip"]}},"Content-Length":{"schema":{"type":"integer"}}},"content":{"application/zip":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"File not found or expired","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"52f15135326ffa378216167c7cea6394","x-required-scopes":["finances"]}},"/accounts/{accountUuid}/finances/v2/payments/{paymentUuid}/actions":{"get":{"tags":["finances_payments"],"summary":"Get payment actions","description":"Get a list of applicable actions for the given payments","operationId":"2e391319046d33a6ffed1b1177e627d5","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","description":"uuid of the payment to retrieve actions for","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"A list of applicable actions","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PaymentActionResource"}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Not found":{"summary":"Not found","value":{"detail":[],"type":"not_found","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Payment not found","status":404}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"}},"/accounts/{accountUuid}/finances/v2/payments/{paymentUuid}/attachments":{"post":{"tags":["finances_payments"],"summary":"Upload attachment","description":"Upload an attachment for the payment","operationId":"3725c314e23d25413503a14d51813f67","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","description":"the uuid of the payment for which the attachment should be uploaded","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Attachment file. Allowed are: pdf,png and jpeg files","required":true,"content":{"multipart/form-data":{"schema":{"required":["attachment"],"properties":{"attachment":{"type":"string","format":"binary"}},"type":"object"}}}},"responses":{"201":{"description":"Attachment uploaded","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Bad Request":{"summary":"Bad Request","value":{"detail":[],"type":"validation_error","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Bad request or validation error","status":400}}}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Not found":{"summary":"Not found","value":{"detail":[],"type":"not_found","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Payment not found","status":404}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"}},"/accounts/{accountUuid}/finances/v2/payments/{paymentUuid}/payment-order-files":{"get":{"tags":["finances_bank-files"],"summary":"Get payment orders for payment","description":"Get payment order files for the given payment","operationId":"finances_list_payment_order_files_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Payment order file resource","properties":{"uuid":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date"},"availableUntil":{"type":"string","format":"date"},"bankAccountIban":{"type":"string"},"bankAccountDescription":{"type":"string"}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"ee703da0c6c953ad2689214c0ced08a3","x-required-scopes":["finances"]}},"/accounts/{accountUuid}/finances/v2/payments/{paymentUuid}/actions/{actionKey}":{"patch":{"tags":["finances_payments"],"summary":"Execute payment action","description":"Execute an action on a payment (e.g., archive, restore, sync, resync, markFinished)","operationId":"finances_update_actions","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"actionKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"207eb2dca1f98c051d21700e6b07edd5","x-required-scopes":["finances"],"x-badge":"beta"}},"/accounts/{accountUuid}/finances/v2/payments/{paymentUuid}/actions/archive":{"patch":{"tags":["finances_payments"],"summary":"Archive payment","description":"Archive the given payment","operationId":"6a33e3a7e1a5f689ad96aa143d6e8268","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","description":"Uuid of the payment to archive","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Payment archived","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Bad Request":{"summary":"Bad Request","value":{"detail":[],"type":"validation_error","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Bad request or validation error","status":400}}}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Not found":{"summary":"Not found","value":{"detail":[],"type":"not_found","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Payment not found","status":404}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"}},"/accounts/{accountUuid}/finances/v2/payments/{paymentUuid}/actions/cancel":{"patch":{"tags":["finances_payments"],"summary":"Cancel payment","description":"Cancel the given payment","operationId":"42572e49aebfa769013267db5c56ba37","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","description":"Uuid of the payment to cancel","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Payment cancelled","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Bad Request":{"summary":"Bad Request","value":{"detail":[],"type":"validation_error","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Bad request or validation error","status":400}}}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Not found":{"summary":"Not found","value":{"detail":[],"type":"not_found","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Payment not found","status":404}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"}},"/accounts/{accountUuid}/finances/v2/payments/{paymentUuid}/actions/delete":{"patch":{"tags":["finances_payments"],"summary":"Delete payment","description":"Delete the given payment","operationId":"ffdb7785e12dce1b93cb490add503913","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","description":"Uuid of the payment to delete.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Payment deleted","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Bad Request":{"summary":"Bad Request","value":{"detail":[],"type":"validation_error","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Bad request or validation error","status":400}}}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Not found":{"summary":"Not found","value":{"detail":[],"type":"not_found","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Payment not found","status":404}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"}},"/accounts/{accountUuid}/finances/v2/payments/{paymentUuid}/actions/restore":{"patch":{"tags":["finances_payments"],"summary":"Restore payment","description":"Restore the given payment from the archive","operationId":"73841d88951610e2951e0b03554bbc0f","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","description":"Uuid of the payment to restore","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Payment restored","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Bad Request":{"summary":"Bad Request","value":{"detail":[],"type":"validation_error","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Bad request or validation error","status":400}}}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Not found":{"summary":"Not found","value":{"detail":[],"type":"not_found","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Payment not found","status":404}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"}},"/accounts/{accountUuid}/finances/v2/payments/{paymentUuid}/actions/resync":{"patch":{"tags":["finances_payments"],"summary":"Resync payment","description":"Resend the given payment to the linked Abacus installation","operationId":"fb54d4278f11b4e03da1d91d1e2d4c32","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","description":"Uuid of the payment to resync","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Payment queued for resync","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Bad Request":{"summary":"Bad Request","value":{"detail":[],"type":"validation_error","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Bad request or validation error","status":400}}}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Not found":{"summary":"Not found","value":{"detail":[],"type":"not_found","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Payment not found","status":404}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"}},"/accounts/{accountUuid}/finances/v2/payments/{paymentUuid}/actions/sync":{"patch":{"tags":["finances_payments"],"summary":"Sync payment","description":"Send the given payment to the linked Abacus installation","operationId":"5df280482537e06f70077c193aa9b833","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","description":"Uuid of the payment to restore","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Payment queued for sync","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Bad Request":{"summary":"Bad Request","value":{"detail":[],"type":"validation_error","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Bad request or validation error","status":400}}}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Not found":{"summary":"Not found","value":{"detail":[],"type":"not_found","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Payment not found","status":404}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"}},"/accounts/{accountUuid}/finances/v2/payments/{paymentUuid}/actions/undo_cancel":{"patch":{"tags":["finances_payments"],"summary":"Undo cancel payment","description":"Undo a previously executed cancel of the given payment","operationId":"2069eb6f01fdd0451d6aa485d2f00b55","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","description":"Uuid of the payment to revert the cancellation","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Payment cancellation reverted","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Bad Request":{"summary":"Bad Request","value":{"detail":[],"type":"validation_error","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Bad request or validation error","status":400}}}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Not found":{"summary":"Not found","value":{"detail":[],"type":"not_found","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Payment not found","status":404}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"}},"/accounts/{accountUuid}/finances/v2/payments/{paymentUuid}/attachments/{attachmentUuid}":{"delete":{"tags":["finances_payments"],"summary":"delete attachment","description":"delete an attachment of the payment","operationId":"925e7d75f10065d3ec9c59bb79063a4f","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","description":"the uuid of the payment which the attachment is connected to","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"attachmentUuid","in":"path","description":"the uuid of the attachment to delete","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create payment","required":true,"content":{"application/json":{"schema":{"type":"object","description":"Schema: payment.schema"}}}},"responses":{"200":{"description":"Attachment deleted","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Bad Request":{"summary":"Bad Request","value":{"detail":[],"type":"validation_error","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Bad request or validation error","status":400}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Not found":{"summary":"Not found","value":{"detail":[],"type":"not_found","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Resource not found","status":404}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"}},"/accounts/{accountUuid}/finances/v2/bank-files/{bankFileUuid}/entries/{bankFileEntryUuid}/payment":{"get":{"tags":["finances_bank-files"],"summary":"Get bank file entry payment","description":"Get a single bank file entry payment","operationId":"finances_list_payment","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"bankFileUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"bankFileEntryUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Bank File Entry Payment Resource","properties":{"paymentUuid":{"type":"string","format":"uuid"},"paymentId":{"type":"integer","deprecated":true}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"351a5a46e47f24505d5ed20afc152f94","x-required-scopes":["finances"]}},"/accounts/{accountUuid}/holidays/v2/holidays":{"get":{"tags":["holidays_holidays"],"summary":"Get all holidays","description":"Get all holidays for an account","operationId":"holidays_list_holidays","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"year","in":"query","required":false,"schema":{"type":["integer","null"],"maximum":9999,"minimum":1000}},{"name":"date","in":"query","required":false,"schema":{"type":["string","null"],"format":"date"}},{"name":"countryCode","in":"query","required":true,"schema":{"type":"string","format":"iso-3166-alpha-2","example":"CH","enum":["AT","FR","DE","IT","LI","CH"]}},{"name":"state","in":"query","required":false,"schema":{"type":["string","null"],"format":"date","maxLength":6,"minLength":2}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Holiday Resource","properties":{"uuid":{"type":["string","null"],"format":"uuid"},"date":{"type":"string","format":"date"},"halfDay":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"name":{"type":"string"}},"type":"object"},"en":{"properties":{"name":{"type":"string"}},"type":"object"},"fr":{"properties":{"name":{"type":"string"}},"type":"object"},"it":{"properties":{"name":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers","https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"6265cd9a54f2ba727e2b2fa6bacec087","x-required-scopes":["customers","time-tracking"]},"post":{"tags":["holidays_holidays"],"summary":"Create custom holiday","description":"Create a custom holiday for an account","operationId":"holidays_create_holidays","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create custom holiday","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/holiday-custom.schema.json","description":"A Schema for creating/updating custom holidays in AbaNinja over API","type":"object","properties":{"date":{"type":"string","format":"date"},"countryCode":{"type":"string","minLength":2,"maxLength":2},"state":{"type":"string","minLength":1,"maxLength":6},"halfDay":{"type":"boolean"},"translations":{"type":"object","properties":{"de":{"type":"object","properties":{"name":{"type":["string","null"],"maxLength":255}}},"en":{"type":"object","properties":{"name":{"type":["string","null"],"maxLength":255}}},"fr":{"type":"object","properties":{"name":{"type":["string","null"],"maxLength":255}}},"it":{"type":"object","properties":{"name":{"type":["string","null"],"maxLength":255}}}},"required":["de","en","fr","it"]}},"required":["date","countryCode","state","halfDay","translations"]}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Custom Holiday Resource","properties":{"uuid":{"type":"string","format":"uuid"},"date":{"type":"string","format":"date"},"halfDay":{"type":"boolean"},"countryCode":{"type":"string","format":"iso-3166-alpha-2","example":"CH","maxLength":2,"minLength":2},"state":{"type":["string","null"]},"translations":{"properties":{"de":{"properties":{"name":{"type":"string"}},"type":"object"},"en":{"properties":{"name":{"type":"string"}},"type":"object"},"fr":{"properties":{"name":{"type":"string"}},"type":"object"},"it":{"properties":{"name":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers","https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"bb5ffb52fd57d7d6431860618f9e05e2","x-required-scopes":["customers","time-tracking"]}},"/accounts/{accountUuid}/holidays/v2/settings":{"get":{"tags":["holidays_holiday-settings"],"summary":"Get holiday settings","description":"Get the holiday settings for an account","operationId":"holidays_list_settings","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Holiday Settings Resource","properties":{"useSystemHolidays":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers","https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"97b9d0c0da8390454861199a4b8f7680","x-required-scopes":["customers","time-tracking"]},"patch":{"tags":["holidays_holiday-settings"],"summary":"Update holiday settings","description":"Update the holiday settings for an account","operationId":"holidays_update_settings","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update holiday settings","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/holiday-settings.schema.json","description":"A Schema for updating holiday settings in AbaNinja over API","type":"object","properties":{"useSystemHolidays":{"type":"boolean"}},"required":["useSystemHolidays"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Holiday Settings Resource","properties":{"useSystemHolidays":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers","https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"0a4e538ef06e33dbbdc23ddfb831c8db","x-required-scopes":["customers","time-tracking"]}},"/accounts/{accountUuid}/holidays/v2/holidays/{holidayUuid}":{"get":{"tags":["holidays_holidays"],"summary":"Get custom holiday","description":"Get a custom holiday for an account","operationId":"holidays_get_holidays","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"holidayUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Custom Holiday Resource","properties":{"uuid":{"type":"string","format":"uuid"},"date":{"type":"string","format":"date"},"halfDay":{"type":"boolean"},"countryCode":{"type":"string","format":"iso-3166-alpha-2","example":"CH","maxLength":2,"minLength":2},"state":{"type":["string","null"]},"translations":{"properties":{"de":{"properties":{"name":{"type":"string"}},"type":"object"},"en":{"properties":{"name":{"type":"string"}},"type":"object"},"fr":{"properties":{"name":{"type":"string"}},"type":"object"},"it":{"properties":{"name":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers","https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"df78bc09403871d9f7243f19f4049919","x-required-scopes":["customers","time-tracking"]},"patch":{"tags":["holidays_holidays"],"summary":"Update custom holiday","description":"Update a custom holiday for an account","operationId":"holidays_update_holidays","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"holidayUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update custom holiday","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/holiday-custom.schema.json","description":"A Schema for creating/updating custom holidays in AbaNinja over API","type":"object","properties":{"date":{"type":"string","format":"date"},"countryCode":{"type":"string","minLength":2,"maxLength":2},"state":{"type":"string","minLength":1,"maxLength":6},"halfDay":{"type":"boolean"},"translations":{"type":"object","properties":{"de":{"type":"object","properties":{"name":{"type":["string","null"],"maxLength":255}}},"en":{"type":"object","properties":{"name":{"type":["string","null"],"maxLength":255}}},"fr":{"type":"object","properties":{"name":{"type":["string","null"],"maxLength":255}}},"it":{"type":"object","properties":{"name":{"type":["string","null"],"maxLength":255}}}},"required":["de","en","fr","it"]}},"required":["date","countryCode","state","halfDay","translations"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Custom Holiday Resource","properties":{"uuid":{"type":"string","format":"uuid"},"date":{"type":"string","format":"date"},"halfDay":{"type":"boolean"},"countryCode":{"type":"string","format":"iso-3166-alpha-2","example":"CH","maxLength":2,"minLength":2},"state":{"type":["string","null"]},"translations":{"properties":{"de":{"properties":{"name":{"type":"string"}},"type":"object"},"en":{"properties":{"name":{"type":"string"}},"type":"object"},"fr":{"properties":{"name":{"type":"string"}},"type":"object"},"it":{"properties":{"name":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers","https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"a5d86d03f5c234dbb2ea22548195aa51","x-required-scopes":["customers","time-tracking"]},"delete":{"tags":["holidays_holidays"],"summary":"Delete custom holiday","description":"Delete a custom holiday for an account","operationId":"holidays_delete_holidays","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"holidayUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers","https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"4b7cc7341a1169e75b347ee8535e1ef1","x-required-scopes":["customers","time-tracking"]}},"/accounts/{accountUuid}/holidays/v2/holidays/countries":{"get":{"tags":["holidays_holidays"],"summary":"Get countries","description":"Get available holiday countries for an account","operationId":"holidays_list_countries","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Country Resource","properties":{"code":{"type":"string"},"name":{"type":"string"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers","https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"7d297b1117f33e3f77448d538c7c6da8","x-required-scopes":["customers","time-tracking"]}},"/accounts/{accountUuid}/holidays/v2/settings/convert":{"post":{"tags":["holidays_holiday-settings"],"summary":"Convert system holidays","description":"Convert the system holidays for an account","operationId":"holidays_create_convert","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Convert system holidays","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/holiday-convert.schema.json","description":"A Schema for converting system holidays to custom holidays in AbaNinja over API","type":"object","properties":{"year":{"type":"integer"},"countryCode":{"type":"string","minLength":2,"maxLength":2},"state":{"type":"string","minLength":1,"maxLength":6}},"required":["year","countryCode","state"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers","https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"28c9a1c8aa8c612832f5fbb5c8e97896","x-required-scopes":["customers","time-tracking"]}},"/accounts/{accountUuid}/holidays/v2/holidays/countries/{countryCode}/states":{"get":{"tags":["holidays_holidays"],"summary":"Get states","description":"Get available holiday states for an account","operationId":"holidays_list_states","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"countryCode","in":"path","required":true,"schema":{"type":"string","format":"iso-3166-alpha-2","example":"CH","enum":["AT","FR","DE","IT","LI","CH"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"State Resource","properties":{"code":{"type":"string"},"name":{"type":"string"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers","https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"784df3a3042bc82a069aec0cc5569a8a","x-required-scopes":["customers","time-tracking"]}},"/accounts/{accountUuid}/members/v2/member-groups":{"get":{"tags":["members_member-groups"],"summary":"Get member groups","description":"Get the member groups","operationId":"members_list_member_groups_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Member Group Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"description":"Hexadecimal color","type":"string"}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/members"]}],"x-legacy-operation-id":"fe2192b12051a15a90cbc50aca18b65c","x-required-scopes":["members"]},"post":{"tags":["members_member-groups"],"summary":"Create member group","description":"Create a new member group","operationId":"members_create_member_groups","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create member group","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/member-group.create.schema.json","description":"A schema for creating a member group","type":"object","additionalProperties":false,"properties":{"name":{"type":["string"],"minLength":1,"maxLength":255},"color":{"type":["string"],"pattern":"^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$"}},"required":["name","color"]}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Member Group Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"description":"Hexadecimal color","type":"string"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/members"]}],"x-legacy-operation-id":"99b267372c8dc0c54f1d935c67ce72cb","x-required-scopes":["members"]}},"/accounts/{accountUuid}/members/v2/members":{"get":{"tags":["members_members"],"summary":"Get members","description":"Get the members","operationId":"members_list_members","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Member Resource","properties":{"uuid":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"user":{"properties":{"uuid":{"type":"string","format":"uuid"},"email":{"type":["string","null"],"format":"email"}},"type":["object","null"]},"address":{"properties":{"uuid":{"type":"string","format":"uuid"},"customerNumber":{"type":["string","null"]}},"type":["object","null"]},"memberGroups":{"type":"array","items":{"properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"description":"Hexadecimal color","type":"string"}},"type":"object"}},"memberships":{"type":"array","items":{"properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"description":"Hexadecimal color","type":"string"}},"type":"object"}}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/members"]}],"x-legacy-operation-id":"ea4fdf534d265a277360fee191e3dd58","x-required-scopes":["members"]},"post":{"tags":["members_members"],"summary":"Create member","description":"Create a new member","operationId":"members_create_members","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create member","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/member.create.schema.json","description":"A schema for creating a member","type":"object","additionalProperties":false,"properties":{"firstName":{"type":["string"],"minLength":1,"maxLength":255},"lastName":{"type":["string"],"minLength":1,"maxLength":255},"userUuid":{"type":["string","null"],"format":"uuid"},"addressUuid":{"type":["string","null"],"format":"uuid"},"memberGroups":{"type":["array"],"minItems":0,"maxItems":20,"items":{"type":["string"],"format":"uuid"}},"memberships":{"type":["array"],"minItems":0,"maxItems":1,"items":{"type":["string"],"format":"uuid"}}},"required":["firstName","lastName"]}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Member Resource","properties":{"uuid":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"user":{"properties":{"uuid":{"type":"string","format":"uuid"},"email":{"type":["string","null"],"format":"email"}},"type":["object","null"]},"address":{"properties":{"uuid":{"type":"string","format":"uuid"},"customerNumber":{"type":["string","null"]}},"type":["object","null"]},"memberGroups":{"type":"array","items":{"properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"description":"Hexadecimal color","type":"string"}},"type":"object"}},"memberships":{"type":"array","items":{"properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"description":"Hexadecimal color","type":"string"}},"type":"object"}}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/members"]}],"x-legacy-operation-id":"603bdd96e416535a9c922edfaf470e3d","x-required-scopes":["members"]}},"/accounts/{accountUuid}/members/v2/memberships":{"get":{"tags":["members_memberships"],"summary":"Get memberships","description":"Get the memberships","operationId":"members_list_memberships_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Membership Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"description":"Hexadecimal color","type":"string"},"invoiceTemplateUuid":{"type":["string","null"],"format":"uuid"}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/members"]}],"x-legacy-operation-id":"551b612d8fc00c7c383bf05407046885","x-required-scopes":["members"]},"post":{"tags":["members_memberships"],"summary":"Create membership","description":"Create a new membership","operationId":"members_create_memberships","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create membership","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/membership.create.schema.json","description":"A schema for creating a membership","type":"object","additionalProperties":false,"properties":{"name":{"type":["string"],"minLength":1,"maxLength":255},"color":{"type":["string"],"pattern":"^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$"},"invoiceTemplateUuid":{"type":["string","null"],"format":"uuid"}},"required":["name","color"]}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Membership Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"description":"Hexadecimal color","type":"string"},"invoiceTemplateUuid":{"type":["string","null"],"format":"uuid"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/members"]}],"x-legacy-operation-id":"96555f09689d26bc907dbf9e9810556a","x-required-scopes":["members"]}},"/accounts/{accountUuid}/members/v2/member-groups/{memberGroupUuid}":{"get":{"tags":["members_member-groups"],"summary":"Get member group","description":"Get a member group","operationId":"members_get_member_groups","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"memberGroupUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Member Group Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"description":"Hexadecimal color","type":"string"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/members"]}],"x-legacy-operation-id":"767a0ce2721126d4ec2c33db103a10be","x-required-scopes":["members"]},"patch":{"tags":["members_member-groups"],"summary":"Update member group","description":"Update a member group","operationId":"members_update_member_groups_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"memberGroupUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update member group","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/member-group.update.schema.json","description":"A schema for updating a member group","type":"object","minProperties":1,"additionalProperties":false,"properties":{"name":{"type":["string"],"minLength":1,"maxLength":255},"color":{"type":["string"],"pattern":"^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$"}},"required":[]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Member Group Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"description":"Hexadecimal color","type":"string"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/members"]}],"x-legacy-operation-id":"ece9f2baec0452ee133163a7e893b5d6","x-required-scopes":["members"]},"delete":{"tags":["members_member-groups"],"summary":"Delete member group","description":"Delete a member group","operationId":"members_delete_member_groups","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"memberGroupUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/members"]}],"x-legacy-operation-id":"fb68e14cb896f5db19de8e62bfe8acc7","x-required-scopes":["members"]}},"/accounts/{accountUuid}/members/v2/members/{memberUuid}":{"get":{"tags":["members_members"],"summary":"Get member","description":"Get a member","operationId":"members_get_members","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"memberUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Member Resource","properties":{"uuid":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"user":{"properties":{"uuid":{"type":"string","format":"uuid"},"email":{"type":["string","null"],"format":"email"}},"type":["object","null"]},"address":{"properties":{"uuid":{"type":"string","format":"uuid"},"customerNumber":{"type":["string","null"]}},"type":["object","null"]},"memberGroups":{"type":"array","items":{"properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"description":"Hexadecimal color","type":"string"}},"type":"object"}},"memberships":{"type":"array","items":{"properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"description":"Hexadecimal color","type":"string"}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/members"]}],"x-legacy-operation-id":"ae6e36a93ca6d2165e3dc7e09bb4ef29","x-required-scopes":["members"]},"patch":{"tags":["members_members"],"summary":"Update member","description":"Update a member","operationId":"members_update_members","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"memberUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update member","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/member.update.schema.json","description":"A schema for updating a member","type":"object","minProperties":1,"additionalProperties":false,"properties":{"firstName":{"type":["string"],"minLength":1,"maxLength":255},"lastName":{"type":["string"],"minLength":1,"maxLength":255},"userUuid":{"type":["string","null"],"format":"uuid"},"addressUuid":{"type":["string","null"],"format":"uuid"}},"required":[]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Member Resource","properties":{"uuid":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"user":{"properties":{"uuid":{"type":"string","format":"uuid"},"email":{"type":["string","null"],"format":"email"}},"type":["object","null"]},"address":{"properties":{"uuid":{"type":"string","format":"uuid"},"customerNumber":{"type":["string","null"]}},"type":["object","null"]},"memberGroups":{"type":"array","items":{"properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"description":"Hexadecimal color","type":"string"}},"type":"object"}},"memberships":{"type":"array","items":{"properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"description":"Hexadecimal color","type":"string"}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/members"]}],"x-legacy-operation-id":"5e32a728f2adb4d53f2ab3fef4cab1a6","x-required-scopes":["members"]},"delete":{"tags":["members_members"],"summary":"Delete member","description":"Delete a member","operationId":"members_delete_members","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"memberUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/members"]}],"x-legacy-operation-id":"ad4cb3ff718ad63cb872dc07dd620dee","x-required-scopes":["members"]}},"/accounts/{accountUuid}/members/v2/memberships/{membershipUuid}":{"get":{"tags":["members_memberships"],"summary":"Get membership","description":"Get a membership","operationId":"members_get_memberships","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"membershipUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Membership Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"description":"Hexadecimal color","type":"string"},"invoiceTemplateUuid":{"type":["string","null"],"format":"uuid"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/members"]}],"x-legacy-operation-id":"736a394a34d4c657b7e038a15f5b4635","x-required-scopes":["members"]},"patch":{"tags":["members_memberships"],"summary":"Update membership","description":"Update a membership","operationId":"members_update_memberships_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"membershipUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update membership","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/membership.update.schema.json","description":"A schema for updating a membership","type":"object","minProperties":1,"additionalProperties":false,"properties":{"name":{"type":["string"],"minLength":1,"maxLength":255},"color":{"type":["string"],"pattern":"^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$"},"invoiceTemplateUuid":{"type":["string","null"],"format":"uuid"}},"required":[]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Membership Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"description":"Hexadecimal color","type":"string"},"invoiceTemplateUuid":{"type":["string","null"],"format":"uuid"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/members"]}],"x-legacy-operation-id":"d151fe7e4c3514507379e0fbc6813637","x-required-scopes":["members"]},"delete":{"tags":["members_memberships"],"summary":"Delete membership","description":"Delete a membership","operationId":"members_delete_memberships","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"membershipUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/members"]}],"x-legacy-operation-id":"bd373a6cdd47b3f4a8efd634149d460a","x-required-scopes":["members"]}},"/accounts/{accountUuid}/members/v2/members/{memberUuid}/member-groups":{"get":{"tags":["members_members"],"summary":"Get member group assignments","description":"Get the member group assignments for a member","operationId":"members_list_member_groups","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"memberUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Member Group Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"description":"Hexadecimal color","type":"string"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/members"]}],"x-legacy-operation-id":"172d9cd7072e6017ed56844cb3b018a0","x-required-scopes":["members"]},"put":{"tags":["members_members"],"summary":"Set member group assignments","description":"Set the member group assignments for a member","operationId":"members_update_member_groups","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"memberUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Set member groups","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/member-set-member-groups.schema.json","description":"A schema for setting member groups on a member","type":"object","additionalProperties":false,"properties":{"memberGroups":{"type":["array"],"minItems":0,"maxItems":20,"items":{"type":["string"],"format":"uuid"}}},"required":["memberGroups"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Member Group Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"description":"Hexadecimal color","type":"string"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/members"]}],"x-legacy-operation-id":"7fc465b477274d42be3f49071df32dfd","x-required-scopes":["members"]}},"/accounts/{accountUuid}/members/v2/members/{memberUuid}/memberships":{"get":{"tags":["members_members"],"summary":"Get membership assignments","description":"Get the membership assignments for a member","operationId":"members_list_memberships","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"memberUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Membership Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"description":"Hexadecimal color","type":"string"},"invoiceTemplateUuid":{"type":["string","null"],"format":"uuid"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/members"]}],"x-legacy-operation-id":"8558ae47f308a813eba95d85170bcb1f","x-required-scopes":["members"]},"put":{"tags":["members_members"],"summary":"Set membership assignments","description":"Set the membership assignments for a member","operationId":"members_update_memberships","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"memberUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Set memberships","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/member-set-memberships.schema.json","description":"A schema for setting memberships on a member","type":"object","minProperties":1,"additionalProperties":false,"properties":{"memberships":{"type":["array"],"minItems":0,"maxItems":1,"items":{"type":["string"],"format":"uuid"}}},"required":["memberships"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Membership Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"description":"Hexadecimal color","type":"string"},"invoiceTemplateUuid":{"type":["string","null"],"format":"uuid"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/members"]}],"x-legacy-operation-id":"815e904da9f58b43f966c9c56e3a08fd","x-required-scopes":["members"]}},"/accounts/{accountUuid}/products/v2/product-groups":{"get":{"tags":["products_product-groups"],"summary":"Get product groups","description":"Get all product groups","operationId":"products_list_product_groups","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"groupNumber","in":"query","description":"groupNumber to search for","required":false,"schema":{"type":"integer"}},{"name":"onlyArchived","in":"query","description":"if true only archived items are returend","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Product Group Resource","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"integer","format":"int64","deprecated":true},"groupNumber":{"type":"integer","format":"int64"},"bookingAccountNumber":{"type":["string","null"]},"isArchived":{"type":"boolean"},"isDeletable":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"description":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"060d55444f77a3086a503ba1777aed59","x-required-scopes":["products"]},"post":{"tags":["products_product-groups"],"summary":"Create product group","description":"Create a new product group","operationId":"products_create_product_groups","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Product group body","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/product-group.schema.json","description":"A Schema for create/update product group in AbaNinja over API","type":"object","properties":{"groupNumber":{"type":"integer"},"bookingAccountNumber":{"type":["null","string"]},"translations":{"type":"object","properties":{"de":{"type":"object","properties":{"description":{"type":"string","maxLength":255}}},"en":{"type":"object","properties":{"description":{"type":"string","maxLength":255}}},"fr":{"type":"object","properties":{"description":{"type":"string","maxLength":255}}},"it":{"type":"object","properties":{"description":{"type":"string","maxLength":255}}}},"required":["de","en","fr","it"]}},"required":["groupNumber","translations","bookingAccountNumber"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Product Group Resource","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"integer","format":"int64","deprecated":true},"groupNumber":{"type":"integer","format":"int64"},"bookingAccountNumber":{"type":["string","null"]},"isArchived":{"type":"boolean"},"isDeletable":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"description":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"38b8cb6a4999840925313ca33139d958","x-required-scopes":["products"]}},"/accounts/{accountUuid}/products/v2/products":{"get":{"tags":["products_products"],"summary":"Get products","description":"Return all products","operationId":"products_list_products","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}},{"name":"limit","in":"query","description":"use perPage instead","required":false,"deprecated":true,"schema":{"type":["integer","null"],"minimum":1}},{"name":"productKey","in":"query","required":false,"schema":{"description":"filter for productKey","type":["string","null"]}},{"name":"isArchived","in":"query","required":false,"schema":{"description":"if true only archived products are returned","type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Product Resource","properties":{"uuid":{"type":"string","format":"uuid"},"productId":{"description":"use uuid instead","type":"integer","format":"int64","deprecated":true},"productUuid":{"description":"use uuid instead","type":"string","format":"uuid","deprecated":true},"productKey":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"},"isInclusive":{"description":"if prices are inclusive tax","type":"boolean"},"isService":{"description":"if it is a service or else a product","type":"boolean"},"eanCode":{"type":["string","null"]},"productUnit":{"properties":{"id":{"type":"integer","format":"int64","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isocode":{"type":["string","null"]},"translations":{"properties":{"de":{"properties":{"unit":{"type":"string"},"description":{"type":"string"},"text":{"description":"Combines unit and description","type":"string"},"unitPlural":{"type":["string","null"]}},"type":"object"},"en":{"properties":{"unit":{"type":"string"},"description":{"type":"string"},"text":{"description":"Combines unit and description","type":"string"},"unitPlural":{"type":["string","null"]}},"type":"object"},"fr":{"properties":{"unit":{"type":"string"},"description":{"type":"string"},"text":{"description":"Combines unit and description","type":"string"},"unitPlural":{"type":["string","null"]}},"type":"object"},"it":{"properties":{"unit":{"type":"string"},"description":{"type":"string"},"text":{"description":"Combines unit and description","type":"string"},"unitPlural":{"type":["string","null"]}},"type":"object"}},"type":"object"}},"type":["object","null"]},"productGroup":{"properties":{"productGroupId":{"type":"integer","format":"int64","deprecated":true},"productGroupUuid":{"type":"string","format":"uuid"},"productGroupNumber":{"type":"integer","format":"int64"},"productGroupDescription":{"type":"string"},"productGroupBookingAccountNumber":{"type":"integer","format":"int64"},"productGroupBookingAccountId":{"type":["integer","null"],"format":"int64"}},"type":["object","null"]},"tags":{"type":"array","items":{"type":"string"}},"properties":{"type":"array","items":{"title":"Product Property Resource","properties":{"id":{"type":"integer","format":"int64"},"type":{"type":"string","enum":["weight","width","height","length","volume"]},"value":{"type":"number"},"isocode":{"type":"string"},"translations":{"properties":{"de":{"properties":{"description":{"type":"string"},"unit":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":"string"},"unit":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":"string"},"unit":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":"string"},"unit":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}},"cost":{"description":"Price of a single item","type":"number"},"taxRate":{"type":["number","null"]},"taxRateUuid":{"type":["string","null"],"format":"uuid"},"bookingAccountNumber":{"type":["string","null"]},"hasImage":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"productName":{"type":"string"},"productDescription":{"type":"string"}},"type":"object"},"en":{"properties":{"productName":{"type":"string"},"productDescription":{"type":"string"}},"type":"object"},"fr":{"properties":{"productName":{"type":"string"},"productDescription":{"type":"string"}},"type":"object"},"it":{"properties":{"productName":{"type":"string"},"productDescription":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"7e5261f234fa115780165a03aaebd308","x-required-scopes":["products"]},"post":{"tags":["products_products"],"summary":"Create product","description":"Create a new product or service","operationId":"products_create_products","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Product body","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/product.create.schema.json","description":"A Schema for creating a product in AbaNinja over API","type":"object","properties":{"productKey":{"type":"string","maxLength":30},"productGroupUuid":{"type":["null","string"],"format":"uuid"},"productGroupNumber":{"deprecated":true,"description":"use productGroupUuid instead","type":["null","number"]},"isService":{"type":"boolean"},"tags":{"type":"array","items":{"type":"string"},"maxItems":100},"translations":{"type":"object","properties":{"de":{"type":"object","properties":{"productName":{"type":"string","maxLength":255},"productDescription":{"type":"string","maxLength":2000}}},"en":{"type":"object","properties":{"productName":{"type":"string","maxLength":255},"productDescription":{"type":"string","maxLength":2000}}},"fr":{"type":"object","properties":{"productName":{"type":"string","maxLength":255},"productDescription":{"type":"string","maxLength":2000}}},"it":{"type":"object","properties":{"productName":{"type":"string","maxLength":255},"productDescription":{"type":"string","maxLength":2000}}}}},"properties":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["weight","width","height","length","volume"]},"value":{"type":["null","number"]},"isocode":{"type":"string"}},"required":["type","value","isocode"]}},"eanCode":{"type":["null","string"],"maxLength":13},"unitUuid":{"type":"string","format":"uuid"},"cost":{"type":"number"},"taxRate":{"deprecated":true,"description":"Tax rate to use as default for this product. Use \"taxRateUuid\" instead.","type":["null","number"]},"taxRateType":{"deprecated":true,"description":"The type of the tax rate to find. Only used in combination with \"taxRate\".","type":["null","string"],"enum":[null,"NORMAL","ACQUISITION","NOT_RELEVANT"],"default":"NORMAL"},"taxRateUuid":{"type":["null","string"],"format":"uuid"},"bookingAccountNumber":{"deprecated":true,"description":"use bookingAccountUuid instead","type":["null","string"]},"bookingAccountUuid":{"type":["null","string"],"format":"uuid"}},"required":["isService","translations","unitUuid","cost"]}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Product Resource","properties":{"uuid":{"type":"string","format":"uuid"},"productId":{"description":"use uuid instead","type":"integer","format":"int64","deprecated":true},"productUuid":{"description":"use uuid instead","type":"string","format":"uuid","deprecated":true},"productKey":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"},"isInclusive":{"description":"if prices are inclusive tax","type":"boolean"},"isService":{"description":"if it is a service or else a product","type":"boolean"},"eanCode":{"type":["string","null"]},"productUnit":{"properties":{"id":{"type":"integer","format":"int64","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isocode":{"type":["string","null"]},"translations":{"properties":{"de":{"properties":{"unit":{"type":"string"},"description":{"type":"string"},"text":{"description":"Combines unit and description","type":"string"},"unitPlural":{"type":["string","null"]}},"type":"object"},"en":{"properties":{"unit":{"type":"string"},"description":{"type":"string"},"text":{"description":"Combines unit and description","type":"string"},"unitPlural":{"type":["string","null"]}},"type":"object"},"fr":{"properties":{"unit":{"type":"string"},"description":{"type":"string"},"text":{"description":"Combines unit and description","type":"string"},"unitPlural":{"type":["string","null"]}},"type":"object"},"it":{"properties":{"unit":{"type":"string"},"description":{"type":"string"},"text":{"description":"Combines unit and description","type":"string"},"unitPlural":{"type":["string","null"]}},"type":"object"}},"type":"object"}},"type":["object","null"]},"productGroup":{"properties":{"productGroupId":{"type":"integer","format":"int64","deprecated":true},"productGroupUuid":{"type":"string","format":"uuid"},"productGroupNumber":{"type":"integer","format":"int64"},"productGroupDescription":{"type":"string"},"productGroupBookingAccountNumber":{"type":"integer","format":"int64"},"productGroupBookingAccountId":{"type":["integer","null"],"format":"int64"}},"type":["object","null"]},"tags":{"type":"array","items":{"type":"string"}},"properties":{"type":"array","items":{"title":"Product Property Resource","properties":{"id":{"type":"integer","format":"int64"},"type":{"type":"string","enum":["weight","width","height","length","volume"]},"value":{"type":"number"},"isocode":{"type":"string"},"translations":{"properties":{"de":{"properties":{"description":{"type":"string"},"unit":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":"string"},"unit":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":"string"},"unit":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":"string"},"unit":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}},"cost":{"description":"Price of a single item","type":"number"},"taxRate":{"type":["number","null"]},"taxRateUuid":{"type":["string","null"],"format":"uuid"},"bookingAccountNumber":{"type":["string","null"]},"hasImage":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"productName":{"type":"string"},"productDescription":{"type":"string"}},"type":"object"},"en":{"properties":{"productName":{"type":"string"},"productDescription":{"type":"string"}},"type":"object"},"fr":{"properties":{"productName":{"type":"string"},"productDescription":{"type":"string"}},"type":"object"},"it":{"properties":{"productName":{"type":"string"},"productDescription":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"339f5b8f99b40edf0116950d529b8966","x-required-scopes":["products"]}},"/accounts/{accountUuid}/products/{productUuid}/suppliers/{supplierUuid}":{"delete":{"tags":["products_product-suppliers"],"summary":"Delete supplier","description":"Deletes a supplier of a product","operationId":"products_delete_suppliers","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"supplierUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"b57e0568a5ea730549fd0758a8471c07","x-required-scopes":["products"]}},"/accounts/{accountUuid}/products/v2/product-groups/{productGroupUuid}":{"get":{"tags":["products_product-groups"],"summary":"Get product group","description":"Get a single product group","operationId":"products_get_product_groups","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productGroupUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"onlyArchived","in":"query","description":"if true only archived items are returend","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Product Group Resource","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"integer","format":"int64","deprecated":true},"groupNumber":{"type":"integer","format":"int64"},"bookingAccountNumber":{"type":["string","null"]},"isArchived":{"type":"boolean"},"isDeletable":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"description":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"6506f14a9b3be07dd866b8f95bf7f51b","x-required-scopes":["products"]},"patch":{"tags":["products_product-groups"],"summary":"Update product group","description":"Update a new product group","operationId":"products_update_product_groups","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productGroupUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Product group body","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/product-group.schema.json","description":"A Schema for create/update product group in AbaNinja over API","type":"object","properties":{"groupNumber":{"type":"integer"},"bookingAccountNumber":{"type":["null","string"]},"translations":{"type":"object","properties":{"de":{"type":"object","properties":{"description":{"type":"string","maxLength":255}}},"en":{"type":"object","properties":{"description":{"type":"string","maxLength":255}}},"fr":{"type":"object","properties":{"description":{"type":"string","maxLength":255}}},"it":{"type":"object","properties":{"description":{"type":"string","maxLength":255}}}},"required":["de","en","fr","it"]}},"required":["groupNumber","translations","bookingAccountNumber"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Product Group Resource","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"integer","format":"int64","deprecated":true},"groupNumber":{"type":"integer","format":"int64"},"bookingAccountNumber":{"type":["string","null"]},"isArchived":{"type":"boolean"},"isDeletable":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"description":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"199672db384c0d6da6f9eb7f57612109","x-required-scopes":["products"]},"delete":{"tags":["products_product-groups"],"summary":"Delete product group","description":"Delete a product group","operationId":"products_delete_product_groups","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productGroupUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"27129b2728c6021d96f0b81f0e446950","x-required-scopes":["products"]}},"/accounts/{accountUuid}/products/v2/products/{productUuid}":{"get":{"tags":["products_products"],"summary":"Get product","description":"Get a single product","operationId":"products_get_products","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Product Resource","properties":{"uuid":{"type":"string","format":"uuid"},"productId":{"description":"use uuid instead","type":"integer","format":"int64","deprecated":true},"productUuid":{"description":"use uuid instead","type":"string","format":"uuid","deprecated":true},"productKey":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"},"isInclusive":{"description":"if prices are inclusive tax","type":"boolean"},"isService":{"description":"if it is a service or else a product","type":"boolean"},"eanCode":{"type":["string","null"]},"productUnit":{"properties":{"id":{"type":"integer","format":"int64","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isocode":{"type":["string","null"]},"translations":{"properties":{"de":{"properties":{"unit":{"type":"string"},"description":{"type":"string"},"text":{"description":"Combines unit and description","type":"string"},"unitPlural":{"type":["string","null"]}},"type":"object"},"en":{"properties":{"unit":{"type":"string"},"description":{"type":"string"},"text":{"description":"Combines unit and description","type":"string"},"unitPlural":{"type":["string","null"]}},"type":"object"},"fr":{"properties":{"unit":{"type":"string"},"description":{"type":"string"},"text":{"description":"Combines unit and description","type":"string"},"unitPlural":{"type":["string","null"]}},"type":"object"},"it":{"properties":{"unit":{"type":"string"},"description":{"type":"string"},"text":{"description":"Combines unit and description","type":"string"},"unitPlural":{"type":["string","null"]}},"type":"object"}},"type":"object"}},"type":["object","null"]},"productGroup":{"properties":{"productGroupId":{"type":"integer","format":"int64","deprecated":true},"productGroupUuid":{"type":"string","format":"uuid"},"productGroupNumber":{"type":"integer","format":"int64"},"productGroupDescription":{"type":"string"},"productGroupBookingAccountNumber":{"type":"integer","format":"int64"},"productGroupBookingAccountId":{"type":["integer","null"],"format":"int64"}},"type":["object","null"]},"tags":{"type":"array","items":{"type":"string"}},"properties":{"type":"array","items":{"title":"Product Property Resource","properties":{"id":{"type":"integer","format":"int64"},"type":{"type":"string","enum":["weight","width","height","length","volume"]},"value":{"type":"number"},"isocode":{"type":"string"},"translations":{"properties":{"de":{"properties":{"description":{"type":"string"},"unit":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":"string"},"unit":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":"string"},"unit":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":"string"},"unit":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}},"cost":{"description":"Price of a single item","type":"number"},"taxRate":{"type":["number","null"]},"taxRateUuid":{"type":["string","null"],"format":"uuid"},"bookingAccountNumber":{"type":["string","null"]},"hasImage":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"productName":{"type":"string"},"productDescription":{"type":"string"}},"type":"object"},"en":{"properties":{"productName":{"type":"string"},"productDescription":{"type":"string"}},"type":"object"},"fr":{"properties":{"productName":{"type":"string"},"productDescription":{"type":"string"}},"type":"object"},"it":{"properties":{"productName":{"type":"string"},"productDescription":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"3288b4372422a1a6413237d06a0bcb15","x-required-scopes":["products"]},"patch":{"tags":["products_products"],"summary":"Update product","description":"Update a new product or service","operationId":"products_update_products","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Product body","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/product.update.schema.json","description":"A Schema for updating a product in AbaNinja over API","type":"object","properties":{"productKey":{"type":"string","maxLength":30},"productGroupUuid":{"type":["null","string"],"format":"uuid"},"productGroupNumber":{"deprecated":true,"description":"use productGroupUuid instead","type":["null","number"]},"isService":{"type":"boolean"},"tags":{"type":"array","items":{"type":"string"},"maxItems":100},"translations":{"type":"object","properties":{"de":{"type":"object","properties":{"productName":{"type":"string","maxLength":255},"productDescription":{"type":"string","maxLength":2000}}},"en":{"type":"object","properties":{"productName":{"type":"string","maxLength":255},"productDescription":{"type":"string","maxLength":2000}}},"fr":{"type":"object","properties":{"productName":{"type":"string","maxLength":255},"productDescription":{"type":"string","maxLength":2000}}},"it":{"type":"object","properties":{"productName":{"type":"string","maxLength":255},"productDescription":{"type":"string","maxLength":2000}}}}},"properties":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["weight","width","height","length","volume"]},"value":{"type":["null","number"]},"isocode":{"type":"string"}},"required":["type","value","isocode"]}},"eanCode":{"type":["null","string"],"maxLength":13},"unitUuid":{"type":"string","format":"uuid"},"cost":{"type":"number"},"taxRate":{"deprecated":true,"description":"Tax rate to use as default for this product. Use \"taxRateUuid\" instead.","type":["null","number"]},"taxRateType":{"deprecated":true,"description":"The type of the tax rate to find. Only used in combination with \"taxRate\".","type":["null","string"],"enum":[null,"NORMAL","ACQUISITION","NOT_RELEVANT"],"default":"NORMAL"},"taxRateUuid":{"type":["null","string"],"format":"uuid"},"bookingAccountNumber":{"deprecated":true,"description":"use bookingAccountUuid instead","type":["null","string"]},"bookingAccountUuid":{"type":["null","string"],"format":"uuid"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Product Resource","properties":{"uuid":{"type":"string","format":"uuid"},"productId":{"description":"use uuid instead","type":"integer","format":"int64","deprecated":true},"productUuid":{"description":"use uuid instead","type":"string","format":"uuid","deprecated":true},"productKey":{"type":["string","null"]},"archivedAt":{"type":["string","null"],"format":"date-time"},"isInclusive":{"description":"if prices are inclusive tax","type":"boolean"},"isService":{"description":"if it is a service or else a product","type":"boolean"},"eanCode":{"type":["string","null"]},"productUnit":{"properties":{"id":{"type":"integer","format":"int64","deprecated":true},"uuid":{"type":"string","format":"uuid"},"isocode":{"type":["string","null"]},"translations":{"properties":{"de":{"properties":{"unit":{"type":"string"},"description":{"type":"string"},"text":{"description":"Combines unit and description","type":"string"},"unitPlural":{"type":["string","null"]}},"type":"object"},"en":{"properties":{"unit":{"type":"string"},"description":{"type":"string"},"text":{"description":"Combines unit and description","type":"string"},"unitPlural":{"type":["string","null"]}},"type":"object"},"fr":{"properties":{"unit":{"type":"string"},"description":{"type":"string"},"text":{"description":"Combines unit and description","type":"string"},"unitPlural":{"type":["string","null"]}},"type":"object"},"it":{"properties":{"unit":{"type":"string"},"description":{"type":"string"},"text":{"description":"Combines unit and description","type":"string"},"unitPlural":{"type":["string","null"]}},"type":"object"}},"type":"object"}},"type":["object","null"]},"productGroup":{"properties":{"productGroupId":{"type":"integer","format":"int64","deprecated":true},"productGroupUuid":{"type":"string","format":"uuid"},"productGroupNumber":{"type":"integer","format":"int64"},"productGroupDescription":{"type":"string"},"productGroupBookingAccountNumber":{"type":"integer","format":"int64"},"productGroupBookingAccountId":{"type":["integer","null"],"format":"int64"}},"type":["object","null"]},"tags":{"type":"array","items":{"type":"string"}},"properties":{"type":"array","items":{"title":"Product Property Resource","properties":{"id":{"type":"integer","format":"int64"},"type":{"type":"string","enum":["weight","width","height","length","volume"]},"value":{"type":"number"},"isocode":{"type":"string"},"translations":{"properties":{"de":{"properties":{"description":{"type":"string"},"unit":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":"string"},"unit":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":"string"},"unit":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":"string"},"unit":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}},"cost":{"description":"Price of a single item","type":"number"},"taxRate":{"type":["number","null"]},"taxRateUuid":{"type":["string","null"],"format":"uuid"},"bookingAccountNumber":{"type":["string","null"]},"hasImage":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"productName":{"type":"string"},"productDescription":{"type":"string"}},"type":"object"},"en":{"properties":{"productName":{"type":"string"},"productDescription":{"type":"string"}},"type":"object"},"fr":{"properties":{"productName":{"type":"string"},"productDescription":{"type":"string"}},"type":"object"},"it":{"properties":{"productName":{"type":"string"},"productDescription":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"a7d375d6ce207a4865df5fc5d5411562","x-required-scopes":["products"]},"delete":{"tags":["products_products"],"summary":"Delete product","description":"Delete product","operationId":"products_delete_products","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"f005d1ce8297646ffc6993154be0f291","x-required-scopes":["products"]}},"/accounts/{accountUuid}/products/v2/products/{productUuid}/actions":{"get":{"tags":["products_products"],"summary":"Get Actions","description":"Get applicable product actions","operationId":"products_list_actions","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"type":"string","enum":["archive","restore","delete"]}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"7b81f608fce8bbe5804777064d6f946a","x-required-scopes":["products"]}},"/accounts/{accountUuid}/products/v2/products/{productUuid}/attachments":{"get":{"tags":["products_products"],"summary":"Get attachments","description":"Get all attachments of a product","operationId":"products_list_attachments","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Product Attachment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"size":{"type":"integer"},"mimeType":{"type":"string"},"url":{"type":["string","null"],"format":"uri"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"4ae7a5a250fee33cb961eed02e0c06ea","x-required-scopes":["products"]},"post":{"tags":["products_products"],"summary":"Upload attachment","description":"Upload an attachment for a product","operationId":"products_create_attachments","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["file"],"properties":{"file":{"type":"string","format":"binary"}},"type":"object"}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Product Attachment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"size":{"type":"integer"},"mimeType":{"type":"string"},"url":{"type":["string","null"],"format":"uri"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"55728d6dae8adfc66e0f534821241168","x-required-scopes":["products"]}},"/accounts/{accountUuid}/products/v2/products/{productUuid}/comments":{"get":{"tags":["products_products"],"summary":"Get comment collection","description":"fetches comments of a product via pagination","operationId":"products_list_comments","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Product Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"type":"string","enum":["intern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"385f8a3c938bd4501c948dfc1bb3eb50","x-required-scopes":["products"]},"post":{"tags":["products_products"],"summary":"Create comment","description":"creates a new comment on a product for internal use","operationId":"products_create_comments","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Comment to create","required":true,"content":{"application/json":{"schema":{"title":"Create Product Comment Request","required":["comment"],"properties":{"comment":{"type":"string","minLength":3}},"type":"object"}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Product Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"type":"string","enum":["intern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"63ad77f1a6bd30c0928e1852c110a6a5","x-required-scopes":["products"]}},"/accounts/{accountUuid}/products/v2/products/{productUuid}/image":{"get":{"tags":["products_products"],"summary":"Get image","description":"Get the image of a product","operationId":"products_list_image","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Product Attachment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"size":{"type":"integer"},"mimeType":{"type":"string"},"url":{"type":["string","null"],"format":"uri"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"204":{"description":"No image exists"},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"6bc83a5b65239fb10074761bcb13dd40","x-required-scopes":["products"]},"post":{"tags":["products_products"],"summary":"Upload image","description":"Upload an image for a product","operationId":"products_create_image","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["file"],"properties":{"file":{"type":"string","format":"binary"}},"type":"object"}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Product Attachment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"size":{"type":"integer"},"mimeType":{"type":"string"},"url":{"type":["string","null"],"format":"uri"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"a7ac35632b17926564daeaff89a0f5ff","x-required-scopes":["products"]},"delete":{"tags":["products_products"],"summary":"Delete image","description":"Delete the image of a product","operationId":"products_delete_image","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"7747eccef4f9671fd6d580f507a271c3","x-required-scopes":["products"]}},"/accounts/{accountUuid}/products/v2/products/{productUuid}/suppliers":{"get":{"tags":["products_product-suppliers"],"summary":"Get suppliers","description":"Get product suppliers","operationId":"products_list_suppliers","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Product Supplier Resource","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"integer","format":"int64","deprecated":true},"addressUuid":{"type":"string","format":"uuid"},"addressId":{"type":"integer","format":"int64","deprecated":true},"name":{"description":"Name of the address","type":"string"},"productCode":{"type":["string","null"]},"productName":{"type":["string","null"]},"contactName":{"type":["string","null"]},"contactUuid":{"type":["string","null"],"format":"uuid"},"contactId":{"type":["integer","null"],"format":"int64","deprecated":true}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"297e90349ac8247f244037d9ab3921de","x-required-scopes":["products"]},"post":{"tags":["products_product-suppliers"],"summary":"Create supplier","description":"Create a product supplier","operationId":"products_create_suppliers","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Product supplier body","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/product-supplier.schema.json","description":"A Schema for create/update product supplier in AbaNinja over API","type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"contactUuid":{"type":["null","string"],"format":"uuid"},"productCode":{"type":["null","string"],"maxLength":255},"productName":{"type":"string","maxLength":255}},"required":["addressUuid"]}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Product Supplier Resource","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"integer","format":"int64","deprecated":true},"addressUuid":{"type":"string","format":"uuid"},"addressId":{"type":"integer","format":"int64","deprecated":true},"name":{"description":"Name of the address","type":"string"},"productCode":{"type":["string","null"]},"productName":{"type":["string","null"]},"contactName":{"type":["string","null"]},"contactUuid":{"type":["string","null"],"format":"uuid"},"contactId":{"type":["integer","null"],"format":"int64","deprecated":true}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"4dbb6d352ff548d64bf6669179b8f6e0","x-required-scopes":["products"]}},"/accounts/{accountUuid}/products/v2/product-groups/{productGroupUuid}/actions/archive":{"patch":{"tags":["products_product-groups"],"summary":"Archive product group","description":"Archive a product group","operationId":"products_update_archive","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productGroupUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Product Group Resource","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"integer","format":"int64","deprecated":true},"groupNumber":{"type":"integer","format":"int64"},"bookingAccountNumber":{"type":["string","null"]},"isArchived":{"type":"boolean"},"isDeletable":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"description":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"55d3d032148e8dbfe24d314f445f48f9","x-required-scopes":["products"]}},"/accounts/{accountUuid}/products/v2/product-groups/{productGroupUuid}/actions/restore":{"patch":{"tags":["products_product-groups"],"summary":"Restore product group","description":"Restore a product group","operationId":"products_update_restore","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productGroupUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Product Group Resource","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"integer","format":"int64","deprecated":true},"groupNumber":{"type":"integer","format":"int64"},"bookingAccountNumber":{"type":["string","null"]},"isArchived":{"type":"boolean"},"isDeletable":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"description":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"04c3cc76d63e1f0fb3387d6625f3fde1","x-required-scopes":["products"]}},"/accounts/{accountUuid}/products/v2/products/{productUuid}/actions/{action}":{"patch":{"tags":["products_products"],"summary":"Execute action","description":"Executes an action for a product","operationId":"products_update_actions","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"action","in":"path","required":true,"schema":{"type":"string","enum":["archive","restore","delete"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"fd0c0c33829f0a814203fed7395edb3f","x-required-scopes":["products"]}},"/accounts/{accountUuid}/products/v2/products/{productUuid}/attachments/{attachmentUuid}":{"delete":{"tags":["products_products"],"summary":"Delete attachment","description":"Delete an attachment of a product","operationId":"products_delete_attachments","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"attachmentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"7e9204ed31db65894f4586a62fe89f96","x-required-scopes":["products"]}},"/accounts/{accountUuid}/products/v2/products/{productUuid}/comments/{commentUuid}":{"get":{"tags":["products_products"],"summary":"Get comment","description":"fetches a single comment of a product","operationId":"products_get_comments","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"commentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Product Comment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"authorUserUuid":{"type":["string","null"],"format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userName":{"type":"string"},"comment":{"type":"string"},"type":{"type":"string","enum":["intern"]},"isDeletable":{"description":"if the current user can delete the comment","type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"c181e2c8875e3bbcfe810dc8d1650657","x-required-scopes":["products"]},"delete":{"tags":["products_products"],"summary":"Delete comment","description":"deletes a comment of a product, which cannot be restored anymore afterwards.","operationId":"products_delete_comments","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"commentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"33502c6d1ccd28a53a244e8c4195e9bd","x-required-scopes":["products"]}},"/accounts/{accountUuid}/products/v2/products/{productUuid}/suppliers/{supplierUuid}":{"get":{"tags":["products_product-suppliers"],"summary":"Get supplier","description":"Get a single product suppliers","operationId":"products_get_suppliers","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"supplierUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Product Supplier Resource","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"integer","format":"int64","deprecated":true},"addressUuid":{"type":"string","format":"uuid"},"addressId":{"type":"integer","format":"int64","deprecated":true},"name":{"description":"Name of the address","type":"string"},"productCode":{"type":["string","null"]},"productName":{"type":["string","null"]},"contactName":{"type":["string","null"]},"contactUuid":{"type":["string","null"],"format":"uuid"},"contactId":{"type":["integer","null"],"format":"int64","deprecated":true}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"609b660395b406b75cd1716bdcc3ff24","x-required-scopes":["products"]},"patch":{"tags":["products_product-suppliers"],"summary":"Update supplier","description":"Update a product supplier","operationId":"products_update_suppliers","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"supplierUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Product supplier body","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/product-supplier.schema.json","description":"A Schema for create/update product supplier in AbaNinja over API","type":"object","properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"contactUuid":{"type":["null","string"],"format":"uuid"},"productCode":{"type":["null","string"],"maxLength":255},"productName":{"type":"string","maxLength":255}},"required":["addressUuid"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Product Supplier Resource","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"integer","format":"int64","deprecated":true},"addressUuid":{"type":"string","format":"uuid"},"addressId":{"type":"integer","format":"int64","deprecated":true},"name":{"description":"Name of the address","type":"string"},"productCode":{"type":["string","null"]},"productName":{"type":["string","null"]},"contactName":{"type":["string","null"]},"contactUuid":{"type":["string","null"],"format":"uuid"},"contactId":{"type":["integer","null"],"format":"int64","deprecated":true}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products"]}],"x-legacy-operation-id":"2a3c781d260221281dea27298eda0a33","x-required-scopes":["products"]}},"/accounts/{accountUuid}/time/v2/employee-groups":{"get":{"tags":["time-tracking_time-tracking-employee-groups"],"summary":"Get employee groups","description":"Get all employee groups for an account","operationId":"time_list_employee_groups","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Employee Group Resource","properties":{"uuid":{"type":"string","format":"uuid"},"translations":{"properties":{"de":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"e0175cb85da7aabef8d7826636aaf532","x-required-scopes":["time-tracking"]},"post":{"tags":["time-tracking_time-tracking-employee-groups"],"summary":"Add employee group","description":"Add a new employee group for an account","operationId":"time_create_employee_groups","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Add employee group","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/time-employee-group.schema.json","description":"A Schema for creating/updating timetracking employee group in AbaNinja over API","type":"object","properties":{"translations":{"type":"object","properties":{"de":{"type":"object","properties":{"name":{"type":["string","null"]},"description":{"type":["string","null"]}}},"en":{"type":"object","properties":{"name":{"type":["string","null"]},"description":{"type":["string","null"]}}},"fr":{"type":"object","properties":{"name":{"type":["string","null"]},"description":{"type":["string","null"]}}},"it":{"type":"object","properties":{"name":{"type":["string","null"]},"description":{"type":["string","null"]}}}},"required":["de","en","fr","it"]}},"required":["translations"]}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Employee Group Resource","properties":{"uuid":{"type":"string","format":"uuid"},"translations":{"properties":{"de":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"4a6f16c60634fff931a2a57eb0fc088c","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees":{"get":{"tags":["time-tracking_time-tracking-employees"],"summary":"Get employees","description":"Get all employees for an account","operationId":"time_list_employees","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"onlyInactive","in":"query","description":"get only inactive employees","required":false,"schema":{"type":["boolean","null"],"default":null}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Employee Resource","properties":{"uuid":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"jobTitle":{"type":["string","null"]},"employeeNumber":{"type":"string"},"birthDate":{"type":["string","null"],"format":"date"},"employeeGroupUuid":{"type":"string","format":"uuid"},"employeeGroup":{"title":"Employee Group Resource","properties":{"uuid":{"type":"string","format":"uuid"},"translations":{"properties":{"de":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"employmentStartDate":{"type":"string","format":"date"},"isActive":{"type":"boolean","deprecated":true},"userUuid":{"type":["string","null"],"format":"uuid"},"user":{"oneOf":[{"title":"User Resource","properties":{"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"email":{"type":["string","null"]}},"type":"object"},{"type":"null"}],"deprecated":true},"accountUuid":{"type":"string","format":"uuid"},"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"timeTrackingStartDate":{"type":"string","format":"date"},"timeTrackingStartDateEditable":{"type":"boolean","deprecated":true},"isPresent":{"type":"boolean","deprecated":true},"hasInvalidContracts":{"type":"boolean","deprecated":true},"hasImage":{"type":"boolean"},"additionalInformation":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"e9417be2d3089e4cc8a5f763c109fd67","x-required-scopes":["time-tracking"]},"post":{"tags":["time-tracking_time-tracking-employees"],"summary":"Add employee","description":"Add a new employee for an account","operationId":"time_create_employees","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Add employee","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/time-employee.schema.json","description":"A Schema for creating/updating timetracking employee in AbaNinja over API","type":"object","properties":{"employeeNumber":{"type":"string","maxLength":255},"firstName":{"type":"string","maxLength":255},"lastName":{"type":["string","null"],"maxLength":255},"jobTitle":{"type":["string","null"],"maxLength":255},"userUuid":{"type":["string","null"],"format":"uuid"},"employmentStartDate":{"type":"string","format":"date"},"birthDate":{"type":["string","null"],"format":"date"},"addressUuid":{"type":["string","null"],"format":"uuid"},"employeeGroupUuid":{"type":["string"],"format":"uuid"},"timeTrackingStartDate":{"type":"string","format":"date"},"additionalInformation":{"type":["string","null"],"maxLength":5000}},"required":["employeeNumber","firstName","employmentStartDate","employeeGroupUuid","timeTrackingStartDate"]}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Employee Resource","properties":{"uuid":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"jobTitle":{"type":["string","null"]},"employeeNumber":{"type":"string"},"birthDate":{"type":["string","null"],"format":"date"},"employeeGroupUuid":{"type":"string","format":"uuid"},"employeeGroup":{"title":"Employee Group Resource","properties":{"uuid":{"type":"string","format":"uuid"},"translations":{"properties":{"de":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"employmentStartDate":{"type":"string","format":"date"},"isActive":{"type":"boolean","deprecated":true},"userUuid":{"type":["string","null"],"format":"uuid"},"user":{"oneOf":[{"title":"User Resource","properties":{"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"email":{"type":["string","null"]}},"type":"object"},{"type":"null"}],"deprecated":true},"accountUuid":{"type":"string","format":"uuid"},"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"timeTrackingStartDate":{"type":"string","format":"date"},"timeTrackingStartDateEditable":{"type":"boolean","deprecated":true},"isPresent":{"type":"boolean","deprecated":true},"hasInvalidContracts":{"type":"boolean","deprecated":true},"hasImage":{"type":"boolean"},"additionalInformation":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"b58232b3b8e9ca03d689598cce510946","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employee-groups/{employeeGroupUuid}":{"get":{"tags":["time-tracking_time-tracking-employee-groups"],"summary":"Get employee group","description":"Get an employee group for an account","operationId":"time_get_employee_groups","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeGroupUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Employee Group Resource","properties":{"uuid":{"type":"string","format":"uuid"},"translations":{"properties":{"de":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"485209891ad670337ee166176e06af38","x-required-scopes":["time-tracking"]},"patch":{"tags":["time-tracking_time-tracking-employee-groups"],"summary":"Update employee group","description":"Update an employee group for an account","operationId":"time_update_employee_groups","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeGroupUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update employee group","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/time-employee-group.schema.json","description":"A Schema for creating/updating timetracking employee group in AbaNinja over API","type":"object","properties":{"translations":{"type":"object","properties":{"de":{"type":"object","properties":{"name":{"type":["string","null"]},"description":{"type":["string","null"]}}},"en":{"type":"object","properties":{"name":{"type":["string","null"]},"description":{"type":["string","null"]}}},"fr":{"type":"object","properties":{"name":{"type":["string","null"]},"description":{"type":["string","null"]}}},"it":{"type":"object","properties":{"name":{"type":["string","null"]},"description":{"type":["string","null"]}}}},"required":["de","en","fr","it"]}},"required":["translations"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Employee Group Resource","properties":{"uuid":{"type":"string","format":"uuid"},"translations":{"properties":{"de":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"391fa6fb94139b647359d3bc1b172a29","x-required-scopes":["time-tracking"]},"delete":{"tags":["time-tracking_time-tracking-employee-groups"],"summary":"Delete employee group","description":"Delete an employee group of an account","operationId":"time_delete_employee_groups","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeGroupUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"b0e1d7d39fa7e6fe8c88bca067af432e","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}":{"get":{"tags":["time-tracking_time-tracking-employees"],"summary":"Get employee","description":"Get an employee for an account","operationId":"time_get_employees","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Employee Resource","properties":{"uuid":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"jobTitle":{"type":["string","null"]},"employeeNumber":{"type":"string"},"birthDate":{"type":["string","null"],"format":"date"},"employeeGroupUuid":{"type":"string","format":"uuid"},"employeeGroup":{"title":"Employee Group Resource","properties":{"uuid":{"type":"string","format":"uuid"},"translations":{"properties":{"de":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"employmentStartDate":{"type":"string","format":"date"},"isActive":{"type":"boolean","deprecated":true},"userUuid":{"type":["string","null"],"format":"uuid"},"user":{"oneOf":[{"title":"User Resource","properties":{"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"email":{"type":["string","null"]}},"type":"object"},{"type":"null"}],"deprecated":true},"accountUuid":{"type":"string","format":"uuid"},"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"timeTrackingStartDate":{"type":"string","format":"date"},"timeTrackingStartDateEditable":{"type":"boolean","deprecated":true},"isPresent":{"type":"boolean","deprecated":true},"hasInvalidContracts":{"type":"boolean","deprecated":true},"hasImage":{"type":"boolean"},"additionalInformation":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"7f7c81d0a693c85d1920c5f3fdc7633f","x-required-scopes":["time-tracking"]},"patch":{"tags":["time-tracking_time-tracking-employees"],"summary":"Update employee","description":"Update an employee for an account","operationId":"time_update_employees","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update employee","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/time-employee.schema.json","description":"A Schema for creating/updating timetracking employee in AbaNinja over API","type":"object","properties":{"employeeNumber":{"type":"string","maxLength":255},"firstName":{"type":"string","maxLength":255},"lastName":{"type":["string","null"],"maxLength":255},"jobTitle":{"type":["string","null"],"maxLength":255},"userUuid":{"type":["string","null"],"format":"uuid"},"employmentStartDate":{"type":"string","format":"date"},"birthDate":{"type":["string","null"],"format":"date"},"addressUuid":{"type":["string","null"],"format":"uuid"},"employeeGroupUuid":{"type":["string"],"format":"uuid"},"timeTrackingStartDate":{"type":"string","format":"date"},"additionalInformation":{"type":["string","null"],"maxLength":5000}},"required":["employeeNumber","firstName","employmentStartDate","employeeGroupUuid","timeTrackingStartDate"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Employee Resource","properties":{"uuid":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"jobTitle":{"type":["string","null"]},"employeeNumber":{"type":"string"},"birthDate":{"type":["string","null"],"format":"date"},"employeeGroupUuid":{"type":"string","format":"uuid"},"employeeGroup":{"title":"Employee Group Resource","properties":{"uuid":{"type":"string","format":"uuid"},"translations":{"properties":{"de":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"employmentStartDate":{"type":"string","format":"date"},"isActive":{"type":"boolean","deprecated":true},"userUuid":{"type":["string","null"],"format":"uuid"},"user":{"oneOf":[{"title":"User Resource","properties":{"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"email":{"type":["string","null"]}},"type":"object"},{"type":"null"}],"deprecated":true},"accountUuid":{"type":"string","format":"uuid"},"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"timeTrackingStartDate":{"type":"string","format":"date"},"timeTrackingStartDateEditable":{"type":"boolean","deprecated":true},"isPresent":{"type":"boolean","deprecated":true},"hasInvalidContracts":{"type":"boolean","deprecated":true},"hasImage":{"type":"boolean"},"additionalInformation":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"b4f70d8252cbaad3d44b26e9eb30135d","x-required-scopes":["time-tracking"]},"delete":{"tags":["time-tracking_time-tracking-employees"],"summary":"Delete employee","description":"Delete an employee of an account","operationId":"time_delete_employees","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"e5125798761e5f60b8dd7b097c21d753","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/available-users":{"get":{"tags":["time-tracking_time-tracking-employees"],"summary":"Get available users","description":"Get available users for employees","operationId":"time_list_available_users","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"query","description":"excluded employee","required":false,"schema":{"type":["string","null"],"format":"uuid","default":null}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"User Resource","properties":{"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"email":{"type":["string","null"]}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"f55306a075f622f14d9ca6d76b18a07b","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/me":{"get":{"tags":["time-tracking_time-tracking-employees"],"summary":"Get current employee","description":"Get the employee for the current user and account","operationId":"time_list_me","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Employee Resource","properties":{"uuid":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"jobTitle":{"type":["string","null"]},"employeeNumber":{"type":"string"},"birthDate":{"type":["string","null"],"format":"date"},"employeeGroupUuid":{"type":"string","format":"uuid"},"employeeGroup":{"title":"Employee Group Resource","properties":{"uuid":{"type":"string","format":"uuid"},"translations":{"properties":{"de":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":["string","null"]},"name":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"employmentStartDate":{"type":"string","format":"date"},"isActive":{"type":"boolean","deprecated":true},"userUuid":{"type":["string","null"],"format":"uuid"},"user":{"oneOf":[{"title":"User Resource","properties":{"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"email":{"type":["string","null"]}},"type":"object"},{"type":"null"}],"deprecated":true},"accountUuid":{"type":"string","format":"uuid"},"addressUuid":{"type":["string","null"],"format":"uuid"},"personUuid":{"type":["string","null"],"format":"uuid"},"timeTrackingStartDate":{"type":"string","format":"date"},"timeTrackingStartDateEditable":{"type":"boolean","deprecated":true},"isPresent":{"type":"boolean","deprecated":true},"hasInvalidContracts":{"type":"boolean","deprecated":true},"hasImage":{"type":"boolean"},"additionalInformation":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"204":{"description":"User has no employee"}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"12bf9dbaa37a0e3e811c10c80ed45536","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/settings/activity":{"get":{"tags":["time-tracking_time-tracking-settings"],"summary":"Get activity setting","description":"Get the activity setting for an account","operationId":"time_list_activity","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Activity Position Resource","properties":{"translations":{"properties":{"de":{"properties":{"description":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"7299a692e7ef49550b7193a08b547721","x-required-scopes":["time-tracking"]},"patch":{"tags":["time-tracking_time-tracking-settings"],"summary":"Update activity setting","description":"Update the activity setting for an account","operationId":"time_update_activity","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update activity setting","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/time-employee-activity-position.schema.json","description":"A Schema for updating timetracking activity position description in AbaNinja over API","type":"object","properties":{"translations":{"type":"object","properties":{"de":{"type":"object","properties":{"description":{"type":["string","null"],"maxLength":255}}},"en":{"type":"object","properties":{"description":{"type":["string","null"],"maxLength":255}}},"fr":{"type":"object","properties":{"description":{"type":["string","null"],"maxLength":255}}},"it":{"type":"object","properties":{"description":{"type":["string","null"],"maxLength":255}}}},"required":["de","en","fr","it"]}},"required":["translations"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Activity Position Resource","properties":{"translations":{"properties":{"de":{"properties":{"description":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"7f5d53bcfbb8cfc58e66a29b3122f464","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/settings/activity-types":{"get":{"tags":["time-tracking_time-tracking-settings"],"summary":"Get activity types","description":"Get all activity types for an account","operationId":"time_list_activity_types","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Activity Type Resource","properties":{"uuid":{"type":"string","format":"uuid"},"activityTypeMasterUuid":{"type":["string","null"],"format":"uuid"},"activityNumber":{"type":"string"},"unit":{"type":["string","null"]},"isCount":{"type":"boolean"},"isBillable":{"type":"boolean"},"isHoliday":{"type":"boolean"},"activityGroup":{"type":"integer","enum":[1,2]},"isTimeCredit":{"type":"boolean"},"isShortTimeWork":{"type":"boolean"},"isFavorite":{"type":"boolean"},"used":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"description":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"5c68f1cac74686b710c60081041d7cb3","x-required-scopes":["time-tracking"]},"post":{"tags":["time-tracking_time-tracking-settings"],"summary":"Add activity type","description":"Add a new activity type for an account","operationId":"time_create_activity_types","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Add activity type","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/time-employee-activitytype.schema.json","description":"A Schema for creating/updating timetracking employee activity type in AbaNinja over API","type":"object","properties":{"activityNumber":{"type":"string","minLength":1},"unit":{"type":"string","enum":["min","hrs","day"]},"isCount":{"type":"boolean"},"isBillable":{"type":"boolean"},"isHoliday":{"type":"boolean"},"activityGroup":{"type":"integer","enum":[1,2],"description":"1 = Work, 2 = Absence"},"isTimeCredit":{"type":"boolean"},"isShortTimeWork":{"type":"boolean"},"isFavorite":{"type":"boolean"},"translations":{"type":"object","properties":{"de":{"type":"object","properties":{"description":{"type":["string","null"],"maxLength":255}}},"en":{"type":"object","properties":{"description":{"type":["string","null"],"maxLength":255}}},"fr":{"type":"object","properties":{"description":{"type":["string","null"],"maxLength":255}}},"it":{"type":"object","properties":{"description":{"type":["string","null"],"maxLength":255}}}},"required":["de","en","fr","it"]}},"required":["activityNumber","unit","isCount","isBillable","isHoliday","activityGroup","isTimeCredit","isShortTimeWork","translations"]}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Activity Type Resource","properties":{"uuid":{"type":"string","format":"uuid"},"activityTypeMasterUuid":{"type":["string","null"],"format":"uuid"},"activityNumber":{"type":"string"},"unit":{"type":["string","null"]},"isCount":{"type":"boolean"},"isBillable":{"type":"boolean"},"isHoliday":{"type":"boolean"},"activityGroup":{"type":"integer","enum":[1,2]},"isTimeCredit":{"type":"boolean"},"isShortTimeWork":{"type":"boolean"},"isFavorite":{"type":"boolean"},"used":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"description":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"c3fee42a4373efc00b452982b71204b3","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/settings/work-models":{"get":{"tags":["time-tracking_time-tracking-settings"],"summary":"Get work models","description":"Get all work models for an account","operationId":"time_list_work_models","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Work Model Resource","properties":{"uuid":{"type":"string","format":"uuid"},"isSystem":{"type":"boolean"},"hoursPerWeek":{"type":"number"},"holidaysPerYear":{"type":"number"},"monday":{"type":"boolean"},"tuesday":{"type":"boolean"},"wednesday":{"type":"boolean"},"thursday":{"type":"boolean"},"friday":{"type":"boolean"},"saturday":{"type":"boolean"},"sunday":{"type":"boolean"},"isUsed":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"description":{"type":"string"},"name":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":"string"},"name":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":"string"},"name":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":"string"},"name":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"e2804258aaebc847408232091cf2991e","x-required-scopes":["time-tracking"]},"post":{"tags":["time-tracking_time-tracking-settings"],"summary":"Add work model","description":"Add a new work model for an account","operationId":"time_create_work_models","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Add work model","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/time-employee-work-model.schema.json","description":"A Schema for creating/updating timetracking employee work models in AbaNinja over API","type":"object","properties":{"hoursPerWeek":{"type":"number"},"holidaysPerYear":{"type":"number"},"monday":{"type":"boolean"},"tuesday":{"type":"boolean"},"wednesday":{"type":"boolean"},"thursday":{"type":"boolean"},"friday":{"type":"boolean"},"saturday":{"type":"boolean"},"sunday":{"type":"boolean"},"translations":{"type":"object","properties":{"de":{"type":"object","properties":{"name":{"type":["string","null"],"maxLength":255},"description":{"type":["string","null"],"maxLength":5000}}},"en":{"type":"object","properties":{"name":{"type":["string","null"],"maxLength":255},"description":{"type":["string","null"],"maxLength":5000}}},"fr":{"type":"object","properties":{"name":{"type":["string","null"],"maxLength":255},"description":{"type":["string","null"],"maxLength":5000}}},"it":{"type":"object","properties":{"name":{"type":["string","null"],"maxLength":255},"description":{"type":["string","null"],"maxLength":5000}}}},"required":["de","en","fr","it"]}},"required":["hoursPerWeek","holidaysPerYear","monday","tuesday","wednesday","thursday","friday","saturday","sunday","translations"]}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Work Model Resource","properties":{"uuid":{"type":"string","format":"uuid"},"isSystem":{"type":"boolean"},"hoursPerWeek":{"type":"number"},"holidaysPerYear":{"type":"number"},"monday":{"type":"boolean"},"tuesday":{"type":"boolean"},"wednesday":{"type":"boolean"},"thursday":{"type":"boolean"},"friday":{"type":"boolean"},"saturday":{"type":"boolean"},"sunday":{"type":"boolean"},"isUsed":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"description":{"type":"string"},"name":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":"string"},"name":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":"string"},"name":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":"string"},"name":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"eb36ba1c948f90236de671ae6495da79","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/activities":{"post":{"tags":["time-tracking_time-tracking-activities"],"summary":"Add activity","description":"Add an activity for an employee","operationId":"time_create_activities","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Add activity","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/time-employee-activity.schema.json","description":"A Schema for creating/updating timetracking employee activity in AbaNinja over API","type":"object","properties":{"activityTypeUuid":{"type":"string","format":"uuid"},"startDate":{"type":"string","format":"date"},"endDate":{"type":"string","format":"date"},"startTime":{"type":"string","pattern":"^(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])$","example":"14:35"},"endTime":{"type":"string","pattern":"^(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])$","example":"15:45"},"halfDay":{"type":"boolean"},"addressUuid":{"type":["string","null"],"format":"uuid"},"contractNoteUuid":{"type":["string","null"],"format":"uuid"},"productUuid":{"type":["string","null"],"format":"uuid"},"description":{"type":["string","null"],"maxLength":5000}},"required":["activityTypeUuid","startDate","endDate","startTime","endTime","halfDay"]}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Activity Resource","properties":{"uuid":{"type":"string","format":"uuid"},"accountUuid":{"type":"string","format":"uuid"},"employeeUuid":{"type":"string","format":"uuid"},"activityTypeUuid":{"type":["string","null"],"format":"uuid"},"addressUuid":{"type":["string","null"],"format":"uuid"},"addressDescription":{"type":"string","deprecated":true},"productUuid":{"type":["string","null"],"format":"uuid"},"productKey":{"type":["string","null"],"deprecated":true},"productDescription":{"type":["string","null"],"deprecated":true},"startDate":{"type":"string","format":"date","deprecated":true},"endDate":{"type":"string","format":"date","deprecated":true},"startTime":{"type":"string","deprecated":true},"endTime":{"type":"string","deprecated":true},"startDateTime":{"description":"ISO8601 local time","type":"string","example":"2024-01-14T20:20:00"},"endDateTime":{"description":"ISO8601 local time","type":"string","example":"2024-01-14T21:00:00"},"halfDay":{"type":"boolean"},"description":{"type":["string","null"]},"contractNoteId":{"type":["integer","null"],"deprecated":true},"contractNoteUuid":{"type":["string","null"],"format":"uuid"},"isInvoiced":{"type":"boolean","deprecated":true},"isClosed":{"type":"boolean"},"closedAt":{"type":["string","null"],"deprecated":true},"closedAtDateTime":{"description":"ISO8601 local time","type":["string","null"],"format":"date-time","example":"2024-01-31T13:00:00"},"contractNoteName":{"type":["string","null"],"deprecated":true},"poNumber":{"type":["string","null"],"deprecated":true}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"431ae5f3836e07be0778352aeea0617c","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/attachments":{"get":{"tags":["time-tracking_time-tracking-employees"],"summary":"Get attachments","description":"Get all attachments of an employee","operationId":"time_list_attachments","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Employee Attachment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"size":{"type":"integer"},"mimeType":{"type":"string"},"url":{"type":["string","null"],"format":"uri"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"665ee330632d7f17146669513b38ed8c","x-required-scopes":["time-tracking"]},"post":{"tags":["time-tracking_time-tracking-employees"],"summary":"Upload attachment","description":"Upload an attachment for an employee","operationId":"time_create_attachments","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["file"],"properties":{"file":{"type":"string","format":"binary"}},"type":"object"}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Employee Attachment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"size":{"type":"integer"},"mimeType":{"type":"string"},"url":{"type":["string","null"],"format":"uri"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"b1fd727027806e8272e4f4e7eef6a583","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/calendar":{"get":{"tags":["time-tracking_time-tracking-employee-statistics"],"summary":"Get employee calendar","description":"Get the calendar of an employee","operationId":"time_list_calendar","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"dateFrom","in":"query","required":true,"schema":{"type":"string","format":"date"}},{"name":"dateTo","in":"query","required":true,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Employee Calendar Resource","properties":{"date":{"type":"string","format":"date"},"nonWorkingDay":{"type":"boolean"},"activity":{"type":"boolean"},"inOut":{"type":"boolean"},"absences":{"type":"boolean"},"away":{"type":"boolean"},"holidays":{"type":"array","items":{"properties":{"halfDay":{"type":"boolean"},"name":{"type":"string"}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"b23614acbfae77c1b5c96ee8724512a0","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/closures":{"get":{"tags":["time-tracking_time-tracking-closures"],"summary":"Get closures","description":"Get all closures of an employee","operationId":"time_list_closures","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Employee Closure Resource","properties":{"uuid":{"type":"string","format":"uuid"},"accountUuid":{"type":"string","format":"uuid"},"employeeUuid":{"type":"string","format":"uuid"},"closureDate":{"type":"string","format":"date"},"holidays":{"type":"number"},"holidayCorrection":{"type":"number"},"flextime":{"type":"number"},"timeCorrection":{"type":"number"},"shortWork":{"type":"number"},"deleteable":{"type":"boolean","deprecated":true},"deletable":{"type":"boolean"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"85c97f27f491d63cbb761373072b6701","x-required-scopes":["time-tracking"]},"post":{"tags":["time-tracking_time-tracking-closures"],"summary":"Add closure","description":"Add a closure for an employee","operationId":"time_create_closures","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Add closure","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/time-employee-closure.schema.json","description":"A Schema for creating timetracking employee closure in AbaNinja over API","type":"object","properties":{"closureDate":{"type":"string","format":"date"}},"required":["closureDate"]}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"da5c485516fddb0314f6ed09b4899cc6","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/contracts":{"get":{"tags":["time-tracking_time-tracking-contracts"],"summary":"Get contracts","description":"Get all contracts of an employee","operationId":"time_list_contracts","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Employee Contract Resource","properties":{"uuid":{"type":"string","format":"uuid"},"monday":{"type":"boolean"},"tuesday":{"type":"boolean"},"wednesday":{"type":"boolean"},"thursday":{"type":"boolean"},"friday":{"type":"boolean"},"saturday":{"type":"boolean"},"sunday":{"type":"boolean"},"validFromDate":{"type":["string","null"],"format":"date"},"validToDate":{"type":["string","null"],"format":"date"},"employeeWorkModelUuid":{"type":["string","null"],"format":"uuid"},"employmentFactor":{"type":"number"},"shortTimeWorkFactor":{"type":"number"},"workingDays":{"type":"integer"},"hoursPerWeek":{"type":"number"},"holidaysPerYear":{"type":"number"},"workingStateCode":{"type":["string","null"]},"workingStateName":{"type":["string","null"]},"workingCountryCode":{"type":["string","null"]},"workingCountryName":{"type":["string","null"]},"isClosed":{"type":"boolean"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"929584ce88d7e505b124bfa41d93db79","x-required-scopes":["time-tracking"]},"post":{"tags":["time-tracking_time-tracking-contracts"],"summary":"Add contract","description":"Add a contract for an employee","operationId":"time_create_contracts","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Add contract","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/time-employee-contract.schema.json","description":"A Schema for creating/updating timetracking employee contract in AbaNinja over API","type":"object","properties":{"monday":{"type":"boolean"},"tuesday":{"type":"boolean"},"wednesday":{"type":"boolean"},"thursday":{"type":"boolean"},"friday":{"type":"boolean"},"saturday":{"type":"boolean"},"sunday":{"type":"boolean"},"validFromDate":{"type":"string","format":"date"},"validToDate":{"type":["string","null"],"format":"date"},"employeeWorkModelUuid":{"type":"string","format":"uuid"},"employmentFactor":{"type":["number","null"]},"shortTimeWorkFactor":{"type":"number"},"workingCountryCode":{"type":"string"},"workingStateCode":{"type":"string"},"hoursPerWeek":{"type":"number"},"holidaysPerYear":{"type":"number"}},"required":["monday","tuesday","wednesday","thursday","friday","saturday","sunday","validFromDate","employeeWorkModelUuid","employmentFactor","shortTimeWorkFactor","workingCountryCode","workingStateCode","hoursPerWeek","holidaysPerYear"]}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Employee Contract Resource","properties":{"uuid":{"type":"string","format":"uuid"},"monday":{"type":"boolean"},"tuesday":{"type":"boolean"},"wednesday":{"type":"boolean"},"thursday":{"type":"boolean"},"friday":{"type":"boolean"},"saturday":{"type":"boolean"},"sunday":{"type":"boolean"},"validFromDate":{"type":["string","null"],"format":"date"},"validToDate":{"type":["string","null"],"format":"date"},"employeeWorkModelUuid":{"type":["string","null"],"format":"uuid"},"employmentFactor":{"type":"number"},"shortTimeWorkFactor":{"type":"number"},"workingDays":{"type":"integer"},"hoursPerWeek":{"type":"number"},"holidaysPerYear":{"type":"number"},"workingStateCode":{"type":["string","null"]},"workingStateName":{"type":["string","null"]},"workingCountryCode":{"type":["string","null"]},"workingCountryName":{"type":["string","null"]},"isClosed":{"type":"boolean"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"8a3072a624ddcb324ae25209567be58a","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/flex-time":{"get":{"tags":["time-tracking_time-tracking-employee-statistics"],"summary":"Get employee flex time","description":"Get the flex time for an employee","operationId":"time_list_flex_time","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"date","in":"query","required":false,"schema":{"type":["string","null"],"format":"date","default":null}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Employee Flex Time Resource","properties":{"flexTime":{"type":"string"},"flexTimeRaw":{"type":"number"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"c21390db291e6d5d1ae29477789d2a65","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/holidays":{"get":{"tags":["time-tracking_time-tracking-employee-statistics"],"summary":"Get employee holidays","description":"Get the holidays for an employee","operationId":"time_list_holidays","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"date","in":"query","required":false,"schema":{"type":["string","null"],"format":"date","default":null}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Employee Holidays Resource","properties":{"unitName":{"type":"string"},"transferDays":{"type":["number","null"]},"plannedDays":{"type":["number","null"]},"contractDays":{"type":["number","null"]},"usedDays":{"type":["number","null"]},"balanceDays":{"type":["number","null"]},"balanceEndDate":{"type":"string"},"correctionDays":{"type":["number","null"]}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"3a46b8ed88997d506864319837d30d3c","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/image":{"get":{"tags":["time-tracking_time-tracking-employees"],"summary":"Get image","description":"Get the image of an employee","operationId":"time_list_image","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Employee Attachment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"size":{"type":"integer"},"mimeType":{"type":"string"},"url":{"type":["string","null"],"format":"uri"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"204":{"description":"No image exists"},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"f6c9cad6e8b9bdd9e51b28a49aa84f15","x-required-scopes":["time-tracking"]},"post":{"tags":["time-tracking_time-tracking-employees"],"summary":"Upload image","description":"Upload an image for an employee","operationId":"time_create_image","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["file"],"properties":{"file":{"type":"string","format":"binary"}},"type":"object"}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Employee Attachment Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"size":{"type":"integer"},"mimeType":{"type":"string"},"url":{"type":["string","null"],"format":"uri"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"8d572ba53f829414f6a2c3e7a71760be","x-required-scopes":["time-tracking"]},"delete":{"tags":["time-tracking_time-tracking-employees"],"summary":"Delete image","description":"Delete the image of an employee","operationId":"time_delete_image","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"0bb68654d94316e2ba4e127350613b23","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/in-out":{"post":{"tags":["time-tracking_time-tracking-timestamps"],"summary":"Add timestamp","description":"Add a timestamp for an employee","operationId":"time_create_in_out","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Add timestamp","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/time-employee-inout.create.schema.json","description":"A Schema for creating timetracking employee in&out in AbaNinja over API","type":"object","properties":{"date":{"type":"string","format":"date"},"startTime":{"type":"string","pattern":"^(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])$"},"endTime":{"type":["string","null"],"pattern":"^(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])$"},"comment":{"type":["string","null"]},"device":{"type":["string","null"]}},"required":["date","startTime"]}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Timestamp Resource","properties":{"uuid":{"type":"string","format":"uuid"},"date":{"type":"string","format":"date","deprecated":true},"startTime":{"type":"string","deprecated":true},"endTime":{"type":"string","deprecated":true},"startDateTime":{"description":"ISO8601 local time","type":"string","example":"2024-01-14T20:20:00"},"endDateTime":{"description":"ISO8601 local time","type":["string","null"],"example":"2024-01-14T21:00:00"},"startDevice":{"type":["string","null"]},"endDevice":{"type":["string","null"]},"type":{"type":"string","deprecated":true},"comment":{"type":"string"},"isClosed":{"type":"boolean"},"closedAt":{"type":["string","null"],"deprecated":true},"closedAtDateTime":{"description":"ISO8601 local time","type":["string","null"],"format":"date-time","example":"2024-01-31T13:00:00"},"duration":{"properties":{"hours":{"type":"string"},"minutes":{"type":"string"}},"type":["object","null"],"deprecated":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"0cd83c4d5ef19929390234334bc9dccd","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/target-time":{"get":{"tags":["time-tracking_time-tracking-employee-statistics"],"summary":"Get employee target time","description":"Get the target time for an employee","operationId":"time_list_target_time","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"date","in":"query","required":false,"schema":{"type":["string","null"],"format":"date","default":null}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Employee Target Time Resource","properties":{"contractTypeName":{"type":"string"},"employmentFactor":{"type":"number"},"hoursPerWeek":{"type":"number"},"employeeWorkModelName":{"type":["string","null"]},"shortWorkPercent":{"type":["number","null"]}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"642c63f3e2aea79bbd41be92b944e5a6","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/time-corrections":{"get":{"tags":["time-tracking_time-tracking-corrections"],"summary":"Get corrections","description":"Get all corrections of an employee","operationId":"time_list_time_corrections","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Correction Resource","properties":{"uuid":{"type":"string","format":"uuid"},"accountUuid":{"type":"string","format":"uuid"},"employeeUuid":{"type":"string","format":"uuid"},"type":{"description":"1 = Timecorrection, 2 = Holidaycorrection","type":"integer","enum":[1,2]},"isClosed":{"type":"boolean"},"bookingDate":{"type":"string","format":"date"},"bookingQty":{"type":"number"},"bookingUnit":{"type":"string","enum":["hrs","day"]},"bookingText":{"type":["string","null"]}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"b4db589782d4c5689ed2e1082bddc125","x-required-scopes":["time-tracking"]},"post":{"tags":["time-tracking_time-tracking-corrections"],"summary":"Add correction","description":"Add a correction for an employee","operationId":"time_create_time_corrections","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Add correction","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/time-employee-correction.schema.json","description":"A Schema for creating/updating timetracking employee correction in AbaNinja over API","type":"object","properties":{"type":{"type":"integer","enum":[1,2],"description":"1 = Timecorrection, 2 = Holidaycorrection"},"bookingDate":{"type":"string","format":"date"},"bookingQty":{"type":"number"},"bookingUnit":{"type":"string","enum":["hrs","day"]},"bookingText":{"type":["string","null"]}},"required":["type","bookingDate","bookingQty","bookingUnit"]}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Correction Resource","properties":{"uuid":{"type":"string","format":"uuid"},"accountUuid":{"type":"string","format":"uuid"},"employeeUuid":{"type":"string","format":"uuid"},"type":{"description":"1 = Timecorrection, 2 = Holidaycorrection","type":"integer","enum":[1,2]},"isClosed":{"type":"boolean"},"bookingDate":{"type":"string","format":"date"},"bookingQty":{"type":"number"},"bookingUnit":{"type":"string","enum":["hrs","day"]},"bookingText":{"type":["string","null"]}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"2564739c9a52416ca615b5a9e97900be","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/settings/activity-types/{activityTypeUuid}":{"get":{"tags":["time-tracking_time-tracking-settings"],"summary":"Get activity type","description":"Get an activity type for an account","operationId":"time_get_activity_types","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"activityTypeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Activity Type Resource","properties":{"uuid":{"type":"string","format":"uuid"},"activityTypeMasterUuid":{"type":["string","null"],"format":"uuid"},"activityNumber":{"type":"string"},"unit":{"type":["string","null"]},"isCount":{"type":"boolean"},"isBillable":{"type":"boolean"},"isHoliday":{"type":"boolean"},"activityGroup":{"type":"integer","enum":[1,2]},"isTimeCredit":{"type":"boolean"},"isShortTimeWork":{"type":"boolean"},"isFavorite":{"type":"boolean"},"used":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"description":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"57636bc1b1a136cecc721961933ea178","x-required-scopes":["time-tracking"]},"patch":{"tags":["time-tracking_time-tracking-settings"],"summary":"Update activity type","description":"Update an activity type for an account","operationId":"time_update_activity_types","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"activityTypeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update activity type","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/time-employee-activitytype.schema.json","description":"A Schema for creating/updating timetracking employee activity type in AbaNinja over API","type":"object","properties":{"activityNumber":{"type":"string","minLength":1},"unit":{"type":"string","enum":["min","hrs","day"]},"isCount":{"type":"boolean"},"isBillable":{"type":"boolean"},"isHoliday":{"type":"boolean"},"activityGroup":{"type":"integer","enum":[1,2],"description":"1 = Work, 2 = Absence"},"isTimeCredit":{"type":"boolean"},"isShortTimeWork":{"type":"boolean"},"isFavorite":{"type":"boolean"},"translations":{"type":"object","properties":{"de":{"type":"object","properties":{"description":{"type":["string","null"],"maxLength":255}}},"en":{"type":"object","properties":{"description":{"type":["string","null"],"maxLength":255}}},"fr":{"type":"object","properties":{"description":{"type":["string","null"],"maxLength":255}}},"it":{"type":"object","properties":{"description":{"type":["string","null"],"maxLength":255}}}},"required":["de","en","fr","it"]}},"required":["activityNumber","unit","isCount","isBillable","isHoliday","activityGroup","isTimeCredit","isShortTimeWork","translations"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Activity Type Resource","properties":{"uuid":{"type":"string","format":"uuid"},"activityTypeMasterUuid":{"type":["string","null"],"format":"uuid"},"activityNumber":{"type":"string"},"unit":{"type":["string","null"]},"isCount":{"type":"boolean"},"isBillable":{"type":"boolean"},"isHoliday":{"type":"boolean"},"activityGroup":{"type":"integer","enum":[1,2]},"isTimeCredit":{"type":"boolean"},"isShortTimeWork":{"type":"boolean"},"isFavorite":{"type":"boolean"},"used":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"description":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"753af06aa05ec48c446cc4ff726249a3","x-required-scopes":["time-tracking"]},"delete":{"tags":["time-tracking_time-tracking-settings"],"summary":"Delete activity type","description":"Delete an activity type of an account","operationId":"time_delete_activity_types","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"activityTypeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"689aef5a30cf0ad57be05e7ee58b98c4","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/settings/work-models/{workModelUuid}":{"get":{"tags":["time-tracking_time-tracking-settings"],"summary":"Get work model","description":"Get a work model for an account","operationId":"time_get_work_models","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"workModelUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Work Model Resource","properties":{"uuid":{"type":"string","format":"uuid"},"isSystem":{"type":"boolean"},"hoursPerWeek":{"type":"number"},"holidaysPerYear":{"type":"number"},"monday":{"type":"boolean"},"tuesday":{"type":"boolean"},"wednesday":{"type":"boolean"},"thursday":{"type":"boolean"},"friday":{"type":"boolean"},"saturday":{"type":"boolean"},"sunday":{"type":"boolean"},"isUsed":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"description":{"type":"string"},"name":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":"string"},"name":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":"string"},"name":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":"string"},"name":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"6d0198d1587f34aac5c4ea6889602949","x-required-scopes":["time-tracking"]},"patch":{"tags":["time-tracking_time-tracking-settings"],"summary":"Update work model","description":"Update a work model for an account","operationId":"time_update_work_models","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"workModelUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update work model","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/time-employee-work-model.schema.json","description":"A Schema for creating/updating timetracking employee work models in AbaNinja over API","type":"object","properties":{"hoursPerWeek":{"type":"number"},"holidaysPerYear":{"type":"number"},"monday":{"type":"boolean"},"tuesday":{"type":"boolean"},"wednesday":{"type":"boolean"},"thursday":{"type":"boolean"},"friday":{"type":"boolean"},"saturday":{"type":"boolean"},"sunday":{"type":"boolean"},"translations":{"type":"object","properties":{"de":{"type":"object","properties":{"name":{"type":["string","null"],"maxLength":255},"description":{"type":["string","null"],"maxLength":5000}}},"en":{"type":"object","properties":{"name":{"type":["string","null"],"maxLength":255},"description":{"type":["string","null"],"maxLength":5000}}},"fr":{"type":"object","properties":{"name":{"type":["string","null"],"maxLength":255},"description":{"type":["string","null"],"maxLength":5000}}},"it":{"type":"object","properties":{"name":{"type":["string","null"],"maxLength":255},"description":{"type":["string","null"],"maxLength":5000}}}},"required":["de","en","fr","it"]}},"required":["hoursPerWeek","holidaysPerYear","monday","tuesday","wednesday","thursday","friday","saturday","sunday","translations"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Work Model Resource","properties":{"uuid":{"type":"string","format":"uuid"},"isSystem":{"type":"boolean"},"hoursPerWeek":{"type":"number"},"holidaysPerYear":{"type":"number"},"monday":{"type":"boolean"},"tuesday":{"type":"boolean"},"wednesday":{"type":"boolean"},"thursday":{"type":"boolean"},"friday":{"type":"boolean"},"saturday":{"type":"boolean"},"sunday":{"type":"boolean"},"isUsed":{"type":"boolean"},"translations":{"properties":{"de":{"properties":{"description":{"type":"string"},"name":{"type":"string"}},"type":"object"},"en":{"properties":{"description":{"type":"string"},"name":{"type":"string"}},"type":"object"},"fr":{"properties":{"description":{"type":"string"},"name":{"type":"string"}},"type":"object"},"it":{"properties":{"description":{"type":"string"},"name":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"6d7c143e1157af8c9bea2e1c2521115f","x-required-scopes":["time-tracking"]},"delete":{"tags":["time-tracking_time-tracking-settings"],"summary":"Delete work model","description":"Delete a work model of an account","operationId":"time_delete_work_models","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"workModelUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"09d983fbda2e4f596601a9930e127150","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employee-organigram/graphs/org-chart/config":{"get":{"tags":["time-tracking_time-tracking-employee-organigram"],"summary":"Get base config for OrgChart","description":"Get base config for OrgChart","operationId":"time_list_config","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"title":"Employee Organigram base config Resource","properties":{"endpoints":{"required":["list","detail","settings"],"properties":{"list":{"description":"The structure of this resource is mainly controlled externally by the orgChart application\nChanges need to be discussed/checked first with orgChart frontend","type":"string","format":"url"},"detail":{"type":"string","format":"url"},"settings":{"type":"string","format":"url"}},"type":"object"},"faviconUrl":{"type":"string","format":"url"},"imagePath":{"type":"string","format":"url"},"logoUrl":{"type":["string","null"],"format":"url"},"permissions":{"type":"array","items":{"title":"Employee organigram base config permission resource","properties":{"key":{"description":"The structure of this resource is mainly controlled externally by the orgChart application\nChanges need to be discussed/checked first with orgChart frontend","type":"string"},"mode":{"type":"array","items":{"type":"string","enum":["READ","WRITE"]}}},"type":"object"}}},"type":"object"}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"013c4eb3046d1e83b1198c00ea7e29d1","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employee-organigram/graphs/org-chart/settings":{"get":{"tags":["time-tracking_time-tracking-employee-organigram"],"summary":"Get settings for OrgChart","description":"Get account-based settings for OrgChart","operationId":"time_list_settings","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"43d850a9a571a760877e4754bb0679cd","x-required-scopes":["time-tracking"]},"put":{"tags":["time-tracking_time-tracking-employee-organigram"],"summary":"Replace settings for OrgChart","description":"Replace account-based settings for OrgChart","operationId":"time_update_settings","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/orgchart-settings.schema.json","description":"A schema for OrgChart settings","type":"object","properties":{"version":{"type":"integer","const":1},"chart":{"type":"object","properties":{"initialMode":{"type":"string","enum":["collapsed","level-1","level-2"]},"nodeTypes":{"type":"object","propertyNames":{"type":"string","enum":["orgUnit","partner","assistant","employee"]},"additionalProperties":{"type":"object","properties":{"groupTitle":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"image":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"jobDescription":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"theme":{"type":"object","properties":{"dark":{"type":"object","properties":{"tokens":{"type":"object","properties":{"backgroundColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"badgeColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"badgeTextColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"fontColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}},"required":["backgroundColor","badgeColor","badgeTextColor","fontColor"],"additionalProperties":false}},"required":["tokens"],"additionalProperties":false},"light":{"type":"object","properties":{"tokens":{"type":"object","properties":{"backgroundColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"badgeColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"badgeTextColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"fontColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}},"required":["backgroundColor","badgeColor","badgeTextColor","fontColor"],"additionalProperties":false}},"required":["tokens"],"additionalProperties":false}},"required":["dark","light"],"additionalProperties":false}},"required":["groupTitle","image","jobDescription","theme"],"additionalProperties":false},"required":["orgUnit","partner","assistant","employee"]}},"required":["initialMode","nodeTypes"],"additionalProperties":false},"features":{"type":"object","properties":{"breadcrumb":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"appBar":{"type":"object","properties":{"collapse":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"search":{"type":"object","properties":{"show":{"type":"boolean"},"groupTitle":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"jobDescription":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false}},"required":["show","groupTitle","jobDescription"],"additionalProperties":false},"theme":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"zoom":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false}},"required":["collapse","search","theme","zoom"],"additionalProperties":false},"detailView":{"type":"object","properties":{"show":{"type":"boolean"},"groupTitle":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"image":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"jobDescription":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false}},"required":["show","groupTitle","image","jobDescription"],"additionalProperties":false},"sidebar":{"type":"object","properties":{"show":{"type":"boolean"},"search":{"type":"object","properties":{"show":{"type":"boolean"},"groupTitle":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"jobDescription":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false}},"required":["show","groupTitle","jobDescription"],"additionalProperties":false}},"required":["show","search"],"additionalProperties":false}},"required":["breadcrumb","appBar","detailView","sidebar"],"additionalProperties":false},"theme":{"type":"object","properties":{"dark":{"type":"object","properties":{"tokens":{"type":"object","properties":{"onPrimary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"primary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}},"required":["onPrimary","primary"],"additionalProperties":false}},"required":["tokens"],"additionalProperties":false},"light":{"type":"object","properties":{"tokens":{"type":"object","properties":{"onPrimary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"primary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}},"required":["onPrimary","primary"],"additionalProperties":false}},"required":["tokens"],"additionalProperties":false}},"required":["dark","light"],"additionalProperties":false}},"required":["version","chart","features","theme"],"additionalProperties":false,"$defs":{"chartSettings":{"type":"object","properties":{"initialMode":{"type":"string","enum":["collapsed","level-1","level-2"]},"nodeTypes":{"type":"object","propertyNames":{"type":"string","enum":["orgUnit","partner","assistant","employee"]},"additionalProperties":{"type":"object","properties":{"groupTitle":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"image":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"jobDescription":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"theme":{"type":"object","properties":{"dark":{"type":"object","properties":{"tokens":{"type":"object","properties":{"backgroundColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"badgeColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"badgeTextColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"fontColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}},"required":["backgroundColor","badgeColor","badgeTextColor","fontColor"],"additionalProperties":false}},"required":["tokens"],"additionalProperties":false},"light":{"type":"object","properties":{"tokens":{"type":"object","properties":{"backgroundColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"badgeColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"badgeTextColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"fontColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}},"required":["backgroundColor","badgeColor","badgeTextColor","fontColor"],"additionalProperties":false}},"required":["tokens"],"additionalProperties":false}},"required":["dark","light"],"additionalProperties":false}},"required":["groupTitle","image","jobDescription","theme"],"additionalProperties":false},"required":["orgUnit","partner","assistant","employee"]}},"required":["initialMode","nodeTypes"],"additionalProperties":false},"showSettings":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"themeModeSettings":{"type":"object","properties":{"tokens":{"type":"object","properties":{"backgroundColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"badgeColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"badgeTextColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"fontColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}},"required":["backgroundColor","badgeColor","badgeTextColor","fontColor"],"additionalProperties":false}},"required":["tokens"],"additionalProperties":false},"colorField":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"featuresSettings":{"type":"object","properties":{"breadcrumb":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"appBar":{"type":"object","properties":{"collapse":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"search":{"type":"object","properties":{"show":{"type":"boolean"},"groupTitle":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"jobDescription":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false}},"required":["show","groupTitle","jobDescription"],"additionalProperties":false},"theme":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"zoom":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false}},"required":["collapse","search","theme","zoom"],"additionalProperties":false},"detailView":{"type":"object","properties":{"show":{"type":"boolean"},"groupTitle":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"image":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"jobDescription":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false}},"required":["show","groupTitle","image","jobDescription"],"additionalProperties":false},"sidebar":{"type":"object","properties":{"show":{"type":"boolean"},"search":{"type":"object","properties":{"show":{"type":"boolean"},"groupTitle":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"jobDescription":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false}},"required":["show","groupTitle","jobDescription"],"additionalProperties":false}},"required":["show","search"],"additionalProperties":false}},"required":["breadcrumb","appBar","detailView","sidebar"],"additionalProperties":false},"searchSettings":{"type":"object","properties":{"show":{"type":"boolean"},"groupTitle":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"jobDescription":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false}},"required":["show","groupTitle","jobDescription"],"additionalProperties":false},"themeSettings":{"type":"object","properties":{"dark":{"type":"object","properties":{"tokens":{"type":"object","properties":{"onPrimary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"primary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}},"required":["onPrimary","primary"],"additionalProperties":false}},"required":["tokens"],"additionalProperties":false},"light":{"type":"object","properties":{"tokens":{"type":"object","properties":{"onPrimary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"primary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}},"required":["onPrimary","primary"],"additionalProperties":false}},"required":["tokens"],"additionalProperties":false}},"required":["dark","light"],"additionalProperties":false},"primaryThemeSettings":{"type":"object","properties":{"tokens":{"type":"object","properties":{"onPrimary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"primary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}},"required":["onPrimary","primary"],"additionalProperties":false}},"required":["tokens"],"additionalProperties":false}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/orgchart-settings.schema.json","description":"A schema for OrgChart settings","type":"object","properties":{"version":{"type":"integer","const":1},"chart":{"type":"object","properties":{"initialMode":{"type":"string","enum":["collapsed","level-1","level-2"]},"nodeTypes":{"type":"object","propertyNames":{"type":"string","enum":["orgUnit","partner","assistant","employee"]},"additionalProperties":{"type":"object","properties":{"groupTitle":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"image":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"jobDescription":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"theme":{"type":"object","properties":{"dark":{"type":"object","properties":{"tokens":{"type":"object","properties":{"backgroundColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"badgeColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"badgeTextColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"fontColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}},"required":["backgroundColor","badgeColor","badgeTextColor","fontColor"],"additionalProperties":false}},"required":["tokens"],"additionalProperties":false},"light":{"type":"object","properties":{"tokens":{"type":"object","properties":{"backgroundColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"badgeColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"badgeTextColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"fontColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}},"required":["backgroundColor","badgeColor","badgeTextColor","fontColor"],"additionalProperties":false}},"required":["tokens"],"additionalProperties":false}},"required":["dark","light"],"additionalProperties":false}},"required":["groupTitle","image","jobDescription","theme"],"additionalProperties":false},"required":["orgUnit","partner","assistant","employee"]}},"required":["initialMode","nodeTypes"],"additionalProperties":false},"features":{"type":"object","properties":{"breadcrumb":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"appBar":{"type":"object","properties":{"collapse":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"search":{"type":"object","properties":{"show":{"type":"boolean"},"groupTitle":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"jobDescription":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false}},"required":["show","groupTitle","jobDescription"],"additionalProperties":false},"theme":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"zoom":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false}},"required":["collapse","search","theme","zoom"],"additionalProperties":false},"detailView":{"type":"object","properties":{"show":{"type":"boolean"},"groupTitle":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"image":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"jobDescription":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false}},"required":["show","groupTitle","image","jobDescription"],"additionalProperties":false},"sidebar":{"type":"object","properties":{"show":{"type":"boolean"},"search":{"type":"object","properties":{"show":{"type":"boolean"},"groupTitle":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"jobDescription":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false}},"required":["show","groupTitle","jobDescription"],"additionalProperties":false}},"required":["show","search"],"additionalProperties":false}},"required":["breadcrumb","appBar","detailView","sidebar"],"additionalProperties":false},"theme":{"type":"object","properties":{"dark":{"type":"object","properties":{"tokens":{"type":"object","properties":{"onPrimary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"primary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}},"required":["onPrimary","primary"],"additionalProperties":false}},"required":["tokens"],"additionalProperties":false},"light":{"type":"object","properties":{"tokens":{"type":"object","properties":{"onPrimary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"primary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}},"required":["onPrimary","primary"],"additionalProperties":false}},"required":["tokens"],"additionalProperties":false}},"required":["dark","light"],"additionalProperties":false}},"required":["version","chart","features","theme"],"additionalProperties":false,"$defs":{"chartSettings":{"type":"object","properties":{"initialMode":{"type":"string","enum":["collapsed","level-1","level-2"]},"nodeTypes":{"type":"object","propertyNames":{"type":"string","enum":["orgUnit","partner","assistant","employee"]},"additionalProperties":{"type":"object","properties":{"groupTitle":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"image":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"jobDescription":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"theme":{"type":"object","properties":{"dark":{"type":"object","properties":{"tokens":{"type":"object","properties":{"backgroundColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"badgeColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"badgeTextColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"fontColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}},"required":["backgroundColor","badgeColor","badgeTextColor","fontColor"],"additionalProperties":false}},"required":["tokens"],"additionalProperties":false},"light":{"type":"object","properties":{"tokens":{"type":"object","properties":{"backgroundColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"badgeColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"badgeTextColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"fontColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}},"required":["backgroundColor","badgeColor","badgeTextColor","fontColor"],"additionalProperties":false}},"required":["tokens"],"additionalProperties":false}},"required":["dark","light"],"additionalProperties":false}},"required":["groupTitle","image","jobDescription","theme"],"additionalProperties":false},"required":["orgUnit","partner","assistant","employee"]}},"required":["initialMode","nodeTypes"],"additionalProperties":false},"showSettings":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"themeModeSettings":{"type":"object","properties":{"tokens":{"type":"object","properties":{"backgroundColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"badgeColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"badgeTextColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"fontColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}},"required":["backgroundColor","badgeColor","badgeTextColor","fontColor"],"additionalProperties":false}},"required":["tokens"],"additionalProperties":false},"colorField":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"featuresSettings":{"type":"object","properties":{"breadcrumb":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"appBar":{"type":"object","properties":{"collapse":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"search":{"type":"object","properties":{"show":{"type":"boolean"},"groupTitle":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"jobDescription":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false}},"required":["show","groupTitle","jobDescription"],"additionalProperties":false},"theme":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"zoom":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false}},"required":["collapse","search","theme","zoom"],"additionalProperties":false},"detailView":{"type":"object","properties":{"show":{"type":"boolean"},"groupTitle":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"image":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"jobDescription":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false}},"required":["show","groupTitle","image","jobDescription"],"additionalProperties":false},"sidebar":{"type":"object","properties":{"show":{"type":"boolean"},"search":{"type":"object","properties":{"show":{"type":"boolean"},"groupTitle":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"jobDescription":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false}},"required":["show","groupTitle","jobDescription"],"additionalProperties":false}},"required":["show","search"],"additionalProperties":false}},"required":["breadcrumb","appBar","detailView","sidebar"],"additionalProperties":false},"searchSettings":{"type":"object","properties":{"show":{"type":"boolean"},"groupTitle":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false},"jobDescription":{"type":"object","properties":{"show":{"type":"boolean"}},"required":["show"],"additionalProperties":false}},"required":["show","groupTitle","jobDescription"],"additionalProperties":false},"themeSettings":{"type":"object","properties":{"dark":{"type":"object","properties":{"tokens":{"type":"object","properties":{"onPrimary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"primary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}},"required":["onPrimary","primary"],"additionalProperties":false}},"required":["tokens"],"additionalProperties":false},"light":{"type":"object","properties":{"tokens":{"type":"object","properties":{"onPrimary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"primary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}},"required":["onPrimary","primary"],"additionalProperties":false}},"required":["tokens"],"additionalProperties":false}},"required":["dark","light"],"additionalProperties":false},"primaryThemeSettings":{"type":"object","properties":{"tokens":{"type":"object","properties":{"onPrimary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"primary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}},"required":["onPrimary","primary"],"additionalProperties":false}},"required":["tokens"],"additionalProperties":false}}}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"8d097edaef34f4bd02f2fa134ad30038","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/activities/{activityUuid}":{"get":{"tags":["time-tracking_time-tracking-activities"],"summary":"Get activity","description":"Get the activity of an employee","operationId":"time_get_activities","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"activityUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Activity Resource","properties":{"uuid":{"type":"string","format":"uuid"},"accountUuid":{"type":"string","format":"uuid"},"employeeUuid":{"type":"string","format":"uuid"},"activityTypeUuid":{"type":["string","null"],"format":"uuid"},"addressUuid":{"type":["string","null"],"format":"uuid"},"addressDescription":{"type":"string","deprecated":true},"productUuid":{"type":["string","null"],"format":"uuid"},"productKey":{"type":["string","null"],"deprecated":true},"productDescription":{"type":["string","null"],"deprecated":true},"startDate":{"type":"string","format":"date","deprecated":true},"endDate":{"type":"string","format":"date","deprecated":true},"startTime":{"type":"string","deprecated":true},"endTime":{"type":"string","deprecated":true},"startDateTime":{"description":"ISO8601 local time","type":"string","example":"2024-01-14T20:20:00"},"endDateTime":{"description":"ISO8601 local time","type":"string","example":"2024-01-14T21:00:00"},"halfDay":{"type":"boolean"},"description":{"type":["string","null"]},"contractNoteId":{"type":["integer","null"],"deprecated":true},"contractNoteUuid":{"type":["string","null"],"format":"uuid"},"isInvoiced":{"type":"boolean","deprecated":true},"isClosed":{"type":"boolean"},"closedAt":{"type":["string","null"],"deprecated":true},"closedAtDateTime":{"description":"ISO8601 local time","type":["string","null"],"format":"date-time","example":"2024-01-31T13:00:00"},"contractNoteName":{"type":["string","null"],"deprecated":true},"poNumber":{"type":["string","null"],"deprecated":true}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"f16a63369ed653063051cb4641e1d21e","x-required-scopes":["time-tracking"]},"patch":{"tags":["time-tracking_time-tracking-activities"],"summary":"Update activity","description":"Update an activity for an employee","operationId":"time_update_activities","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"activityUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update activity","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/time-employee-activity.schema.json","description":"A Schema for creating/updating timetracking employee activity in AbaNinja over API","type":"object","properties":{"activityTypeUuid":{"type":"string","format":"uuid"},"startDate":{"type":"string","format":"date"},"endDate":{"type":"string","format":"date"},"startTime":{"type":"string","pattern":"^(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])$","example":"14:35"},"endTime":{"type":"string","pattern":"^(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])$","example":"15:45"},"halfDay":{"type":"boolean"},"addressUuid":{"type":["string","null"],"format":"uuid"},"contractNoteUuid":{"type":["string","null"],"format":"uuid"},"productUuid":{"type":["string","null"],"format":"uuid"},"description":{"type":["string","null"],"maxLength":5000}},"required":["activityTypeUuid","startDate","endDate","startTime","endTime","halfDay"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Activity Resource","properties":{"uuid":{"type":"string","format":"uuid"},"accountUuid":{"type":"string","format":"uuid"},"employeeUuid":{"type":"string","format":"uuid"},"activityTypeUuid":{"type":["string","null"],"format":"uuid"},"addressUuid":{"type":["string","null"],"format":"uuid"},"addressDescription":{"type":"string","deprecated":true},"productUuid":{"type":["string","null"],"format":"uuid"},"productKey":{"type":["string","null"],"deprecated":true},"productDescription":{"type":["string","null"],"deprecated":true},"startDate":{"type":"string","format":"date","deprecated":true},"endDate":{"type":"string","format":"date","deprecated":true},"startTime":{"type":"string","deprecated":true},"endTime":{"type":"string","deprecated":true},"startDateTime":{"description":"ISO8601 local time","type":"string","example":"2024-01-14T20:20:00"},"endDateTime":{"description":"ISO8601 local time","type":"string","example":"2024-01-14T21:00:00"},"halfDay":{"type":"boolean"},"description":{"type":["string","null"]},"contractNoteId":{"type":["integer","null"],"deprecated":true},"contractNoteUuid":{"type":["string","null"],"format":"uuid"},"isInvoiced":{"type":"boolean","deprecated":true},"isClosed":{"type":"boolean"},"closedAt":{"type":["string","null"],"deprecated":true},"closedAtDateTime":{"description":"ISO8601 local time","type":["string","null"],"format":"date-time","example":"2024-01-31T13:00:00"},"contractNoteName":{"type":["string","null"],"deprecated":true},"poNumber":{"type":["string","null"],"deprecated":true}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"cc9c50be3263112eeaf66b1a4e9f3b0d","x-required-scopes":["time-tracking"]},"delete":{"tags":["time-tracking_time-tracking-activities"],"summary":"Delete activity","description":"Delete an activity for an employee","operationId":"time_delete_activities","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"activityUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"9e2c66989f7d589d11a9a66571529e7f","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/attachments/{attachmentUuid}":{"delete":{"tags":["time-tracking_time-tracking-employees"],"summary":"Delete attachment","description":"Delete an attachment of an employee","operationId":"time_delete_attachments","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"attachmentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"c00817a49685aa4dce335a10a6821268","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/closures/{closureUuid}":{"delete":{"tags":["time-tracking_time-tracking-closures"],"summary":"Delete closure","description":"Delete a closure for an employee","operationId":"time_delete_closures","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"closureUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"00570eda9902bbe79c217c65a6a5533e","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/closures/last-closure-date":{"get":{"tags":["time-tracking_time-tracking-closures"],"summary":"Get last closure date","description":"Get the date of the last closure of an employee","operationId":"time_list_last_closure_date","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Last Employee Closure Resource","properties":{"timeTrackingStart":{"type":["string","null"],"format":"date"},"lastClosureDate":{"type":["string","null"],"format":"date"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"259b7587df2456c8a89dc25f5026b92f","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/contracts/{contractUuid}":{"get":{"tags":["time-tracking_time-tracking-contracts"],"summary":"Get contract","description":"Get the contract of an employee","operationId":"time_get_contracts","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"contractUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Employee Contract Resource","properties":{"uuid":{"type":"string","format":"uuid"},"monday":{"type":"boolean"},"tuesday":{"type":"boolean"},"wednesday":{"type":"boolean"},"thursday":{"type":"boolean"},"friday":{"type":"boolean"},"saturday":{"type":"boolean"},"sunday":{"type":"boolean"},"validFromDate":{"type":["string","null"],"format":"date"},"validToDate":{"type":["string","null"],"format":"date"},"employeeWorkModelUuid":{"type":["string","null"],"format":"uuid"},"employmentFactor":{"type":"number"},"shortTimeWorkFactor":{"type":"number"},"workingDays":{"type":"integer"},"hoursPerWeek":{"type":"number"},"holidaysPerYear":{"type":"number"},"workingStateCode":{"type":["string","null"]},"workingStateName":{"type":["string","null"]},"workingCountryCode":{"type":["string","null"]},"workingCountryName":{"type":["string","null"]},"isClosed":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"fbc0268831a6f29b8eaceadc86dce04b","x-required-scopes":["time-tracking"]},"patch":{"tags":["time-tracking_time-tracking-contracts"],"summary":"Update contract","description":"Update a contract for an employee","operationId":"time_update_contracts","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"contractUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update contract","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/time-employee-contract.schema.json","description":"A Schema for creating/updating timetracking employee contract in AbaNinja over API","type":"object","properties":{"monday":{"type":"boolean"},"tuesday":{"type":"boolean"},"wednesday":{"type":"boolean"},"thursday":{"type":"boolean"},"friday":{"type":"boolean"},"saturday":{"type":"boolean"},"sunday":{"type":"boolean"},"validFromDate":{"type":"string","format":"date"},"validToDate":{"type":["string","null"],"format":"date"},"employeeWorkModelUuid":{"type":"string","format":"uuid"},"employmentFactor":{"type":["number","null"]},"shortTimeWorkFactor":{"type":"number"},"workingCountryCode":{"type":"string"},"workingStateCode":{"type":"string"},"hoursPerWeek":{"type":"number"},"holidaysPerYear":{"type":"number"}},"required":["monday","tuesday","wednesday","thursday","friday","saturday","sunday","validFromDate","employeeWorkModelUuid","employmentFactor","shortTimeWorkFactor","workingCountryCode","workingStateCode","hoursPerWeek","holidaysPerYear"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Employee Contract Resource","properties":{"uuid":{"type":"string","format":"uuid"},"monday":{"type":"boolean"},"tuesday":{"type":"boolean"},"wednesday":{"type":"boolean"},"thursday":{"type":"boolean"},"friday":{"type":"boolean"},"saturday":{"type":"boolean"},"sunday":{"type":"boolean"},"validFromDate":{"type":["string","null"],"format":"date"},"validToDate":{"type":["string","null"],"format":"date"},"employeeWorkModelUuid":{"type":["string","null"],"format":"uuid"},"employmentFactor":{"type":"number"},"shortTimeWorkFactor":{"type":"number"},"workingDays":{"type":"integer"},"hoursPerWeek":{"type":"number"},"holidaysPerYear":{"type":"number"},"workingStateCode":{"type":["string","null"]},"workingStateName":{"type":["string","null"]},"workingCountryCode":{"type":["string","null"]},"workingCountryName":{"type":["string","null"]},"isClosed":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"d667079ba725dba456e9b6849a54cc41","x-required-scopes":["time-tracking"]},"delete":{"tags":["time-tracking_time-tracking-contracts"],"summary":"Delete contract","description":"Delete a contract for an employee","operationId":"time_delete_contracts","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"contractUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"53cc89e4f75636cbc4272c58d7aebd6c","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/contracts/allowed-days":{"get":{"tags":["time-tracking_time-tracking-contracts"],"summary":"Get allowed contract days","description":"Get the allowed contract days of an employee","operationId":"time_list_allowed_days","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Employee Contract Allowed Days Resource","properties":{"earliestDate":{"type":"string","format":"date"},"startDays":{"type":"array","items":{"type":"string","format":"date"}},"endDays":{"type":"array","items":{"type":"string","format":"date"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"896ffb4d3aacbe9aec16dac989095f02","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/contracts/last-contract":{"get":{"tags":["time-tracking_time-tracking-contracts"],"summary":"Get last contract","description":"Get the last contract of an employee","operationId":"time_list_last_contract","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Employee Contract Resource","properties":{"uuid":{"type":"string","format":"uuid"},"monday":{"type":"boolean"},"tuesday":{"type":"boolean"},"wednesday":{"type":"boolean"},"thursday":{"type":"boolean"},"friday":{"type":"boolean"},"saturday":{"type":"boolean"},"sunday":{"type":"boolean"},"validFromDate":{"type":["string","null"],"format":"date"},"validToDate":{"type":["string","null"],"format":"date"},"employeeWorkModelUuid":{"type":["string","null"],"format":"uuid"},"employmentFactor":{"type":"number"},"shortTimeWorkFactor":{"type":"number"},"workingDays":{"type":"integer"},"hoursPerWeek":{"type":"number"},"holidaysPerYear":{"type":"number"},"workingStateCode":{"type":["string","null"]},"workingStateName":{"type":["string","null"]},"workingCountryCode":{"type":["string","null"]},"workingCountryName":{"type":["string","null"]},"isClosed":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"9e6169a025794a4bd7a807bf7c48dcc1","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/daily/{date}":{"get":{"tags":["time-tracking_time-tracking-employee-statistics"],"summary":"Get daily entries","description":"Get the daily entries of an employee","operationId":"time_get_daily","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"date","in":"path","required":true,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Daily Entry Resource","properties":{"uuid":{"description":"Represents the UUID for activityUuid or inOutUuid, depends on the typeId","type":["string","null"],"format":"uuid","deprecated":true},"addressUuid":{"type":["string","null"],"format":"uuid","deprecated":true},"addressName":{"type":["string","null"],"deprecated":true},"comment":{"type":["string","null"],"deprecated":true},"contractNoteName":{"type":["string","null"],"deprecated":true},"duration":{"properties":{"workDays":{"type":"number","deprecated":true},"hours":{"type":"number","deprecated":true},"minutes":{"type":"number","deprecated":true}},"type":["object","null"],"deprecated":true},"startDevice":{"type":["string","null"],"deprecated":true},"endDevice":{"type":["string","null"],"deprecated":true},"contractNoteId":{"type":["integer","null"],"deprecated":true},"contractNoteUuid":{"type":["string","null"],"format":"uuid","deprecated":true},"startTime":{"type":["string","null"],"example":"07:00","deprecated":true},"endTime":{"type":["string","null"],"example":"19:00","deprecated":true},"typeName":{"description":"Translated activity name","type":["string","null"],"deprecated":true},"typeId":{"description":"0 = in&out, 1 = activity, 2 = vacation","type":["integer","null"],"deprecated":true,"enum":[0,1,2]},"isDeletable":{"type":"boolean","deprecated":true}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"89fee812f5589e3f3ef71ce972ec260b","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/in-out/{inOutUuid}":{"get":{"tags":["time-tracking_time-tracking-timestamps"],"summary":"Get timestamp","description":"Get the timestamp of an employee","operationId":"time_get_in_out","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"inOutUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Timestamp Resource","properties":{"uuid":{"type":"string","format":"uuid"},"date":{"type":"string","format":"date","deprecated":true},"startTime":{"type":"string","deprecated":true},"endTime":{"type":"string","deprecated":true},"startDateTime":{"description":"ISO8601 local time","type":"string","example":"2024-01-14T20:20:00"},"endDateTime":{"description":"ISO8601 local time","type":["string","null"],"example":"2024-01-14T21:00:00"},"startDevice":{"type":["string","null"]},"endDevice":{"type":["string","null"]},"type":{"type":"string","deprecated":true},"comment":{"type":"string"},"isClosed":{"type":"boolean"},"closedAt":{"type":["string","null"],"deprecated":true},"closedAtDateTime":{"description":"ISO8601 local time","type":["string","null"],"format":"date-time","example":"2024-01-31T13:00:00"},"duration":{"properties":{"hours":{"type":"string"},"minutes":{"type":"string"}},"type":["object","null"],"deprecated":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"764fd6f263df2e4f83d2918c23782427","x-required-scopes":["time-tracking"]},"patch":{"tags":["time-tracking_time-tracking-timestamps"],"summary":"Update timestamp","description":"Update a timestamp for an employee","operationId":"time_update_in_out","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"inOutUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update timestamp","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/time-employee-inout.update.schema.json","description":"A Schema for updating timetracking employee in&out in AbaNinja over API","type":"object","properties":{"date":{"type":"string","format":"date"},"startTime":{"type":"string","pattern":"^(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])$"},"endTime":{"type":["string","null"],"pattern":"^(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])$"},"comment":{"type":["string","null"]},"device":{"type":["string","null"]}},"required":[],"dependentRequired":{"startTime":["date"],"endTime":["date"]}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Timestamp Resource","properties":{"uuid":{"type":"string","format":"uuid"},"date":{"type":"string","format":"date","deprecated":true},"startTime":{"type":"string","deprecated":true},"endTime":{"type":"string","deprecated":true},"startDateTime":{"description":"ISO8601 local time","type":"string","example":"2024-01-14T20:20:00"},"endDateTime":{"description":"ISO8601 local time","type":["string","null"],"example":"2024-01-14T21:00:00"},"startDevice":{"type":["string","null"]},"endDevice":{"type":["string","null"]},"type":{"type":"string","deprecated":true},"comment":{"type":"string"},"isClosed":{"type":"boolean"},"closedAt":{"type":["string","null"],"deprecated":true},"closedAtDateTime":{"description":"ISO8601 local time","type":["string","null"],"format":"date-time","example":"2024-01-31T13:00:00"},"duration":{"properties":{"hours":{"type":"string"},"minutes":{"type":"string"}},"type":["object","null"],"deprecated":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"b798b67d488129baff6f8aec0866c37b","x-required-scopes":["time-tracking"]},"delete":{"tags":["time-tracking_time-tracking-timestamps"],"summary":"Delete timestamp","description":"Delete a timestamp for an employee","operationId":"time_delete_in_out","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"inOutUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"003d9e2f0547b7df9b6ee614efaf49a4","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/in-out/currently-open":{"get":{"tags":["time-tracking_time-tracking-timestamps"],"summary":"Get currently open timestamp","description":"Get the relevant currently open timestamp of an employee","operationId":"time_list_currently_open","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Timestamp Resource","properties":{"uuid":{"type":"string","format":"uuid"},"date":{"type":"string","format":"date","deprecated":true},"startTime":{"type":"string","deprecated":true},"endTime":{"type":"string","deprecated":true},"startDateTime":{"description":"ISO8601 local time","type":"string","example":"2024-01-14T20:20:00"},"endDateTime":{"description":"ISO8601 local time","type":["string","null"],"example":"2024-01-14T21:00:00"},"startDevice":{"type":["string","null"]},"endDevice":{"type":["string","null"]},"type":{"type":"string","deprecated":true},"comment":{"type":"string"},"isClosed":{"type":"boolean"},"closedAt":{"type":["string","null"],"deprecated":true},"closedAtDateTime":{"description":"ISO8601 local time","type":["string","null"],"format":"date-time","example":"2024-01-31T13:00:00"},"duration":{"properties":{"hours":{"type":"string"},"minutes":{"type":"string"}},"type":["object","null"],"deprecated":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"204":{"description":"Successful response, no timestamp found"},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"dfad3b952e0cf0643b1bf81655f11474","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/in-out/open-days":{"get":{"tags":["time-tracking_time-tracking-timestamps"],"summary":"Get past days with open timestamps","description":"Get past days of an employee that have open timestamps","operationId":"time_list_open_days","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"date","in":"query","required":false,"schema":{"description":"date to search until, defaults to yesterday","type":["string","null"],"format":"date","default":null}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"type":"string","format":"date"}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"b13f7871d77731aeba6183357f74d7f5","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/in-out/timestamp-event":{"post":{"tags":["time-tracking_time-tracking-timestamps"],"summary":"Add timestamp event","description":"Process a start or stop timestamp event","operationId":"time_create_timestamp_event","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Add timestamp event","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/time-employee-inout-timestamp-event.create.schema.json","description":"A Schema for creating timestamp events in AbaNinja over the API","type":"object","properties":{"dateTime":{"type":"string","description":"ISO8601 local time with seconds reset","examples":["2024-01-14T20:20:00"]},"eventType":{"enum":["START","STOP"]},"device":{"type":["string","null"]}},"required":["dateTime","eventType"]}}}},"responses":{"200":{"description":"Successfully processed","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Timestamp Resource","properties":{"uuid":{"type":"string","format":"uuid"},"date":{"type":"string","format":"date","deprecated":true},"startTime":{"type":"string","deprecated":true},"endTime":{"type":"string","deprecated":true},"startDateTime":{"description":"ISO8601 local time","type":"string","example":"2024-01-14T20:20:00"},"endDateTime":{"description":"ISO8601 local time","type":["string","null"],"example":"2024-01-14T21:00:00"},"startDevice":{"type":["string","null"]},"endDevice":{"type":["string","null"]},"type":{"type":"string","deprecated":true},"comment":{"type":"string"},"isClosed":{"type":"boolean"},"closedAt":{"type":["string","null"],"deprecated":true},"closedAtDateTime":{"description":"ISO8601 local time","type":["string","null"],"format":"date-time","example":"2024-01-31T13:00:00"},"duration":{"properties":{"hours":{"type":"string"},"minutes":{"type":"string"}},"type":["object","null"],"deprecated":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"08497ea5dbbe9b21c9de65ee49c538c6","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/relations/available-parents":{"get":{"tags":["time-tracking_time-tracking-employee-organigram"],"summary":"Get available parents for employee","description":"Get available parent employees for an employee","operationId":"time_list_available_parents","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Employee Minimal Resource","properties":{"uuid":{"type":"string","format":"uuid"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"jobTitle":{"type":["string","null"]},"employeeNumber":{"type":"string"},"employeeGroup":{"properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"}},"type":"object"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"f3dc1092b6cbda6c0d077a3fcb12a94f","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/relations/parent":{"get":{"tags":["time-tracking_time-tracking-employee-organigram"],"summary":"Get related parent for employee","description":"Get the related parent employee for an employee","operationId":"time_list_parent","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Employee Parent Relation Resource","properties":{"parentEmployeeUuid":{"type":["string","null"],"format":"uuid"},"relationshipType":{"type":["string","null"],"enum":["assistant","employee","partner"]}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"080012a505ed471b85261543e201f47f","x-required-scopes":["time-tracking"]},"patch":{"tags":["time-tracking_time-tracking-employee-organigram"],"summary":"Set related parent for employee","description":"Set the related parent employee for an employee","operationId":"time_update_parent","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Set parent relation","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/time-employee-set-parent-relation.schema.json","description":"A Schema for setting the parent relation of an employee","type":"object","properties":{"parentEmployeeUuid":{"type":["string","null"],"format":"uuid"},"relationshipType":{"type":["string","null"],"enum":[null,"assistant","partner","employee"]}},"required":["parentEmployeeUuid"],"additionalProperties":false,"if":{"properties":{"parentEmployeeUuid":{"type":"null"}}},"then":{"properties":{"relationshipType":{"type":"null"}}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Employee Parent Relation Resource","properties":{"parentEmployeeUuid":{"type":["string","null"],"format":"uuid"},"relationshipType":{"type":["string","null"],"enum":["assistant","employee","partner"]}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"468032f0dada7b2624f1930a6ee70764","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/time-corrections/{correctionUuid}":{"get":{"tags":["time-tracking_time-tracking-corrections"],"summary":"Get correction","description":"Get the correction of an employee","operationId":"time_get_time_corrections","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"correctionUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Correction Resource","properties":{"uuid":{"type":"string","format":"uuid"},"accountUuid":{"type":"string","format":"uuid"},"employeeUuid":{"type":"string","format":"uuid"},"type":{"description":"1 = Timecorrection, 2 = Holidaycorrection","type":"integer","enum":[1,2]},"isClosed":{"type":"boolean"},"bookingDate":{"type":"string","format":"date"},"bookingQty":{"type":"number"},"bookingUnit":{"type":"string","enum":["hrs","day"]},"bookingText":{"type":["string","null"]}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"799d41d06832f9114f74c907f42a3a79","x-required-scopes":["time-tracking"]},"patch":{"tags":["time-tracking_time-tracking-corrections"],"summary":"Update correction","description":"Update a correction for an employee","operationId":"time_update_time_corrections","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"correctionUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update correction","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/time-employee-correction.schema.json","description":"A Schema for creating/updating timetracking employee correction in AbaNinja over API","type":"object","properties":{"type":{"type":"integer","enum":[1,2],"description":"1 = Timecorrection, 2 = Holidaycorrection"},"bookingDate":{"type":"string","format":"date"},"bookingQty":{"type":"number"},"bookingUnit":{"type":"string","enum":["hrs","day"]},"bookingText":{"type":["string","null"]}},"required":["type","bookingDate","bookingQty","bookingUnit"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Correction Resource","properties":{"uuid":{"type":"string","format":"uuid"},"accountUuid":{"type":"string","format":"uuid"},"employeeUuid":{"type":"string","format":"uuid"},"type":{"description":"1 = Timecorrection, 2 = Holidaycorrection","type":"integer","enum":[1,2]},"isClosed":{"type":"boolean"},"bookingDate":{"type":"string","format":"date"},"bookingQty":{"type":"number"},"bookingUnit":{"type":"string","enum":["hrs","day"]},"bookingText":{"type":["string","null"]}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"f02c3457e41754a17c098bdee3bb024f","x-required-scopes":["time-tracking"]},"delete":{"tags":["time-tracking_time-tracking-corrections"],"summary":"Delete correction","description":"Delete a correction for an employee","operationId":"time_delete_time_corrections","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"correctionUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"236c4ab59a5ca1b2166d6d2febffba0e","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/activities/{activityUuid}/actions":{"get":{"tags":["time-tracking_time-tracking-activities"],"summary":"Get single actions","description":"Get the single actions of an activity","operationId":"time_list_actions","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"activityUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Single Employee Activity Action Resource","properties":{"key":{"type":"string"},"description":{"type":"string"},"isApplicable":{"type":"boolean"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"010c7b7da19dd6a55414a6980735faa9","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/daily/{date}/closed":{"get":{"tags":["time-tracking_time-tracking-employee-statistics"],"summary":"Check if day is closed","description":"Checks if the day is closed of an employee","operationId":"time_list_closed","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"date","in":"path","required":true,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Day Closed Resource","properties":{"isClosed":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"dea50d011820a290b49719ef82842972","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/daily/{date}/open-in-out":{"get":{"tags":["time-tracking_time-tracking-employee-statistics"],"summary":"Get daily open in out","description":"Get the daily open in out of an employee","operationId":"time_list_open_in_out","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"date","in":"path","required":true,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Daily Open In Out Resource","properties":{"uuid":{"type":"string","format":"uuid","deprecated":true},"startTime":{"type":"string","example":"19:00","deprecated":true},"comment":{"type":["string","null"],"deprecated":true}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"926aea6189b0155febd70dcdb7ff3e53","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/daily/{date}/target":{"get":{"tags":["time-tracking_time-tracking-employee-statistics"],"summary":"Get daily target","description":"Get the daily target of an employee","operationId":"time_list_target","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"date","in":"path","required":true,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Daily Target Resource","properties":{"targetTime":{"description":"target time in minutes","type":"number"},"workedTime":{"description":"worked time in minutes","type":"number"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"60131d4801c917c49aab7172bc28ffa0","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/daily/{date}/totals":{"get":{"tags":["time-tracking_time-tracking-employee-statistics"],"summary":"Get daily total","description":"Get the daily total of an employee","operationId":"time_list_totals","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"date","in":"path","required":true,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Daily Total Resource","properties":{"targetTime":{"properties":{"hours":{"type":"integer","deprecated":true},"minutes":{"type":"number","deprecated":true}},"type":["object","null"],"deprecated":true},"targetTimeDifference":{"properties":{"hours":{"type":"integer","deprecated":true},"minutes":{"type":"number","deprecated":true}},"type":["object","null"],"deprecated":true},"sectionTotal":{"properties":{"activity":{"properties":{"hours":{"type":"integer","deprecated":true},"minutes":{"type":"number","deprecated":true}},"type":["object","null"],"deprecated":true},"vacation":{"properties":{"hours":{"type":"integer","deprecated":true},"minutes":{"type":"number","deprecated":true}},"type":["object","null"],"deprecated":true},"inOut":{"properties":{"hours":{"type":"integer","deprecated":true},"minutes":{"type":"number","deprecated":true}},"type":["object","null"],"deprecated":true},"billingActivity":{"properties":{"hours":{"type":"integer","deprecated":true},"minutes":{"type":"number","deprecated":true}},"type":["object","null"],"deprecated":true},"absence":{"properties":{"hours":{"type":"integer","deprecated":true},"minutes":{"type":"number","deprecated":true}},"type":["object","null"],"deprecated":true},"shortWork":{"properties":{"hours":{"type":"integer","deprecated":true},"minutes":{"type":"number","deprecated":true}},"type":["object","null"],"deprecated":true},"holidays":{"type":"array","items":{"properties":{"name":{"type":"string","deprecated":true},"duration":{"properties":{"workDays":{"type":"number","deprecated":true}},"type":"object","deprecated":true}},"type":"object"},"deprecated":true}},"type":"object","deprecated":true},"flexTime":{"properties":{"hours":{"type":"integer","deprecated":true},"minutes":{"type":"number","deprecated":true}},"type":["object","null"],"deprecated":true}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/time-tracking"]}],"x-legacy-operation-id":"24d075b03e720bbf1455133890660cdd","x-required-scopes":["time-tracking"]}},"/accounts/{accountUuid}/units/v2/system-units":{"get":{"tags":["units_system-units"],"summary":"Get system units","description":"Get the system units","operationId":"units_list_system_units","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}},{"name":"search","in":"query","required":false,"schema":{"description":"search for system units","type":"string","maxLength":255}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"System Unit Resource","properties":{"uuid":{"type":"string","format":"uuid"},"unitCode":{"type":"string"},"unitCodeStandardized":{"description":"UN/ECE Rec20/21 compatible unit code, can differ to ensure standard compatibility","type":"string"},"translations":{"properties":{"de":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"}},"type":"object"},"en":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"}},"type":"object"},"fr":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"}},"type":"object"},"it":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products","https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"7ee815ca8ccc388272e3945b48ad5eec","x-required-scopes":["products","settings"]}},"/accounts/{accountUuid}/units/v2/units":{"get":{"tags":["units_account-units"],"summary":"Get account units","description":"Get the account units","operationId":"units_list_units","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}},{"name":"isActive","in":"query","required":false,"schema":{"description":"filter for active account units","type":"boolean"}},{"name":"isArchived","in":"query","required":false,"schema":{"description":"filter for archived account units","type":"boolean"}},{"name":"search","in":"query","required":false,"schema":{"description":"search for system units","type":"string","maxLength":255}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Account Unit Resource","properties":{"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"unitType":{"type":"string","enum":["custom-unit","system-unit"]},"isocode":{"type":["string","null"],"deprecated":true},"unitCode":{"type":["string","null"]},"active":{"type":"boolean","deprecated":true},"isActive":{"type":"boolean"},"isArchived":{"type":"boolean"},"hasMasterUnit":{"type":"boolean","deprecated":true},"systemUnitUuid":{"type":["string","null"],"format":"uuid"},"translations":{"properties":{"de":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"},"en":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"},"fr":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"},"it":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"}},"type":"object"}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products","https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"92ec17b02e844d0395fc23372e9e6293","x-required-scopes":["products","settings"]},"post":{"tags":["units_account-units"],"summary":"Create custom unit","description":"Create a custom unit","operationId":"units_create_units","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create custom unit","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/custom-unit.create.schema.json","description":"A Schema for creating custom units in AbaNinja over the API","type":"object","properties":{"isocode":{"type":["string","null"],"maxLength":10,"deprecated":true},"unitCode":{"type":["string","null"],"maxLength":10},"active":{"type":"boolean"},"translations":{"type":"object","properties":{"de":{"type":"object","properties":{"unit":{"type":"string","maxLength":20},"description":{"type":"string","maxLength":255,"deprecated":true},"unitDescription":{"type":"string","maxLength":255},"unitPlural":{"type":["string","null"],"maxLength":255}}},"en":{"type":"object","properties":{"unit":{"type":"string","maxLength":20},"description":{"type":"string","maxLength":255,"deprecated":true},"unitDescription":{"type":"string","maxLength":255},"unitPlural":{"type":["string","null"],"maxLength":255}}},"fr":{"type":"object","properties":{"unit":{"type":"string","maxLength":20},"description":{"type":"string","maxLength":255,"deprecated":true},"unitDescription":{"type":"string","maxLength":255},"unitPlural":{"type":["string","null"],"maxLength":255}}},"it":{"type":"object","properties":{"unit":{"type":"string","maxLength":20},"description":{"type":"string","maxLength":255,"deprecated":true},"unitDescription":{"type":"string","maxLength":255},"unitPlural":{"type":["string","null"],"maxLength":255}}}},"required":["de","en","fr","it"]}},"required":["active","translations"]}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Account Unit Resource","properties":{"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"unitType":{"type":"string","enum":["custom-unit","system-unit"]},"isocode":{"type":["string","null"],"deprecated":true},"unitCode":{"type":["string","null"]},"active":{"type":"boolean","deprecated":true},"isActive":{"type":"boolean"},"isArchived":{"type":"boolean"},"hasMasterUnit":{"type":"boolean","deprecated":true},"systemUnitUuid":{"type":["string","null"],"format":"uuid"},"translations":{"properties":{"de":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"},"en":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"},"fr":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"},"it":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products","https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"65f0f194b4370bf2f1003a14a8da6442","x-required-scopes":["products","settings"]}},"/accounts/{accountUuid}/units/v2/system-units/{systemUnitUuid}":{"get":{"tags":["units_system-units"],"summary":"Get system unit","description":"Get a system unit","operationId":"units_get_system_units","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"systemUnitUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"System Unit Resource","properties":{"uuid":{"type":"string","format":"uuid"},"unitCode":{"type":"string"},"unitCodeStandardized":{"description":"UN/ECE Rec20/21 compatible unit code, can differ to ensure standard compatibility","type":"string"},"translations":{"properties":{"de":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"}},"type":"object"},"en":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"}},"type":"object"},"fr":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"}},"type":"object"},"it":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products","https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"33a922b516b0b326f2b22b1ea97286bb","x-required-scopes":["products","settings"]}},"/accounts/{accountUuid}/units/v2/units/{unitUuid}":{"get":{"tags":["units_account-units"],"summary":"Get account unit","description":"Get an account unit","operationId":"units_get_units","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"unitUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Account Unit Resource","properties":{"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"unitType":{"type":"string","enum":["custom-unit","system-unit"]},"isocode":{"type":["string","null"],"deprecated":true},"unitCode":{"type":["string","null"]},"active":{"type":"boolean","deprecated":true},"isActive":{"type":"boolean"},"isArchived":{"type":"boolean"},"hasMasterUnit":{"type":"boolean","deprecated":true},"systemUnitUuid":{"type":["string","null"],"format":"uuid"},"translations":{"properties":{"de":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"},"en":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"},"fr":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"},"it":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products","https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"9f581603e18b1943e0f99b8066f0d498","x-required-scopes":["products","settings"]},"patch":{"tags":["units_account-units"],"summary":"Update custom unit","description":"Update a custom unit","operationId":"units_update_units","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"unitUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update custom unit","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/custom-unit.update.schema.json","description":"A Schema for updating custom units in AbaNinja over the API","type":"object","anyOf":[{"required":["isocode"]},{"required":["unitCode"]},{"required":["active"]},{"required":["translations"]}],"properties":{"isocode":{"type":["string","null"],"maxLength":10,"deprecated":true},"unitCode":{"type":["string","null"],"maxLength":10},"active":{"type":"boolean"},"translations":{"type":"object","properties":{"de":{"type":"object","properties":{"unit":{"type":"string","maxLength":20},"description":{"type":"string","maxLength":255,"deprecated":true},"unitDescription":{"type":"string","maxLength":255},"unitPlural":{"type":["string","null"],"maxLength":255}}},"en":{"type":"object","properties":{"unit":{"type":"string","maxLength":20},"description":{"type":"string","maxLength":255,"deprecated":true},"unitDescription":{"type":"string","maxLength":255},"unitPlural":{"type":["string","null"],"maxLength":255}}},"fr":{"type":"object","properties":{"unit":{"type":"string","maxLength":20},"description":{"type":"string","maxLength":255,"deprecated":true},"unitDescription":{"type":"string","maxLength":255},"unitPlural":{"type":["string","null"],"maxLength":255}}},"it":{"type":"object","properties":{"unit":{"type":"string","maxLength":20},"description":{"type":"string","maxLength":255,"deprecated":true},"unitDescription":{"type":"string","maxLength":255},"unitPlural":{"type":["string","null"],"maxLength":255}}}},"required":[]}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Account Unit Resource","properties":{"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"unitType":{"type":"string","enum":["custom-unit","system-unit"]},"isocode":{"type":["string","null"],"deprecated":true},"unitCode":{"type":["string","null"]},"active":{"type":"boolean","deprecated":true},"isActive":{"type":"boolean"},"isArchived":{"type":"boolean"},"hasMasterUnit":{"type":"boolean","deprecated":true},"systemUnitUuid":{"type":["string","null"],"format":"uuid"},"translations":{"properties":{"de":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"},"en":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"},"fr":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"},"it":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products","https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"4a201b82db74617674b65b9f42b2c719","x-required-scopes":["products","settings"]},"delete":{"tags":["units_account-units"],"summary":"Delete custom unit","description":"Delete a custom unit","operationId":"units_delete_units","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"unitUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products","https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"57509c00443dfb568cdc117e4a5cb1f7","x-required-scopes":["products","settings"]}},"/accounts/{accountUuid}/units/v2/units/activate-system-unit":{"post":{"tags":["units_account-units"],"summary":"Activate system unit","description":"Activate a system unit for the account","operationId":"units_create_activate_system_unit","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Activate system unit","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/system-unit-activation.schema.json","description":"A schema for activating system units in AbaNinja over the API","type":"object","properties":{"systemUnitUuid":{"type":"string","format":"uuid"}},"required":["systemUnitUuid"],"additionalProperties":false}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Account Unit Resource","properties":{"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"unitType":{"type":"string","enum":["custom-unit","system-unit"]},"isocode":{"type":["string","null"],"deprecated":true},"unitCode":{"type":["string","null"]},"active":{"type":"boolean","deprecated":true},"isActive":{"type":"boolean"},"isArchived":{"type":"boolean"},"hasMasterUnit":{"type":"boolean","deprecated":true},"systemUnitUuid":{"type":["string","null"],"format":"uuid"},"translations":{"properties":{"de":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"},"en":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"},"fr":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"},"it":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products","https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"6a1c5539c61b91b725837d50739b95e8","x-required-scopes":["products","settings"]}},"/accounts/{accountUuid}/units/v2/units/deactivate-system-unit":{"post":{"tags":["units_account-units"],"summary":"Deactivate system unit","description":"Deactivate a system unit for the account","operationId":"units_create_deactivate_system_unit","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Deactivate system unit","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/system-unit-deactivation.schema.json","description":"A schema for deactivating system units in AbaNinja over the API","type":"object","properties":{"systemUnitUuid":{"type":"string","format":"uuid"}},"required":["systemUnitUuid"],"additionalProperties":false}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Account Unit Resource","properties":{"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"unitType":{"type":"string","enum":["custom-unit","system-unit"]},"isocode":{"type":["string","null"],"deprecated":true},"unitCode":{"type":["string","null"]},"active":{"type":"boolean","deprecated":true},"isActive":{"type":"boolean"},"isArchived":{"type":"boolean"},"hasMasterUnit":{"type":"boolean","deprecated":true},"systemUnitUuid":{"type":["string","null"],"format":"uuid"},"translations":{"properties":{"de":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"},"en":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"},"fr":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"},"it":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products","https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"d818965e70ea2d2a799d7788d8aedd2a","x-required-scopes":["products","settings"]}},"/accounts/{accountUuid}/units/v2/units/{unitUuid}/actions":{"get":{"tags":["units_account-units"],"summary":"Get single actions","description":"Get the single actions of an account unit","operationId":"units_list_actions","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"unitUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Single Account Unit Action Resource","properties":{"key":{"type":"string"},"description":{"type":"string"},"isApplicable":{"type":"boolean"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products","https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"b9a77e2eabccd25a6ff3ccd6650da62c","x-required-scopes":["products","settings"]}},"/accounts/{accountUuid}/units/v2/units/{unitUuid}/actions/archive":{"post":{"tags":["units_account-units"],"summary":"Archive account unit","description":"Archive an account unit for the account","operationId":"units_create_archive","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"unitUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Account Unit Resource","properties":{"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"unitType":{"type":"string","enum":["custom-unit","system-unit"]},"isocode":{"type":["string","null"],"deprecated":true},"unitCode":{"type":["string","null"]},"active":{"type":"boolean","deprecated":true},"isActive":{"type":"boolean"},"isArchived":{"type":"boolean"},"hasMasterUnit":{"type":"boolean","deprecated":true},"systemUnitUuid":{"type":["string","null"],"format":"uuid"},"translations":{"properties":{"de":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"},"en":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"},"fr":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"},"it":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products","https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"1332ff518427e174f8fb7e3fd5a0f105","x-required-scopes":["products","settings"]}},"/accounts/{accountUuid}/units/v2/units/{unitUuid}/actions/restore":{"post":{"tags":["units_account-units"],"summary":"Restore account unit","description":"Restore an account unit for the account","operationId":"units_create_restore","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"unitUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Account Unit Resource","properties":{"id":{"type":"integer","deprecated":true},"uuid":{"type":"string","format":"uuid"},"unitType":{"type":"string","enum":["custom-unit","system-unit"]},"isocode":{"type":["string","null"],"deprecated":true},"unitCode":{"type":["string","null"]},"active":{"type":"boolean","deprecated":true},"isActive":{"type":"boolean"},"isArchived":{"type":"boolean"},"hasMasterUnit":{"type":"boolean","deprecated":true},"systemUnitUuid":{"type":["string","null"],"format":"uuid"},"translations":{"properties":{"de":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"},"en":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"},"fr":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"},"it":{"properties":{"unit":{"type":"string"},"unitPlural":{"type":["string","null"]},"unitDescription":{"type":"string"},"description":{"type":"string","deprecated":true}},"type":"object"}},"type":"object"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/products","https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"1b7fd6ba073a487818bcbe851b778a54","x-required-scopes":["products","settings"]}},"/accounts/{accountUuid}/warehouse/v2/warehouse-transactions":{"get":{"tags":["warehouse_warehouse-transactions"],"summary":"Get transactions","description":"Get transactions of the warehouse products","operationId":"warehouse_list_warehouse_transactions","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}},{"name":"limit","in":"query","description":"use perPage instead","required":false,"deprecated":true,"schema":{"type":["integer","null"],"minimum":1}},{"name":"productUuids","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"},"minimum":0}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Warehouse Transaction Resource","properties":{"uuid":{"type":"string","format":"uuid"},"productUuid":{"type":"string","format":"uuid"},"userUuid":{"type":"string","format":"uuid"},"userFullName":{"type":"string"},"type":{"type":"string","enum":["INCOMING","OUTGOING","STOCKTAKING"]},"typeLabel":{"type":"string"},"subtype":{"type":"string","enum":["CORRECTION","DEFAULT","DEFECT","DELIVERY_NOTE","INITIAL_STOCKTAKING","RETURN","STOCK","STOCKTAKING"]},"subtypeLabel":{"type":"string"},"dateTime":{"type":"string","format":"date-time"},"unitUuid":{"type":"string","format":"uuid"},"unitLabel":{"type":["string","null"]},"amount":{"type":"number","format":"float"},"singleItemPrice":{"type":["number","null"],"format":"float"},"currency":{"type":["string","null"]},"invoiceType":{"type":["string","null"],"enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"invoiceUuid":{"type":["string","null"],"format":"uuid"},"invoiceNumber":{"type":["string","null"]},"comment":{"type":["string","null"]}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/warehouse"]}],"x-legacy-operation-id":"cfad5c161544a0ae7e7fa7e781d256fb","x-required-scopes":["warehouse"]},"post":{"tags":["warehouse_warehouse-transactions"],"summary":"Create transaction","description":"Create transaction for a warehouse product","operationId":"warehouse_create_warehouse_transactions","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create transaction","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/warehouse-transaction.schema.json","description":"A schema for creating transactions in the warehouse in AbaNinja over the API","type":"object","properties":{"productUuid":{"type":"string","format":"uuid"},"type":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/warehouse-transaction-type.schema.json","description":"A Schema for the possible values of warehouse transaction types","type":"string","enum":["INCOMING","OUTGOING","STOCKTAKING"]},"subtype":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/subschemas/warehouse-transaction-subtype.schema.json","description":"A Schema for the possible values of warehouse transaction subtypes","type":"string","enum":["CORRECTION","DEFAULT","DEFECT","DELIVERY_NOTE","INITIAL_STOCKTAKING","RETURN","STOCK","STOCKTAKING"]},"dateTime":{"type":"string","format":"date-time"},"amount":{"type":"number","exclusiveMinimum":0},"singleItemPrice":{"type":["number","null"],"minimum":0},"comment":{"type":["string","null"],"maxLength":1000}},"required":["productUuid","type","subtype","dateTime","amount"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Warehouse Transaction Resource","properties":{"uuid":{"type":"string","format":"uuid"},"productUuid":{"type":"string","format":"uuid"},"userUuid":{"type":"string","format":"uuid"},"userFullName":{"type":"string"},"type":{"type":"string","enum":["INCOMING","OUTGOING","STOCKTAKING"]},"typeLabel":{"type":"string"},"subtype":{"type":"string","enum":["CORRECTION","DEFAULT","DEFECT","DELIVERY_NOTE","INITIAL_STOCKTAKING","RETURN","STOCK","STOCKTAKING"]},"subtypeLabel":{"type":"string"},"dateTime":{"type":"string","format":"date-time"},"unitUuid":{"type":"string","format":"uuid"},"unitLabel":{"type":["string","null"]},"amount":{"type":"number","format":"float"},"singleItemPrice":{"type":["number","null"],"format":"float"},"currency":{"type":["string","null"]},"invoiceType":{"type":["string","null"],"enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"invoiceUuid":{"type":["string","null"],"format":"uuid"},"invoiceNumber":{"type":["string","null"]},"comment":{"type":["string","null"]}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/warehouse"]}],"x-legacy-operation-id":"4d4a0f260674312f49ed2bea131d41ac","x-required-scopes":["warehouse"]}},"/accounts/{accountUuid}/warehouse/v2/warehouse-products/{productUuid}":{"get":{"tags":["warehouse_warehouse-products"],"summary":"Get warehouse product","description":"Get the warehouse product","operationId":"warehouse_get_warehouse_products","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Warehouse Product Resource","properties":{"active":{"type":"boolean"},"calculationStartDate":{"type":["string","null"],"format":"date"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/warehouse"]}],"x-legacy-operation-id":"567e7db3be3cd87cc4fdc98da7ce2565","x-required-scopes":["warehouse"]},"patch":{"tags":["warehouse_warehouse-products"],"summary":"Update warehouse product","description":"Update the warehouse product","operationId":"warehouse_update_warehouse_products","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update warehouse product","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/warehouse-product.schema.json","description":"A schema for modifying warehouse products in the warehouse in AbaNinja over the API","type":"object","properties":{"calculationStartDate":{"type":["string","null"],"format":"date"}},"required":["calculationStartDate"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Warehouse Product Resource","properties":{"active":{"type":"boolean"},"calculationStartDate":{"type":["string","null"],"format":"date"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/warehouse"]}],"x-legacy-operation-id":"eb906e75c554d2c6c4b537d720f28425","x-required-scopes":["warehouse"]}},"/accounts/{accountUuid}/warehouse/v2/warehouse-transaction-types/available-subtypes":{"get":{"tags":["warehouse_warehouse-transaction-types"],"summary":"Get available subtypes","description":"Get available transaction subtypes","operationId":"warehouse_list_available_subtypes","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"type","in":"query","schema":{"type":"string","enum":["INCOMING","OUTGOING","STOCKTAKING"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Warehouse Transaction Available Subtype Resource","properties":{"key":{"type":"string","enum":["CORRECTION","DEFAULT","DEFECT","DELIVERY_NOTE","INITIAL_STOCKTAKING","RETURN","STOCK","STOCKTAKING"]},"label":{"type":"string"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/warehouse"]}],"x-legacy-operation-id":"39a651ac796d94fdbc35fe207c77f04f","x-required-scopes":["warehouse"]}},"/accounts/{accountUuid}/warehouse/v2/warehouse-transaction-types/available-types":{"get":{"tags":["warehouse_warehouse-transaction-types"],"summary":"Get available types","description":"Get available transaction types","operationId":"warehouse_list_available_types","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Warehouse Transaction Available Type Resource","properties":{"key":{"type":"string","enum":["INCOMING","OUTGOING","STOCKTAKING"]},"label":{"type":"string"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/warehouse"]}],"x-legacy-operation-id":"4e1079472d38cf57df8da18b768d1076","x-required-scopes":["warehouse"]}},"/accounts/{accountUuid}/warehouse/v2/warehouse-transactions/{warehouseTransactionUuid}":{"get":{"tags":["warehouse_warehouse-transactions"],"summary":"Get transaction","description":"Get transaction of the warehouse product","operationId":"warehouse_get_warehouse_transactions","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"warehouseTransactionUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Warehouse Transaction Resource","properties":{"uuid":{"type":"string","format":"uuid"},"productUuid":{"type":"string","format":"uuid"},"userUuid":{"type":"string","format":"uuid"},"userFullName":{"type":"string"},"type":{"type":"string","enum":["INCOMING","OUTGOING","STOCKTAKING"]},"typeLabel":{"type":"string"},"subtype":{"type":"string","enum":["CORRECTION","DEFAULT","DEFECT","DELIVERY_NOTE","INITIAL_STOCKTAKING","RETURN","STOCK","STOCKTAKING"]},"subtypeLabel":{"type":"string"},"dateTime":{"type":"string","format":"date-time"},"unitUuid":{"type":"string","format":"uuid"},"unitLabel":{"type":["string","null"]},"amount":{"type":"number","format":"float"},"singleItemPrice":{"type":["number","null"],"format":"float"},"currency":{"type":["string","null"]},"invoiceType":{"type":["string","null"],"enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"invoiceUuid":{"type":["string","null"],"format":"uuid"},"invoiceNumber":{"type":["string","null"]},"comment":{"type":["string","null"]}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/warehouse"]}],"x-legacy-operation-id":"4d2c158dfe88ef3bd5adc9ceae015868","x-required-scopes":["warehouse"]}},"/accounts/{accountUuid}/warehouse/v2/warehouse/status":{"get":{"tags":["warehouse_warehouse"],"summary":"Get status of warehouse","description":"Get the current status of the warehouse","operationId":"warehouse_list_status","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Warehouse Status Resource","properties":{"active":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/warehouse"]}],"x-legacy-operation-id":"f5f42841168cbf7629668aa2b382a2a1","x-required-scopes":["warehouse"]}},"/accounts/{accountUuid}/warehouse/v2/exports/warehouse/all-stocks":{"post":{"tags":["warehouse_warehouse-exports","warehouse_exports"],"summary":"Export warehouse stocks","description":"Create an export of warehouse stocks","operationId":"warehouse_create_all_stocks","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create export","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/export.create.schema.json","description":"A Schema for creating exports in AbaNinja over the API","type":"object","properties":{"format":{"enum":["XLSX"]}},"required":["format"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Export Download Resource","properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["WAREHOUSE_STOCKS_ALL","WAREHOUSE_PRODUCT_RESERVATIONS"]},"status":{"type":"string","enum":["QUEUED","RUNNING","FINISHED","FAILED"]},"name":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"},"startedAt":{"type":["string","null"],"format":"date-time"},"finishedAt":{"type":["string","null"],"format":"date-time"},"expiresAt":{"type":["string","null"],"format":"date-time"},"isExpired":{"type":"boolean"},"downloadUrl":{"type":["string","null"],"format":"uri"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/warehouse"]}],"x-legacy-operation-id":"d403c468d838a4d8eaf50780584412b5","x-required-scopes":["warehouse"]}},"/accounts/{accountUuid}/warehouse/v2/warehouse-products/{productUuid}/activate":{"post":{"tags":["warehouse_warehouse-products"],"summary":"Activate warehouse product","description":"Activate a product for the warehouse","operationId":"warehouse_create_activate","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Activate warehouse product","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/warehouse-product-activation.schema.json","description":"A schema for activating products in the warehouse in AbaNinja over the API","type":"object","properties":{"dateTime":{"type":"string","format":"date-time"},"initialAmount":{"type":"number","minimum":0}},"required":["dateTime","initialAmount"]}}}},"responses":{"200":{"description":"Warehouse product successfully activated","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/warehouse"]}],"x-legacy-operation-id":"4576cd153c82e1882c32bce4ec713018","x-required-scopes":["warehouse"]}},"/accounts/{accountUuid}/warehouse/v2/warehouse-products/{productUuid}/current-stock":{"get":{"tags":["warehouse_warehouse-products"],"summary":"Get stock of warehouse product","description":"Get the current stock of the warehouse product","operationId":"warehouse_list_current_stock","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Warehouse Product Stock Resource","properties":{"stock":{"type":"number","format":"float"},"reservations":{"type":"number","format":"float"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/warehouse"]}],"x-legacy-operation-id":"e0e8f3cc14edc4d14f248fa838b23e7a","x-required-scopes":["warehouse"]}},"/accounts/{accountUuid}/warehouse/v2/warehouse-products/{productUuid}/deactivate":{"post":{"tags":["warehouse_warehouse-products"],"summary":"Deactivate warehouse product","description":"Deactivate a product for the warehouse","operationId":"warehouse_create_deactivate","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Warehouse product successfully deactivated","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/warehouse"]}],"x-legacy-operation-id":"5b72436a72d556e50b2fdfb85821419c","x-required-scopes":["warehouse"]}},"/accounts/{accountUuid}/warehouse/v2/warehouse-products/{productUuid}/status":{"get":{"tags":["warehouse_warehouse-products"],"summary":"Get status of warehouse product","description":"Get the current status of the warehouse product","operationId":"warehouse_list_status_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Warehouse Product Status Resource","properties":{"active":{"type":"boolean"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/warehouse"]}],"x-legacy-operation-id":"a836e55614126e54881122e326b86282","x-required-scopes":["warehouse"]}},"/accounts/{accountUuid}/warehouse/v2/exports/warehouse-products/{productUuid}/reservations":{"post":{"tags":["warehouse_warehouse-exports","warehouse_exports"],"summary":"Export warehouse product reservations","description":"Create an export of warehouse product reservations","operationId":"warehouse_create_reservations","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"productUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create export","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/export.create.schema.json","description":"A Schema for creating exports in AbaNinja over the API","type":"object","properties":{"format":{"enum":["XLSX"]}},"required":["format"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Export Download Resource","properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["WAREHOUSE_STOCKS_ALL","WAREHOUSE_PRODUCT_RESERVATIONS"]},"status":{"type":"string","enum":["QUEUED","RUNNING","FINISHED","FAILED"]},"name":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"},"startedAt":{"type":["string","null"],"format":"date-time"},"finishedAt":{"type":["string","null"],"format":"date-time"},"expiresAt":{"type":["string","null"],"format":"date-time"},"isExpired":{"type":"boolean"},"downloadUrl":{"type":["string","null"],"format":"uri"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/warehouse"]}],"x-legacy-operation-id":"b3fa0e9b9caabfa2060b6e473deb6e43","x-required-scopes":["warehouse"]}},"/accounts/{accountUuid}/webhooks/v2/outgoing-webhook-events":{"get":{"tags":["webhooks_outgoing-webhooks"],"summary":"Get available webhook types","description":"Get a list of available outgoing webhook event types","operationId":"webhooks_list_outgoing_webhook_events","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Webhook event type resource","properties":{"key":{"type":"string","enum":["payment-received","product-updated"]},"name":{"type":"string"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"5f40fbf5c4df3da7968b5417b399702d","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/webhooks/v2/outgoing-webhooks":{"get":{"tags":["webhooks_outgoing-webhooks"],"summary":"Get registered webhooks","description":"Get a list of already registered webhooks","operationId":"webhooks_list_outgoing_webhooks","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Outgoing webhook resource","properties":{"uuid":{"type":"string","format":"uuid"},"targetUrl":{"type":"string","format":"uri"},"eventTypes":{"type":"array","items":{"type":"string","enum":["payment-received","product-updated"]},"uniqueItems":true},"signatureKey":{"type":"string"},"latestEvent":{"oneOf":[{"title":"Latest outgoing webhook event resource","properties":{"dateTime":{"type":["string","null"],"format":"date-time"},"status":{"type":"string","enum":["CREATED","PENDING","ERROR","DELIVERED"]}},"type":"object"},{"type":"null"}]}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"58545efdebe3d93ccec3197c7262ff62","x-required-scopes":["settings"]},"post":{"tags":["webhooks_outgoing-webhooks"],"summary":"Create outgoing webhooks","description":"Register a new outgoing webhook","operationId":"webhooks_create_outgoing_webhooks","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"showSignatureKey","in":"query","required":false,"schema":{"description":"return the signatureKey unmasked if true","type":"boolean","default":false}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Create outgoing webhook request","required":["targetUrl","eventTypes"],"properties":{"targetUrl":{"type":"string","format":"uri","maxLength":500},"eventTypes":{"type":"array","items":{"type":"string","enum":["payment-received","product-updated"]},"minItems":1,"uniqueItems":true}},"type":"object"}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Outgoing webhook resource","properties":{"uuid":{"type":"string","format":"uuid"},"targetUrl":{"type":"string","format":"uri"},"eventTypes":{"type":"array","items":{"type":"string","enum":["payment-received","product-updated"]},"uniqueItems":true},"signatureKey":{"type":"string"},"latestEvent":{"oneOf":[{"title":"Latest outgoing webhook event resource","properties":{"dateTime":{"type":["string","null"],"format":"date-time"},"status":{"type":"string","enum":["CREATED","PENDING","ERROR","DELIVERED"]}},"type":"object"},{"type":"null"}]}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"481e6ec2275ea6e8d9c99fc2486ecd4f","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/webhooks/v2/outgoing-webhook-events/{webhookEventUuid}":{"get":{"tags":["webhooks_outgoing-webhooks"],"summary":"Get webhook event","description":"Get single event of the outgoing webhook","operationId":"webhooks_get_outgoing_webhook_events","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"webhookEventUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Outgoing webhook event resource","properties":{"uuid":{"type":"string","format":"uuid"},"targetUrl":{"type":"string","format":"uri"},"dateTime":{"type":"string","format":"date-time"},"eventType":{"type":"string","enum":["payment-received","product-updated"]},"status":{"type":"string","enum":["CREATED","PENDING","ERROR","DELIVERED"]},"deliveryAttempts":{"type":"array","items":{"title":"Outgoing webhook delivery attempt resource","properties":{"uuid":{"type":"string","format":"uuid"},"dateTime":{"type":"string","format":"date-time"},"successful":{"type":"boolean"},"responseCode":{"type":["number","null"],"format":"int64"},"responseBody":{"type":["string","null"]},"errorMessage":{"type":["string","null"]}},"type":"object"}}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"abee57bb5c2383ff08ee358f8eec3789","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/webhooks/v2/outgoing-webhooks/{webhookUuid}":{"get":{"tags":["webhooks_outgoing-webhooks"],"summary":"Show outgoing webhook","description":"Show single outgoing webhook","operationId":"webhooks_get_outgoing_webhooks","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"webhookUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"showSignatureKey","in":"query","required":false,"schema":{"description":"return the signatureKey unmasked if true","type":"boolean","default":false}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Outgoing webhook resource","properties":{"uuid":{"type":"string","format":"uuid"},"targetUrl":{"type":"string","format":"uri"},"eventTypes":{"type":"array","items":{"type":"string","enum":["payment-received","product-updated"]},"uniqueItems":true},"signatureKey":{"type":"string"},"latestEvent":{"oneOf":[{"title":"Latest outgoing webhook event resource","properties":{"dateTime":{"type":["string","null"],"format":"date-time"},"status":{"type":"string","enum":["CREATED","PENDING","ERROR","DELIVERED"]}},"type":"object"},{"type":"null"}]}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"39c591d731a3a002a66ef79b4b148adb","x-required-scopes":["settings"]},"patch":{"tags":["webhooks_outgoing-webhooks"],"summary":"Create outgoing webhooks","description":"Register a new outgoing webhook","operationId":"webhooks_update_outgoing_webhooks","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"webhookUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Update outgoing webhook request","required":[],"properties":{"targetUrl":{"type":"string","format":"uri","maxLength":500},"eventTypes":{"type":"array","items":{"type":"string","enum":["payment-received","product-updated"]},"minItems":1,"uniqueItems":true}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Outgoing webhook resource","properties":{"uuid":{"type":"string","format":"uuid"},"targetUrl":{"type":"string","format":"uri"},"eventTypes":{"type":"array","items":{"type":"string","enum":["payment-received","product-updated"]},"uniqueItems":true},"signatureKey":{"type":"string"},"latestEvent":{"oneOf":[{"title":"Latest outgoing webhook event resource","properties":{"dateTime":{"type":["string","null"],"format":"date-time"},"status":{"type":"string","enum":["CREATED","PENDING","ERROR","DELIVERED"]}},"type":"object"},{"type":"null"}]}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"72ee94017e6a1b17d7d381520f25f3ae","x-required-scopes":["settings"]},"delete":{"tags":["webhooks_outgoing-webhooks"],"summary":"Delete outgoing webhook","description":"Delete single outgoing webhook","operationId":"webhooks_delete_outgoing_webhooks","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"webhookUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Successful response"},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"78866a685b3aad4cc68211e87d92561f","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/webhooks/v2/outgoing-webhooks/{webhookUuid}/events":{"get":{"tags":["webhooks_outgoing-webhooks"],"summary":"Get webhook events","description":"Get events of the outgoing webhook","operationId":"webhooks_list_events","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"webhookUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Minimal outgoing webhook event resource","properties":{"uuid":{"type":"string","format":"uuid"},"targetUrl":{"type":"string","format":"uri"},"dateTime":{"type":"string","format":"date-time"},"eventType":{"type":"string","enum":["payment-received","product-updated"]},"status":{"type":"string","enum":["CREATED","PENDING","ERROR","DELIVERED"]}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"094667c61bf37d3591a564eeebaebe0c","x-required-scopes":["settings"]}},"/accounts/{accountUuid}/webhooks/v2/outgoing-webhooks/{webhookUuid}/send-test":{"post":{"tags":["webhooks_outgoing-webhooks"],"summary":"Send test outgoing webhook","description":"Trigger an outgoing webhook with test data","operationId":"webhooks_create_send_test","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"webhookUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Send outgoing test webhook request","required":["eventType"],"properties":{"eventType":{"description":"Event to send a webhook for","type":"string","enum":["payment-received","product-updated"]}},"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Outgoing webhook test event resource","properties":{"successful":{"type":"boolean"},"responseCode":{"type":["number","null"],"format":"int64"},"responseBody":{"type":["string","null"]},"errorMessage":{"type":["string","null"]}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/settings"]}],"x-legacy-operation-id":"4818ae195fd30b4c659aefdf91a1e914","x-required-scopes":["settings"]}}},"components":{"securitySchemes":{"ApiToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication. Create tokens in Settings > API Token."}},"schemas":{"AddressesContact":{"type":"object","properties":{"type":{"type":"string","enum":["email","phone","mobile","fax","website","pager","skype","twitter"]},"value":{"type":"string"},"is_primary":{"type":"boolean"}},"required":["type","value","primary"]},"AddressesContactBody":{"type":"object","properties":{"type":{"type":"string","enum":["email","phone","mobile","fax","website","pager","skype","twitter"]},"value":{"type":"string"},"primary":{"type":"boolean"}},"required":["type","value","primary"]},"AddressesContactPerson":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"first_name":{"type":"string"},"last_name":{"type":"string"},"salutation":{"type":"string","enum":["Mr","Ms","Family"]},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/AddressesContact"}}}},"AddressesAddress":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"address":{"type":"string"},"street_number":{"type":"string"},"extension":{"type":"string"},"additional_field":{"type":"string"},"city":{"type":"string"},"zip_code":{"type":"string"},"country_code":{"type":"string"},"state":{"type":"string"}},"required":["uuid"]},"AddressesCompany":{"type":"object","properties":{"type":{"type":"string","enum":["company"]},"uuid":{"type":"string","format":"uuid"},"customer_number":{"type":"string"},"name":{"type":"string"},"id_number":{"type":"string"},"vat_number":{"type":"string"},"currency_code":{"type":"string"},"language":{"type":"string"},"contact_persons":{"type":"array","items":{"$ref":"#/components/schemas/AddressesContactPerson"}},"tags":{"type":"array","items":{"type":"string"}},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/AddressesContact"}},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressesAddress"}},"private_notes":{"type":"string"},"automatic_dunning":{"type":"boolean"},"payment_terms":{"type":"integer","enum":[-1,7,10,14,15,20,30,60,90]}},"required":["type","uuid","name"]},"AddressesCompanies":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AddressesCompany"}},"links":{"type":"object","properties":{"first":{"type":"string"},"last":{"type":"string"},"prev":{"type":"string"},"next":{"type":"string"}}},"meta":{"type":"object","properties":{"current_page":{"type":"integer","format":"int64"},"from":{"type":"integer","format":"int64"},"last_page":{"type":"integer","format":"int64"},"path":{"type":"string","format":"url"},"per_page":{"type":"integer","format":"int64"},"to":{"type":"integer","format":"int64"},"total":{"type":"integer","format":"int64"}}}}},"AddressesPerson":{"type":"object","properties":{"type":{"type":"string","enum":["person"]},"uuid":{"type":"string","format":"uuid"},"first_name":{"type":"string"},"last_name":{"type":"string"},"salutation":{"type":"string","enum":["Mr","Ms","Family"]},"currency_code":{"type":"string"},"language":{"type":"string"},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/AddressesContact"}},"tags":{"type":"array","items":{"type":"string"}},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressesAddress"}},"private_notes":{"type":"string"},"automatic_dunning":{"type":"boolean"},"payment_terms":{"type":"integer","enum":[-1,7,10,14,15,20,30,60,90]}},"required":["type","uuid","first_name","last_name"]},"AddressesPersons":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AddressesPerson"}},"links":{"type":"object","properties":{"first":{"type":"string"},"last":{"type":"string"},"prev":{"type":"string"},"next":{"type":"string"}}},"meta":{"type":"object","properties":{"current_page":{"type":"integer","format":"int64"},"from":{"type":"integer","format":"int64"},"last_page":{"type":"integer","format":"int64"},"path":{"type":"string","format":"url"},"per_page":{"type":"integer","format":"int64"},"to":{"type":"integer","format":"int64"},"total":{"type":"integer","format":"int64"}}}}},"AddressesContactPersonBody":{"properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"salutation":{"type":"string","enum":["Mr","Ms","Family"]},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/AddressesContactBody"}}},"required":["first_name","last_name","salutation"]},"AddressesAddressBody":{"type":"object","properties":{"address":{"type":"string"},"street_number":{"type":"string"},"extension":{"type":"string"},"additional_field":{"type":"string"},"city":{"type":"string"},"zip_code":{"type":"string"},"country_code":{"type":"string"},"state":{"type":"string"}}},"AddressesCompanyBody":{"type":"object","properties":{"type":{"type":"string","enum":["company"]},"customer_number":{"type":"string"},"name":{"type":"string"},"id_number":{"type":"string"},"vat_number":{"type":"string"},"currency_code":{"type":"string"},"language":{"type":"string"},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/AddressesContactBody"}},"tags":{"type":"array","items":{"type":"string"}},"contact_persons":{"type":"array","items":{"$ref":"#/components/schemas/AddressesContactPersonBody"}},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressesAddressBody"}},"private_notes":{"type":"string"},"automatic_dunning":{"type":"boolean"},"payment_terms":{"type":"integer","enum":[-1,7,10,14,15,20,30,60,90]}},"required":["type","name"]},"AddressesPersonBody":{"type":"object","properties":{"type":{"type":"string","enum":["person"]},"first_name":{"type":"string"},"last_name":{"type":"string"},"salutation":{"type":"string","enum":["Mr","Ms","Family"]},"currency_code":{"type":"string"},"language":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/AddressesContactBody"}},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressesAddressBody"}},"private_notes":{"type":"string"},"automatic_dunning":{"type":"boolean"},"payment_terms":{"type":"integer","enum":[-1,7,10,14,15,20,30,60,90]}},"required":["type","first_name","last_name","salutation"]},"Error":{"type":"object","properties":{"error":{"type":"string","description":"A single ASCII error code\n"},"error_description":{"type":"string","description":"Human-readable ASCII text providing\nadditional information, used to assist the client developer in\nunderstanding the error that occurred.\n"}},"required":["error"]},"StandardResponse":{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},"PaymentLiteResource":{"properties":{"uuid":{"type":"string","format":"uuid"},"direction":{"type":"string","enum":["IN","OUT"]},"paymentDate":{"type":"string","format":"date"},"amount":{"type":"number","format":"double"},"status":{"type":"string"}},"type":"object"},"PaymentResource":{"properties":{"uuid":{"type":"string","format":"uuid"},"amount":{"type":"number","format":"double"},"currencyCode":{"type":"string","format":"iso-4217","maxLength":3,"minLength":3},"paymentDate":{"type":"string","format":"date"},"paymentInfo":{"type":["string","null"]},"isPayroll":{"type":"boolean"},"paymentDirection":{"type":"string","enum":["IN","OUT"]},"paymentType":{"type":["string","null"],"enum":["BANK","BITPAY","CARD_TERMINAL","CASH","CASH_ON_DELIVERY","INSTANT_TRANSFER","PAYPAL","TWINT","WIR","VOUCHER_OWN","VOUCHER_THIRD_PARTY","CREDIT_NOTE","CREDIT_NOTE_OFFSET","DISCOUNT","CASH_DISCOUNT","DEBIT_LOSS","DEBIT_CREDIT_CARD","DONATION","CARD_COMMISSIONS","CURRENT_ACCOUNT","PREPAYMENT","PRIVATE"]},"isArchived":{"type":"boolean"},"status":{"type":"string"},"bankAccount":{"$ref":"#/components/schemas/PaymentBankAccountResource"},"addressBankAccount":{"$ref":"#/components/schemas/PaymentAddressBankAccountResource"},"reference":{"type":"string"},"isPaymentOrder":{"type":"boolean"},"processing":{"oneOf":[{"properties":{"type":{"type":"string","enum":["manual"]},"taxRate":{"type":["number","null"],"format":"double"},"description":{"type":["string","null"]},"bookingAccountNumber":{"type":["number","null"],"format":"int64"},"bookingContraAccountNumber":{"type":["number","null"],"format":"int64"},"attachmentUuid":{"type":["string","null"],"format":"uuid"}},"type":"object"},{"properties":{"type":{"type":"string","enum":["receipt"]},"document":{"properties":{"uuid":{"type":["string","null"],"format":"uuid"},"documentNumber":{"type":["string","null"]},"documentType":{"type":["string","null"]},"documentAmount":{"type":["number","null"],"format":"double"},"documentCurrencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"addressUuid":{"type":["string","null"],"format":"uuid"},"customerNumber":{"type":["string","null"]},"receiverName":{"type":["string","null"]}},"type":"object"},"sendPaymentConfirmation":{"type":"boolean"},"exchangeRate":{"type":"number","format":"double"},"exchangeCurrencyAmount":{"type":"number","format":"double"}},"type":"object"},{"properties":{"type":{"type":"string","enum":["receipt"]},"document":{"properties":{"uuid":{"type":["string","null"],"format":"uuid"},"documentNumber":{"type":["string","null"]},"documentType":{"type":["string","null"]},"documentAmount":{"type":["number","null"],"format":"double"},"documentCurrencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"addressUuid":{"type":["string","null"],"format":"uuid"},"customerNumber":{"type":["string","null"]},"receiverName":{"type":["string","null"]}},"type":"object"},"infoMessage":{"type":["string","null"]},"exchangeRate":{"type":"number","format":"double"},"exchangeCurrencyAmount":{"type":"number","format":"double"}},"type":"object"}]}},"type":"object"},"StandardResponseError":{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},"PaymentActionResource":{"properties":{"key":{"enum":["cancel","undo_cancel","delete","archive","restore","sync","resync","edit","show","info","activity","unknown"]},"description":{"type":"string"}},"type":"object"},"PaymentBankAccountResource":{"properties":{"uuid":{"type":"string","format":"uuid"},"iban":{"type":["string","null"]}},"type":"object"},"PaymentAddressBankAccountResource":{"properties":{"uuid":{"type":"string","format":"uuid"},"iban":{"type":["string","null"]}},"type":"object"}},"responses":{"400":{"description":"error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Access Token expired"},"403":{"description":"Client / Token is not allowed"},"404":{"description":"Not Found"}}},"x-tagGroups":[{"name":"AbaNinja AbaNet API","tags":["abanet_networks"]},{"name":"AbaNinja Accounting API","tags":["accounting_accounting-assignments","accounting_accounting-preset","accounting_accounting-tax-timelines"]},{"name":"AbaNinja Accounts API","tags":["accounts_accounts","accounts_users"]},{"name":"AbaNinja Addresses API","tags":["addresses_Addresses"]},{"name":"AbaNinja Documents API","tags":["documents_document-common","documents_document-contract-note-settings","documents_document-credit-note-settings","documents_document-delivery-note-settings","documents_document-invoice-settings","documents_document-receipt-settings","documents_document-quote-settings","documents_document-invoices","documents_document-receipts","documents_document-credit-notes","documents_document-recurring-invoices","documents_document-quotes","documents_document-contract-notes","documents_document-delivery-notes","documents_document-supplier-credit-notes"]},{"name":"AbaNinja Exports API","tags":["exports_exports"]},{"name":"AbaNinja Finances API","tags":["finances_bank-accounts","finances_bank-files","finances_payments"]},{"name":"AbaNinja Holidays API","tags":["holidays_holidays","holidays_holiday-settings"]},{"name":"AbaNinja Members API","tags":["members_members","members_member-groups","members_memberships"]},{"name":"AbaNinja Products API","tags":["products_products","products_product-groups","products_product-suppliers"]},{"name":"AbaNinja Time Tracking API","tags":["time-tracking_time-tracking-employees","time-tracking_time-tracking-employee-groups","time-tracking_time-tracking-employee-statistics","time-tracking_time-tracking-employee-organigram","time-tracking_time-tracking-activities","time-tracking_time-tracking-timestamps","time-tracking_time-tracking-corrections","time-tracking_time-tracking-closures","time-tracking_time-tracking-contracts","time-tracking_time-tracking-settings"]},{"name":"AbaNinja Units API","tags":["units_account-units","units_system-units"]},{"name":"AbaNinja Warehouse API","tags":["warehouse_exports","warehouse_warehouse","warehouse_warehouse-exports","warehouse_warehouse-products","warehouse_warehouse-transactions","warehouse_warehouse-transaction-types"]},{"name":"AbaNinja Webhooks API","tags":["webhooks_outgoing-webhooks"]}]}