{"openapi":"3.1.0","info":{"title":"AbaNinja Finances API","version":"3.0.0","x-domain-id":"finances"},"servers":[{"url":"https://api.abaninja.ch","description":"The AbaNinja API server"}],"security":[{"ApiToken":[]}],"tags":[{"name":"bank-accounts","description":"Manage bank accounts","x-displayName":"Bank Accounts"},{"name":"bank-files","description":"Manage bank files","x-displayName":"Bank Files"},{"name":"payments","description":"Manage payments","x-displayName":"Payments"}],"paths":{"/accounts/{accountUuid}/finances/v2/bank-accounts":{"get":{"tags":["bank-accounts"],"summary":"Get bank accounts","description":"Get bank accounts of account","operationId":"finances_list_bank_accounts","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Bank Account Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":["string","null"]},"bankName":{"type":["string","null"]},"bankAddress":{"type":["string","null"]},"bankCity":{"type":["string","null"]},"iban":{"type":["string","null"]},"bic":{"type":["string","null"]},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"qrBill":{"properties":{"active":{"type":"boolean"},"qrIban":{"type":["string","null"]},"besrId":{"type":["string","null"]}},"type":"object"},"isActive":{"type":"boolean"},"isDefault":{"type":"boolean"},"bankId":{"type":"number","format":"int64"},"bankLastSync":{"type":["string","null"],"format":"date-time"},"bankSyncStatus":{"type":["string","null"]},"bankConnectionType":{"type":["string","null"],"enum":["ABABANK","BLINK","DEEPCLOUD","OAUTH","YAPEAL","TEMPORARY"]},"accAccountUuid":{"type":"string","format":"uuid"},"paymentOrderExportStatusSetting":{"type":"string","enum":["PENDENT","FINISHED"]},"eBankingImportSetting":{"type":"string","enum":["ALL","CREDITS_ONLY","DEBITS_ONLY"]},"eBankingImportPayrolls":{"type":"boolean"},"eBankingImportCollectivePayments":{"type":"boolean"},"id":{"type":"number","format":"int64","deprecated":true}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"2f50ca4206d23e7df2c4784dd244a9f3","x-required-scopes":["finances"]},"post":{"tags":["bank-accounts"],"summary":"Create bank account","description":"Create a bank account for an account","operationId":"finances_create_bank_accounts","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create bank account","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/bank-account.schema.json","description":"A Schema for creating bank accounts in AbaNinja","type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"bankName":{"type":["null","string"],"maxLength":255},"bankAddress":{"type":["null","string"],"maxLength":255},"bankCity":{"type":["null","string"],"maxLength":255,"description":"postal code & town of the bank institute"},"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}$"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$","example":"CHF"},"qrBill":{"type":"object","properties":{"active":{"type":"boolean","default":false},"qrIban":{"type":["null","string"],"pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}"},"besrId":{"type":["null","string"],"pattern":"^[0-9]{6,8}$"}}},"isActive":{"type":"boolean","default":true,"description":"Activate/Deactivate bank account for usage in AbaNinja. Default: active"},"isDefault":{"type":"boolean","default":false,"description":"Set if bank account should be used as default."},"paymentOrderExportStatusSetting":{"type":"string","default":"FINISHED","description":"Set the status of the payment orders for this bank account when they are exported manually","enum":["FINISHED","PENDENT"]},"eBankingImportSetting":{"type":"string","default":"ALL","description":"Set which transaction types will be imported when a bank statement file is imported.","enum":["ALL","CREDITS_ONLY","DEBITS_ONLY"]},"eBankingImportPayrolls":{"type":"boolean","default":true,"description":"Control whether or not payroll transactions should be imported. Note: eBankingImportSetting has priority over this"},"eBankingImportCollectivePayments":{"type":"boolean","default":true,"description":"Control whether or not collective payment transactions should be imported. Note: eBankingImportSetting has priority over this"}},"required":["name","iban","currencyCode"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Bank Account Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":["string","null"]},"bankName":{"type":["string","null"]},"bankAddress":{"type":["string","null"]},"bankCity":{"type":["string","null"]},"iban":{"type":["string","null"]},"bic":{"type":["string","null"]},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"qrBill":{"properties":{"active":{"type":"boolean"},"qrIban":{"type":["string","null"]},"besrId":{"type":["string","null"]}},"type":"object"},"isActive":{"type":"boolean"},"isDefault":{"type":"boolean"},"bankId":{"type":"number","format":"int64"},"bankLastSync":{"type":["string","null"],"format":"date-time"},"bankSyncStatus":{"type":["string","null"]},"bankConnectionType":{"type":["string","null"],"enum":["ABABANK","BLINK","DEEPCLOUD","OAUTH","YAPEAL","TEMPORARY"]},"accAccountUuid":{"type":"string","format":"uuid"},"paymentOrderExportStatusSetting":{"type":"string","enum":["PENDENT","FINISHED"]},"eBankingImportSetting":{"type":"string","enum":["ALL","CREDITS_ONLY","DEBITS_ONLY"]},"eBankingImportPayrolls":{"type":"boolean"},"eBankingImportCollectivePayments":{"type":"boolean"},"id":{"type":"number","format":"int64","deprecated":true}},"type":"object"},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"da821be7b9aed2f563a4c75800341229","x-required-scopes":["finances"]}},"/accounts/{accountUuid}/finances/v2/bank-files":{"get":{"tags":["bank-files"],"summary":"Get bank files","description":"Get a list of bank files","operationId":"finances_list_bank_files","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Bank File Resource","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"integer","deprecated":true},"fileName":{"type":"string"},"fileType":{"type":["string","null"]},"isImported":{"type":"boolean"},"createdAt":{"type":["string","null"],"format":"date-time"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"e1569efcda5d69f2c014e4b2fdeb131b","x-required-scopes":["finances"]}},"/accounts/{accountUuid}/finances/v2/payment-order-files":{"get":{"tags":["bank-files"],"summary":"Get payment orders","description":"Get payment order files","operationId":"finances_list_payment_order_files","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Payment order file resource","properties":{"uuid":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date"},"availableUntil":{"type":"string","format":"date"},"bankAccountIban":{"type":"string"},"bankAccountDescription":{"type":"string"}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"d620f2409a5341a068a1e6b5a2dd36d1","x-required-scopes":["finances"]}},"/accounts/{accountUuid}/finances/v2/payments":{"get":{"tags":["payments"],"summary":"Get payments","description":"Retrieve a paginated list of all payments of the account","operationId":"8a2ca2d2a4f0ee4836a8309b47b0b4e4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"pagination limit","required":false,"schema":{"type":"number","format":"int64","maximum":1000,"minimum":1}},{"name":"page","in":"query","description":"pagination page","required":false,"schema":{"type":"number","format":"int64","default":1,"minimum":1}}],"responses":{"200":{"description":"List of payments","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PaymentLiteResource"}},"status":{"example":200}},"type":"object"}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"},"post":{"tags":["payments"],"summary":"Create payment","description":"Create a new payment","operationId":"21deb2507b21bdd2f87e074e5894f81d","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create payment","required":true,"content":{"application/json":{"schema":{"type":"object","description":"Schema: payment.schema"}}}},"responses":{"201":{"description":"Payment created","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{"$ref":"#/components/schemas/PaymentResource"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Bad Request":{"summary":"Bad Request","value":{"detail":[],"type":"validation_error","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Bad request or validation error","status":400}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"}},"/accounts/{accountUuid}/finances/v2/bank-accounts/{bankAccountUuid}":{"get":{"tags":["bank-accounts"],"summary":"Get bank account","description":"Get bank account of account","operationId":"finances_get_bank_accounts","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"bankAccountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Bank Account Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":["string","null"]},"bankName":{"type":["string","null"]},"bankAddress":{"type":["string","null"]},"bankCity":{"type":["string","null"]},"iban":{"type":["string","null"]},"bic":{"type":["string","null"]},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"qrBill":{"properties":{"active":{"type":"boolean"},"qrIban":{"type":["string","null"]},"besrId":{"type":["string","null"]}},"type":"object"},"isActive":{"type":"boolean"},"isDefault":{"type":"boolean"},"bankId":{"type":"number","format":"int64"},"bankLastSync":{"type":["string","null"],"format":"date-time"},"bankSyncStatus":{"type":["string","null"]},"bankConnectionType":{"type":["string","null"],"enum":["ABABANK","BLINK","DEEPCLOUD","OAUTH","YAPEAL","TEMPORARY"]},"accAccountUuid":{"type":"string","format":"uuid"},"paymentOrderExportStatusSetting":{"type":"string","enum":["PENDENT","FINISHED"]},"eBankingImportSetting":{"type":"string","enum":["ALL","CREDITS_ONLY","DEBITS_ONLY"]},"eBankingImportPayrolls":{"type":"boolean"},"eBankingImportCollectivePayments":{"type":"boolean"},"id":{"type":"number","format":"int64","deprecated":true}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"28db5c076b14ff5e52055ada9aae42a1","x-required-scopes":["finances"]},"patch":{"tags":["bank-accounts"],"summary":"Update bank account","description":"Update a bank account for an account","operationId":"finances_update_bank_accounts","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"bankAccountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Update bank account","required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api.abaninja.ch/schemas/2.0.0/bank-account.schema.json","description":"A Schema for creating bank accounts in AbaNinja","type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"bankName":{"type":["null","string"],"maxLength":255},"bankAddress":{"type":["null","string"],"maxLength":255},"bankCity":{"type":["null","string"],"maxLength":255,"description":"postal code & town of the bank institute"},"iban":{"type":"string","pattern":"^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}$"},"bic":{"type":["null","string"],"pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"},"currencyCode":{"type":"string","pattern":"^[A-Z]{3}$","example":"CHF"},"qrBill":{"type":"object","properties":{"active":{"type":"boolean","default":false},"qrIban":{"type":["null","string"],"pattern":"^(CH|LI)[0-9]{2}(30[0-9]{3}|31[0-9]{3})[a-zA-Z0-9]{12}"},"besrId":{"type":["null","string"],"pattern":"^[0-9]{6,8}$"}}},"isActive":{"type":"boolean","default":true,"description":"Activate/Deactivate bank account for usage in AbaNinja. Default: active"},"isDefault":{"type":"boolean","default":false,"description":"Set if bank account should be used as default."},"paymentOrderExportStatusSetting":{"type":"string","default":"FINISHED","description":"Set the status of the payment orders for this bank account when they are exported manually","enum":["FINISHED","PENDENT"]},"eBankingImportSetting":{"type":"string","default":"ALL","description":"Set which transaction types will be imported when a bank statement file is imported.","enum":["ALL","CREDITS_ONLY","DEBITS_ONLY"]},"eBankingImportPayrolls":{"type":"boolean","default":true,"description":"Control whether or not payroll transactions should be imported. Note: eBankingImportSetting has priority over this"},"eBankingImportCollectivePayments":{"type":"boolean","default":true,"description":"Control whether or not collective payment transactions should be imported. Note: eBankingImportSetting has priority over this"}},"required":["name","iban","currencyCode"],"if":{"properties":{"iban":{"not":{"pattern":"^(CH|LI)[0-9]{2}[a-zA-Z0-9]{1,30}$"}}}},"then":{"required":["bic"]}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Bank Account Resource","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":["string","null"]},"bankName":{"type":["string","null"]},"bankAddress":{"type":["string","null"]},"bankCity":{"type":["string","null"]},"iban":{"type":["string","null"]},"bic":{"type":["string","null"]},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"qrBill":{"properties":{"active":{"type":"boolean"},"qrIban":{"type":["string","null"]},"besrId":{"type":["string","null"]}},"type":"object"},"isActive":{"type":"boolean"},"isDefault":{"type":"boolean"},"bankId":{"type":"number","format":"int64"},"bankLastSync":{"type":["string","null"],"format":"date-time"},"bankSyncStatus":{"type":["string","null"]},"bankConnectionType":{"type":["string","null"],"enum":["ABABANK","BLINK","DEEPCLOUD","OAUTH","YAPEAL","TEMPORARY"]},"accAccountUuid":{"type":"string","format":"uuid"},"paymentOrderExportStatusSetting":{"type":"string","enum":["PENDENT","FINISHED"]},"eBankingImportSetting":{"type":"string","enum":["ALL","CREDITS_ONLY","DEBITS_ONLY"]},"eBankingImportPayrolls":{"type":"boolean"},"eBankingImportCollectivePayments":{"type":"boolean"},"id":{"type":"number","format":"int64","deprecated":true}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"8c8cfe73399698203bfc2f4d95f97e3a","x-required-scopes":["finances"]},"delete":{"tags":["bank-accounts"],"summary":"Delete bank account","description":"Delete a bank account for an account","operationId":"finances_delete_bank_accounts","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"bankAccountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"10aa535b7ce17c7ddf0f6294e837bcaf","x-required-scopes":["finances"]}},"/accounts/{accountUuid}/finances/v2/bank-files/{bankFileUuid}":{"get":{"tags":["bank-files"],"summary":"Get bank file","description":"Get a single bank file","operationId":"finances_get_bank_files","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"bankFileUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Bank File Resource","properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"integer","deprecated":true},"fileName":{"type":"string"},"fileType":{"type":["string","null"]},"isImported":{"type":"boolean"},"createdAt":{"type":["string","null"],"format":"date-time"}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"b602843aec013d1d870d0b963272921f","x-required-scopes":["finances"]}},"/accounts/{accountUuid}/finances/v2/payment-order-files/{paymentOrderFileUuid}":{"get":{"tags":["bank-files"],"summary":"Get file entries","description":"Get entries of a payment order file","operationId":"finances_get_payment_order_files","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentOrderFileUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Payment order resource","properties":{"status":{"type":"string","enum":["PENDING","ACCEPTED","CHANGED","EXPORTED","DECLINED","ERROR"]},"statusMessage":{"type":["string","null"]},"paymentAmount":{"type":["number","null"],"format":"double"},"paymentCurrencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"paymentDate":{"type":["string","null"],"format":"date"},"paymentReceiver":{"type":["string","null"]}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"90e8a3e3bc4108f5935dd40f529aa9a2","x-required-scopes":["finances"]}},"/accounts/{accountUuid}/finances/v2/payments/{paymentUuid}":{"get":{"tags":["payments"],"summary":"Get payment","description":"Get data of a single payment","operationId":"7c18a0be695232e203e87065878f12f6","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","description":"uuid of the payment to retrieve","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The requested payment","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{"$ref":"#/components/schemas/PaymentResource"},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Not found":{"summary":"Not found","value":{"detail":[],"type":"not_found","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Payment not found","status":404}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"},"patch":{"tags":["payments"],"summary":"Update payment","operationId":"f5f4718f17dce304bb058f584bb1e1f4","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","description":"the uuid of the payment to update","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create payment","required":true,"content":{"application/json":{"schema":{"type":"object","description":"Schema: payment.schema"}}}},"responses":{"200":{"description":"Payment updated","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{"$ref":"#/components/schemas/PaymentResource"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Bad Request":{"summary":"Bad Request","value":{"detail":[],"type":"validation_error","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Bad request or validation error","status":400}}}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Not found":{"summary":"Not found","value":{"detail":[],"type":"not_found","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Payment not found","status":404}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"},"delete":{"tags":["payments"],"summary":"Delete payment","description":"Delete the given payment","operationId":"d68e398d007e30862a272208958f6119","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","description":"Uuid of the payment to delete.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Payment deleted","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Bad Request":{"summary":"Bad Request","value":{"detail":[],"type":"validation_error","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Bad request or validation error","status":400}}}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Not found":{"summary":"Not found","value":{"detail":[],"type":"not_found","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Payment not found","status":404}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"}},"/accounts/{accountUuid}/finances/v2/bank-files/{bankFileUuid}/amounts":{"get":{"tags":["bank-files"],"summary":"Get bank file amounts","description":"Get a single bank file amounts","operationId":"finances_list_amounts","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"bankFileUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Bank File Amount Resource","properties":{"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"amount":{"type":"number","format":"float"},"dummy":{"type":"number","format":"float"},"ignored":{"type":"number","format":"float"},"imported":{"type":"number","format":"float"},"matched":{"type":"number","format":"float"},"noMatching":{"type":"number","format":"float"}},"type":"object"}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"003dc5439cb20076f66c697ed1283110","x-required-scopes":["finances"]}},"/accounts/{accountUuid}/finances/v2/bank-files/{bankFileUuid}/entries":{"get":{"tags":["bank-files"],"summary":"Get entries","description":"Get bank files entries","operationId":"finances_list_entries","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"bankFileUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Bank File Entry Resource","properties":{"uuid":{"type":"string","format":"uuid"},"currencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"accountCurrency":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"amount":{"type":"number","format":"float"},"chargedAmount":{"type":"number","format":"float"},"direction":{"type":"string","enum":["IN","OUT"]},"exchangeRate":{"type":["number","null"],"format":"float"},"isCollective":{"type":"boolean"},"isIgnored":{"type":"boolean"},"isPayroll":{"type":"boolean"},"outReference":{"type":["string","null"]},"reference":{"type":"string"},"status":{"type":"string","enum":["duplicate","ignored","matched","no_matching_invoice"]},"invoiceUuid":{"type":["string","null"],"format":"uuid"},"invoiceId":{"type":["integer","null"],"deprecated":true},"invoiceType":{"type":["string","null"],"enum":["invoice","receipt","credit_note","recurring_invoice","quote","contract_note","delivery_note","supplier_credit_note"]},"invoiceNumber":{"type":["string","null"]},"invoiceIsImported":{"type":["boolean","null"]},"additionalInfo":{"type":["string","null"]},"addressName":{"type":["string","null"]},"valueDate":{"type":["string","null"],"format":"date-time"}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"4547b32d439efa2442215c5c69c513a1","x-required-scopes":["finances"]}},"/accounts/{accountUuid}/finances/v2/payment-order-files/{paymentOrderFileUuid}/download-feedback-file":{"get":{"tags":["bank-files"],"summary":"Download feedback file","description":"Download feedback file (PAIN002)","operationId":"finances_list_download_feedback_file","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentOrderFileUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","headers":{"Content-Type":{"schema":{"type":"string","enum":["application/xml"]}},"Content-Length":{"schema":{"type":"integer"}}},"content":{"application/xml":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"File not found or expired","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"f52d7d2f3e773f40b1117d76c59bfb1c","x-required-scopes":["finances"]}},"/accounts/{accountUuid}/finances/v2/payment-order-files/{paymentOrderFileUuid}/download-file":{"get":{"tags":["bank-files"],"summary":"Download file","description":"Download payment order file (PAIN001)","operationId":"finances_list_download_file","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentOrderFileUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","headers":{"Content-Type":{"schema":{"type":"string","enum":["application/zip"]}},"Content-Length":{"schema":{"type":"integer"}}},"content":{"application/zip":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"File not found or expired","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"52f15135326ffa378216167c7cea6394","x-required-scopes":["finances"]}},"/accounts/{accountUuid}/finances/v2/payments/{paymentUuid}/actions":{"get":{"tags":["payments"],"summary":"Get payment actions","description":"Get a list of applicable actions for the given payments","operationId":"2e391319046d33a6ffed1b1177e627d5","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","description":"uuid of the payment to retrieve actions for","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"A list of applicable actions","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PaymentActionResource"}},"status":{"example":200}},"type":"object"}]}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Not found":{"summary":"Not found","value":{"detail":[],"type":"not_found","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Payment not found","status":404}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"}},"/accounts/{accountUuid}/finances/v2/payments/{paymentUuid}/attachments":{"post":{"tags":["payments"],"summary":"Upload attachment","description":"Upload an attachment for the payment","operationId":"3725c314e23d25413503a14d51813f67","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","description":"the uuid of the payment for which the attachment should be uploaded","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Attachment file. Allowed are: pdf,png and jpeg files","required":true,"content":{"multipart/form-data":{"schema":{"required":["attachment"],"properties":{"attachment":{"type":"string","format":"binary"}},"type":"object"}}}},"responses":{"201":{"description":"Attachment uploaded","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{},"status":{"example":201}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Bad Request":{"summary":"Bad Request","value":{"detail":[],"type":"validation_error","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Bad request or validation error","status":400}}}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Not found":{"summary":"Not found","value":{"detail":[],"type":"not_found","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Payment not found","status":404}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"}},"/accounts/{accountUuid}/finances/v2/payments/{paymentUuid}/payment-order-files":{"get":{"tags":["bank-files"],"summary":"Get payment orders for payment","description":"Get payment order files for the given payment","operationId":"finances_list_payment_order_files_2","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"type":["integer","null"],"default":1,"minimum":1}},{"name":"perPage","in":"query","schema":{"type":["integer","null"],"minimum":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"type":"array","items":{"title":"Payment order file resource","properties":{"uuid":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date"},"availableUntil":{"type":"string","format":"date"},"bankAccountIban":{"type":"string"},"bankAccountDescription":{"type":"string"}},"type":"object"}},"status":{"example":200},"meta":{"properties":{"pagination":{"properties":{"currentPage":{"type":"integer","minimum":1},"firstPageUrl":{"type":["string","null"],"format":"uri"},"from":{"type":["integer","null"],"example":1},"lastPage":{"type":"integer"},"lastPageUrl":{"type":"string","format":"uri"},"nextPageUrl":{"type":["string","null"],"format":"uri"},"perPage":{"type":"integer","example":50},"previousPageUrl":{"type":["string","null"],"format":"uri"},"to":{"type":["integer","null"],"example":50},"totalItems":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}]}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"ee703da0c6c953ad2689214c0ced08a3","x-required-scopes":["finances"]}},"/accounts/{accountUuid}/finances/v2/payments/{paymentUuid}/actions/{actionKey}":{"patch":{"tags":["payments"],"summary":"Execute payment action","description":"Execute an action on a payment (e.g., archive, restore, sync, resync, markFinished)","operationId":"finances_update_actions","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"actionKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"207eb2dca1f98c051d21700e6b07edd5","x-required-scopes":["finances"],"x-badge":"beta"}},"/accounts/{accountUuid}/finances/v2/payments/{paymentUuid}/actions/archive":{"patch":{"tags":["payments"],"summary":"Archive payment","description":"Archive the given payment","operationId":"6a33e3a7e1a5f689ad96aa143d6e8268","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","description":"Uuid of the payment to archive","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Payment archived","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Bad Request":{"summary":"Bad Request","value":{"detail":[],"type":"validation_error","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Bad request or validation error","status":400}}}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Not found":{"summary":"Not found","value":{"detail":[],"type":"not_found","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Payment not found","status":404}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"}},"/accounts/{accountUuid}/finances/v2/payments/{paymentUuid}/actions/cancel":{"patch":{"tags":["payments"],"summary":"Cancel payment","description":"Cancel the given payment","operationId":"42572e49aebfa769013267db5c56ba37","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","description":"Uuid of the payment to cancel","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Payment cancelled","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Bad Request":{"summary":"Bad Request","value":{"detail":[],"type":"validation_error","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Bad request or validation error","status":400}}}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Not found":{"summary":"Not found","value":{"detail":[],"type":"not_found","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Payment not found","status":404}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"}},"/accounts/{accountUuid}/finances/v2/payments/{paymentUuid}/actions/delete":{"patch":{"tags":["payments"],"summary":"Delete payment","description":"Delete the given payment","operationId":"ffdb7785e12dce1b93cb490add503913","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","description":"Uuid of the payment to delete.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Payment deleted","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Bad Request":{"summary":"Bad Request","value":{"detail":[],"type":"validation_error","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Bad request or validation error","status":400}}}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Not found":{"summary":"Not found","value":{"detail":[],"type":"not_found","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Payment not found","status":404}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"}},"/accounts/{accountUuid}/finances/v2/payments/{paymentUuid}/actions/restore":{"patch":{"tags":["payments"],"summary":"Restore payment","description":"Restore the given payment from the archive","operationId":"73841d88951610e2951e0b03554bbc0f","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","description":"Uuid of the payment to restore","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Payment restored","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Bad Request":{"summary":"Bad Request","value":{"detail":[],"type":"validation_error","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Bad request or validation error","status":400}}}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Not found":{"summary":"Not found","value":{"detail":[],"type":"not_found","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Payment not found","status":404}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"}},"/accounts/{accountUuid}/finances/v2/payments/{paymentUuid}/actions/resync":{"patch":{"tags":["payments"],"summary":"Resync payment","description":"Resend the given payment to the linked Abacus installation","operationId":"fb54d4278f11b4e03da1d91d1e2d4c32","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","description":"Uuid of the payment to resync","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Payment queued for resync","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Bad Request":{"summary":"Bad Request","value":{"detail":[],"type":"validation_error","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Bad request or validation error","status":400}}}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Not found":{"summary":"Not found","value":{"detail":[],"type":"not_found","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Payment not found","status":404}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"}},"/accounts/{accountUuid}/finances/v2/payments/{paymentUuid}/actions/sync":{"patch":{"tags":["payments"],"summary":"Sync payment","description":"Send the given payment to the linked Abacus installation","operationId":"5df280482537e06f70077c193aa9b833","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","description":"Uuid of the payment to restore","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Payment queued for sync","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Bad Request":{"summary":"Bad Request","value":{"detail":[],"type":"validation_error","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Bad request or validation error","status":400}}}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Not found":{"summary":"Not found","value":{"detail":[],"type":"not_found","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Payment not found","status":404}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"}},"/accounts/{accountUuid}/finances/v2/payments/{paymentUuid}/actions/undo_cancel":{"patch":{"tags":["payments"],"summary":"Undo cancel payment","description":"Undo a previously executed cancel of the given payment","operationId":"2069eb6f01fdd0451d6aa485d2f00b55","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","description":"Uuid of the payment to revert the cancellation","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Payment cancellation reverted","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Bad Request":{"summary":"Bad Request","value":{"detail":[],"type":"validation_error","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Bad request or validation error","status":400}}}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Not found":{"summary":"Not found","value":{"detail":[],"type":"not_found","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Payment not found","status":404}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"}},"/accounts/{accountUuid}/finances/v2/payments/{paymentUuid}/attachments/{attachmentUuid}":{"delete":{"tags":["payments"],"summary":"delete attachment","description":"delete an attachment of the payment","operationId":"925e7d75f10065d3ec9c59bb79063a4f","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"paymentUuid","in":"path","description":"the uuid of the payment which the attachment is connected to","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"attachmentUuid","in":"path","description":"the uuid of the attachment to delete","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create payment","required":true,"content":{"application/json":{"schema":{"type":"object","description":"Schema: payment.schema"}}}},"responses":{"200":{"description":"Attachment deleted","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"properties":{"data":{},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Bad Request":{"summary":"Bad Request","value":{"detail":[],"type":"validation_error","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Bad request or validation error","status":400}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardResponseError"},"examples":{"Not found":{"summary":"Not found","value":{"detail":[],"type":"not_found","requestUuid":"0984aa60-42a0-44b0-80a5-a98f3b8e57d8","path":"/path","message":"Resource not found","status":404}}}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-required-scopes":["finances"],"x-badge":"beta"}},"/accounts/{accountUuid}/finances/v2/bank-files/{bankFileUuid}/entries/{bankFileEntryUuid}/payment":{"get":{"tags":["bank-files"],"summary":"Get bank file entry payment","description":"Get a single bank file entry payment","operationId":"finances_list_payment","parameters":[{"name":"accountUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"bankFileUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"bankFileEntryUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},{"properties":{"data":{"title":"Bank File Entry Payment Resource","properties":{"paymentUuid":{"type":"string","format":"uuid"},"paymentId":{"type":"integer","deprecated":true}},"type":"object"},"status":{"example":200}},"type":"object"}]}}}},"400":{"description":"Bad request or validation error","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"allOf":[{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},{"properties":{}}]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"351a5a46e47f24505d5ed20afc152f94","x-required-scopes":["finances"]}}},"components":{"securitySchemes":{"ApiToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication. Create tokens in Settings > API Token."}},"schemas":{"StandardResponse":{"description":"The response format of most endpoints for successful requests","required":["data","message","status"],"properties":{"data":{"title":"data"},"message":{"title":"message","type":"string"},"status":{"title":"status","description":"HTTP status code","type":"integer"},"meta":{"title":"meta","type":["object","null"]}},"type":"object"},"PaymentLiteResource":{"properties":{"uuid":{"type":"string","format":"uuid"},"direction":{"type":"string","enum":["IN","OUT"]},"paymentDate":{"type":"string","format":"date"},"amount":{"type":"number","format":"double"},"status":{"type":"string"}},"type":"object"},"PaymentResource":{"properties":{"uuid":{"type":"string","format":"uuid"},"amount":{"type":"number","format":"double"},"currencyCode":{"type":"string","format":"iso-4217","maxLength":3,"minLength":3},"paymentDate":{"type":"string","format":"date"},"paymentInfo":{"type":["string","null"]},"isPayroll":{"type":"boolean"},"paymentDirection":{"type":"string","enum":["IN","OUT"]},"paymentType":{"type":["string","null"],"enum":["BANK","BITPAY","CARD_TERMINAL","CASH","CASH_ON_DELIVERY","INSTANT_TRANSFER","PAYPAL","TWINT","WIR","VOUCHER_OWN","VOUCHER_THIRD_PARTY","CREDIT_NOTE","CREDIT_NOTE_OFFSET","DISCOUNT","CASH_DISCOUNT","DEBIT_LOSS","DEBIT_CREDIT_CARD","DONATION","CARD_COMMISSIONS","CURRENT_ACCOUNT","PREPAYMENT","PRIVATE"]},"isArchived":{"type":"boolean"},"status":{"type":"string"},"bankAccount":{"$ref":"#/components/schemas/PaymentBankAccountResource"},"addressBankAccount":{"$ref":"#/components/schemas/PaymentAddressBankAccountResource"},"reference":{"type":"string"},"isPaymentOrder":{"type":"boolean"},"processing":{"oneOf":[{"properties":{"type":{"type":"string","enum":["manual"]},"taxRate":{"type":["number","null"],"format":"double"},"description":{"type":["string","null"]},"bookingAccountNumber":{"type":["number","null"],"format":"int64"},"bookingContraAccountNumber":{"type":["number","null"],"format":"int64"},"attachmentUuid":{"type":["string","null"],"format":"uuid"}},"type":"object"},{"properties":{"type":{"type":"string","enum":["receipt"]},"document":{"properties":{"uuid":{"type":["string","null"],"format":"uuid"},"documentNumber":{"type":["string","null"]},"documentType":{"type":["string","null"]},"documentAmount":{"type":["number","null"],"format":"double"},"documentCurrencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"addressUuid":{"type":["string","null"],"format":"uuid"},"customerNumber":{"type":["string","null"]},"receiverName":{"type":["string","null"]}},"type":"object"},"sendPaymentConfirmation":{"type":"boolean"},"exchangeRate":{"type":"number","format":"double"},"exchangeCurrencyAmount":{"type":"number","format":"double"}},"type":"object"},{"properties":{"type":{"type":"string","enum":["receipt"]},"document":{"properties":{"uuid":{"type":["string","null"],"format":"uuid"},"documentNumber":{"type":["string","null"]},"documentType":{"type":["string","null"]},"documentAmount":{"type":["number","null"],"format":"double"},"documentCurrencyCode":{"type":["string","null"],"format":"iso-4217","maxLength":3,"minLength":3},"addressUuid":{"type":["string","null"],"format":"uuid"},"customerNumber":{"type":["string","null"]},"receiverName":{"type":["string","null"]}},"type":"object"},"infoMessage":{"type":["string","null"]},"exchangeRate":{"type":"number","format":"double"},"exchangeCurrencyAmount":{"type":"number","format":"double"}},"type":"object"}]}},"type":"object"},"StandardResponseError":{"description":"The response format of most endpoints for erronous requests","required":["detail","type","message","status"],"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","type":"string","format":"uuid"},"path":{"title":"path","type":"string"},"message":{"title":"message","type":["string","null"]},"status":{"title":"status","description":"HTTP status code","type":"integer"}},"type":"object"},"PaymentActionResource":{"properties":{"key":{"enum":["cancel","undo_cancel","delete","archive","restore","sync","resync","edit","show","info","activity","unknown"]},"description":{"type":"string"}},"type":"object"},"PaymentBankAccountResource":{"properties":{"uuid":{"type":"string","format":"uuid"},"iban":{"type":["string","null"]}},"type":"object"},"PaymentAddressBankAccountResource":{"properties":{"uuid":{"type":"string","format":"uuid"},"iban":{"type":["string","null"]}},"type":"object"}}}}