{"openapi":"3.1.0","info":{"title":"AbaNinja Finances API - Bank Files","version":"3.0.0","x-domain-id":"finances"},"servers":[{"url":"https://api.abaninja.ch","description":"The AbaNinja API server"}],"tags":[{"name":"bank-files","description":"Manage bank files","x-displayName":"Bank Files"}],"security":[{"ApiToken":[]}],"paths":{"/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":{"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"}},"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/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":{"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"}},"message":{"title":"message","type":"string"},"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"}},"required":["data","message","status"]}}}}},"security":[{"ApiToken":["https://api.abaninja.ch/auth/finances"]}],"x-legacy-operation-id":"d620f2409a5341a068a1e6b5a2dd36d1","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":{"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"},"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/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":{"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"}},"message":{"title":"message","type":"string"},"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"}},"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/finances"]}],"x-legacy-operation-id":"90e8a3e3bc4108f5935dd40f529aa9a2","x-required-scopes":["finances"]}},"/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":{"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"}},"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/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":{"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"}},"message":{"title":"message","type":"string"},"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"}},"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/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":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","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/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":{"properties":{"detail":{"title":"details"},"type":{"title":"type","type":"string"},"requestUuid":{"title":"requestUuid","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/finances"]}],"x-legacy-operation-id":"52f15135326ffa378216167c7cea6394","x-required-scopes":["finances"]}},"/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":{"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"}},"message":{"title":"message","type":"string"},"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"}},"required":["data","message","status"]}}}},"404":{"description":"Payment 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/finances"]}],"x-legacy-operation-id":"ee703da0c6c953ad2689214c0ced08a3","x-required-scopes":["finances"]}},"/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":{"properties":{"data":{"title":"Bank File Entry Payment Resource","properties":{"paymentUuid":{"type":"string","format":"uuid"},"paymentId":{"type":"integer","deprecated":true}},"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/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."}}}}