{"openapi":"3.1.0","info":{"title":"AbaNinja Documents API - Contract Notes","version":"3.0.0","x-domain-id":"documents"},"servers":[{"url":"https://api.abaninja.ch","description":"The AbaNinja API server"}],"tags":[{"name":"document-contract-notes","description":"Manage contract notes","x-displayName":"Contract Notes"}],"security":[{"ApiToken":[]}],"paths":{"/accounts/{accountUuid}/documents/v2/contract-notes":{"get":{"tags":["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":{}},{"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":{"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":{"properties":{"addressUuid":{"type":["string","null"],"format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"customerNumber":{"type":["string","null"]},"name":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"},"personUuid":{"type":["string","null"],"format":"uuid"}}},"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"},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"9db0a2564b6304a1241d4736af44a54b","x-required-scopes":["customers"]},"post":{"tags":["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","properties":{"isTemplate":{"const":true},"contractNoteDate":{"type":"string","format":"date"},"dueDate":{"type":["null","string"],"format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"paymentInstructions":{"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})?$"},"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"}},"required":["iban","qrIban","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"},"kind":{"const":"page_break"},"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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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"},"title":{"type":"string","maximum":255},"text":{"type":"string","maximum":255},"items":{"type":"array","items":{"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"},"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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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":["kind","productUuid","singlePrice","productDescription"]},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"$defs":{"productPosition":{"type":"object","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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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":["kind","productUuid","singlePrice","productDescription"]},"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":{"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"},"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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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":["kind","productUuid","singlePrice","productDescription"]},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}},"required":["kind","productUuid","singlePrice","productDescription","title","text","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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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","$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"]}},"properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"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}},"customerNumber":{"type":"string"}},"required":["addressUuid","personUuid","companyUuid","customerNumber"]}},"required":["contractNoteDate","documentTotal","pricesIncludeVat","positions","currencyCode","isTemplate","receiver"]},"minItems":1}},"required":["documents"],"$defs":{"singleContractNote":{"type":"object","properties":{"isTemplate":{"const":true},"contractNoteDate":{"type":"string","format":"date"},"dueDate":{"type":["null","string"],"format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"paymentInstructions":{"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})?$"},"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"}},"required":["iban","qrIban","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"},"kind":{"const":"page_break"},"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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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"},"title":{"type":"string","maximum":255},"text":{"type":"string","maximum":255},"items":{"type":"array","items":{"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"},"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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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":["kind","productUuid","singlePrice","productDescription"]},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"$defs":{"productPosition":{"type":"object","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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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":["kind","productUuid","singlePrice","productDescription"]},"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":{"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"},"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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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":["kind","productUuid","singlePrice","productDescription"]},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}},"required":["kind","productUuid","singlePrice","productDescription","title","text","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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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","$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"]}},"properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"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}},"customerNumber":{"type":"string"}},"required":["addressUuid","personUuid","companyUuid","customerNumber"]}},"required":["contractNoteDate","documentTotal","pricesIncludeVat","positions","currencyCode","isTemplate","receiver"]}}}}}},"responses":{"201":{"description":"Contract note created","content":{"application/json":{"schema":{"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":{"properties":{"addressUuid":{"type":["string","null"],"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"},"personUuid":{"type":["string","null"],"format":"uuid"}}},"contractNoteDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"paymentInstructions":{"properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]},"qrIban":{"type":"string"}}},"pricesIncludeVat":{"type":"boolean"},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"properties":{"amount":{"type":"number","format":"float"},"percentage":{"type":"number","format":"float"}}},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"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"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"items":{"type":"array","items":{"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":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"properties":{"amount":{"type":"number","format":"float"},"percentage":{"type":"number","format":"float"}}},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"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"]},"unitCode":{"type":"string"}}}},"unitCode":{"type":"string"},"text":{"type":"string"}}}},"isTemplate":{"type":"boolean"},"contractNoteNumber":{"type":"string"},"type":{"type":"string","enum":["invoice"]},"documentDiscount":{"properties":{"amount":{"type":"number","format":"float"},"percentage":{"type":"number","format":"float"}}}},"type":"object"}}},"type":"object"},"message":{"title":"message","type":"string"},"status":{"example":201},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"202":{"description":"Asynchronous processing","content":{"application/json":{"schema":{"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"},"message":{"title":"message","type":"string"},"status":{"example":202},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"5947827fb8b1020bac675f59b57ad23e","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/{contractNoteUuid}":{"get":{"tags":["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":{"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":{"properties":{"addressUuid":{"type":["string","null"],"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"},"personUuid":{"type":["string","null"],"format":"uuid"}}},"contractNoteDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"paymentInstructions":{"properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]},"qrIban":{"type":"string"}}},"pricesIncludeVat":{"type":"boolean"},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"properties":{"amount":{"type":"number","format":"float"},"percentage":{"type":"number","format":"float"}}},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"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"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"items":{"type":"array","items":{"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":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"properties":{"amount":{"type":"number","format":"float"},"percentage":{"type":"number","format":"float"}}},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"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"]},"unitCode":{"type":"string"}}}},"unitCode":{"type":"string"},"text":{"type":"string"}}}},"isTemplate":{"type":"boolean"},"contractNoteNumber":{"type":"string"},"type":{"type":"string","enum":["invoice"]},"documentDiscount":{"properties":{"amount":{"type":"number","format":"float"},"percentage":{"type":"number","format":"float"}}}},"type":"object"}}},"type":"object"},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"8d0777ed212d601681f61034a2a959dc","x-required-scopes":["customers"]},"patch":{"tags":["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","properties":{"isTemplate":{"const":true},"contractNoteDate":{"type":"string","format":"date"},"dueDate":{"type":["null","string"],"format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"paymentInstructions":{"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})?$"},"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"}},"required":["iban","qrIban","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"},"kind":{"const":"page_break"},"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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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"},"title":{"type":"string","maximum":255},"text":{"type":"string","maximum":255},"items":{"type":"array","items":{"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"},"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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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":["kind","productUuid","singlePrice","productDescription"]},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"$defs":{"productPosition":{"type":"object","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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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":["kind","productUuid","singlePrice","productDescription"]},"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":{"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"},"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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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":["kind","productUuid","singlePrice","productDescription"]},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}},"required":["kind","productUuid","singlePrice","productDescription","title","text","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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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","$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"]}},"properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"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}},"customerNumber":{"type":"string"}},"required":["addressUuid","personUuid","companyUuid","customerNumber"]}},"required":["contractNoteDate","documentTotal","pricesIncludeVat","positions","currencyCode","isTemplate","receiver"]},"minItems":1}},"required":["documents"],"$defs":{"singleContractNote":{"type":"object","properties":{"isTemplate":{"const":true},"contractNoteDate":{"type":"string","format":"date"},"dueDate":{"type":["null","string"],"format":"date"},"deliveryDate":{"type":["null","string"],"format":"date"},"paymentInstructions":{"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})?$"},"qrIban":{"type":"string","pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}$"},"bankAccountUuid":{"type":"string","format":"uuid","description":"Identifier of the bank account"}},"required":["iban","qrIban","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"},"kind":{"const":"page_break"},"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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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"},"title":{"type":"string","maximum":255},"text":{"type":"string","maximum":255},"items":{"type":"array","items":{"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"},"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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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":["kind","productUuid","singlePrice","productDescription"]},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"$defs":{"productPosition":{"type":"object","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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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":["kind","productUuid","singlePrice","productDescription"]},"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":{"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"},"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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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":["kind","productUuid","singlePrice","productDescription"]},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}},"required":["kind","productUuid","singlePrice","productDescription","title","text","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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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","$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"]}},"properties":{"addressUuid":{"type":"string","format":"uuid"},"personUuid":{"type":"string","format":"uuid"},"deliveryAddressUuid":{"type":["null","string"],"format":"uuid"},"companyUuid":{"type":"string","format":"uuid"},"contactPersonUuid":{"type":["null","string"],"format":"uuid","description":"UUID of contact person inside company"},"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}},"customerNumber":{"type":"string"}},"required":["addressUuid","personUuid","companyUuid","customerNumber"]}},"required":["contractNoteDate","documentTotal","pricesIncludeVat","positions","currencyCode","isTemplate","receiver"]}}}}}},"responses":{"200":{"description":"Contract note updated","content":{"application/json":{"schema":{"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":{"properties":{"addressUuid":{"type":["string","null"],"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"},"personUuid":{"type":["string","null"],"format":"uuid"}}},"contractNoteDate":{"type":["string","null"],"format":"date"},"dueDate":{"type":["string","null"],"format":"date"},"deliveryDate":{"type":["string","null"],"format":"date"},"paymentInstructions":{"properties":{"bankAccountUuid":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":["string","null"]},"qrIban":{"type":"string"}}},"pricesIncludeVat":{"type":"boolean"},"documentTotal":{"type":"number","format":"float"},"positions":{"type":"array","items":{"properties":{"uuid":{"type":"string","format":"uuid"},"positionNumber":{"type":"number","format":"int64"},"kind":{"type":"string","enum":["text"]},"productNumber":{"type":"string"},"productDescription":{"type":"string"},"productUuid":{"type":["string","null"],"format":"uuid"},"productGroupUuid":{"type":["string","null"],"format":"uuid"},"singlePrice":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"properties":{"amount":{"type":"number","format":"float"},"percentage":{"type":"number","format":"float"}}},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"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"]},"title":{"type":"string"},"showCollapsed":{"type":"boolean"},"items":{"type":"array","items":{"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":{"type":"number","format":"float"},"positionTotal":{"type":"number","format":"float"},"discount":{"properties":{"amount":{"type":"number","format":"float"},"percentage":{"type":"number","format":"float"}}},"vatUuid":{"type":["string","null"],"format":"uuid"},"vat":{"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"]},"unitCode":{"type":"string"}}}},"unitCode":{"type":"string"},"text":{"type":"string"}}}},"isTemplate":{"type":"boolean"},"contractNoteNumber":{"type":"string"},"type":{"type":"string","enum":["invoice"]},"documentDiscount":{"properties":{"amount":{"type":"number","format":"float"},"percentage":{"type":"number","format":"float"}}}},"type":"object"}}},"type":"object"},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"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":["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":{"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"]}},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"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":["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"},"kind":{"const":"page_break"},"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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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"},"title":{"type":"string","maximum":255},"text":{"type":"string","maximum":255},"items":{"type":"array","items":{"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"},"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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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":["kind","productUuid","singlePrice","productDescription"]},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"$defs":{"productPosition":{"type":"object","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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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":["kind","productUuid","singlePrice","productDescription"]},"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":{"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"},"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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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":["kind","productUuid","singlePrice","productDescription"]},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}},"required":["kind","productUuid","singlePrice","productDescription","title","text","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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"invoiceDate":{"type":["string","null"],"format":"date"}},"required":["positions","currencyCode"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"properties":{"data":{"title":"Contract Note Calculation Resource","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"}}},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"851ab113a60c0ead90b00ab863698423","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/{contractNoteUuid}/actions":{"get":{"tags":["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":{"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"]}},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"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":["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"},"kind":{"const":"page_break"},"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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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"},"title":{"type":"string","maximum":255},"text":{"type":"string","maximum":255},"items":{"type":"array","items":{"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"},"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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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":["kind","productUuid","singlePrice","productDescription"]},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"$defs":{"productPosition":{"type":"object","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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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":["kind","productUuid","singlePrice","productDescription"]},"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":{"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"},"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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"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"]},"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":["kind","productUuid","singlePrice","productDescription"]},"minItems":1,"description":"Only Items with the same VAT rate are allowed in a group"},"showCollapsed":{"type":"boolean","default":true}},"required":["kind","title","items"]}},"required":["kind","productUuid","singlePrice","productDescription","title","text","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","properties":{"percentage":{"type":"number","minimum":0},"amount":{"type":"number","minimum":0}},"required":["percentage","amount"]},"invoiceDate":{"type":["string","null"],"format":"date"}},"required":["positions","currencyCode"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"properties":{"data":{"title":"Contract Note Calculation Resource","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"}}},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"d12c6622445bdbc4db99c8b20e80d327","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/bulk-actions/archive":{"patch":{"tags":["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":{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"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":["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":{"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"},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"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":["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":{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"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":["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":{"properties":{"data":{"type":"object","additionalProperties":{"type":"string"}},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"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":["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":{"properties":{"data":{"type":"object","additionalProperties":{"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"}}}},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"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":["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":{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"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":["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":{"properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{},"maxItems":0}},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"3b1d285309f492e7a14d4ce2c7b74f62","x-required-scopes":["customers"]}},"/accounts/{accountUuid}/documents/v2/contract-notes/{documentUuid}/actions/archive":{"patch":{"tags":["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":{"properties":{"data":{},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"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":["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":{"properties":{"data":{},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"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":["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":{"properties":{"data":{},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"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":["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":{"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"},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"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":["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":{"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"},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"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":["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":{"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"},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"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":["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":{"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"},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"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":["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":{"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"},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"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":["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":{"properties":{"data":{"properties":{"printUrl":{"type":"string","format":"uri"}},"type":"object"},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"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":["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":{"properties":{"data":{"properties":{"printUrl":{"type":"string","format":"uri"}},"type":"object"},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"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":["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":{"properties":{"data":{},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"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":["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":{"properties":{"data":{"properties":{"downloadUrl":{"type":"string","format":"uri"}},"type":"object"},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"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":["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":{"properties":{"data":{},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"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":["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":{"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"},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"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":["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":{"properties":{"data":{},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"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":["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":{"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"},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"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":["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":{"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"},"message":{"title":"message","type":"string"},"status":{"example":200},"meta":{"title":"meta","type":["object","null"]}},"required":["data","message","status"]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"required":["detail","type","message","status"]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/customers"]}],"x-legacy-operation-id":"48853704acf74e6d79d5661691fb7736","x-required-scopes":["customers"]}}},"components":{"securitySchemes":{"ApiToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication. Create tokens in Settings > API Token."}}}}