fnb-bank-sync

← All modules

4 endpoints.

GET /api/v1/fnb-bank-sync/settings

Get Settings

The FNB Bank Sync settings, password withheld.

200 — Successful Response

{}

---

PUT /api/v1/fnb-bank-sync/settings

Update Settings

Request body

{
  "properties": {
    "username": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 140
        },
        {
          "type": "null"
        }
      ],
      "title": "Username"
    },
    "password": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 512
        },
        {
          "type": "null"
        }
      ],
      "title": "Password"
    },
    "account_number": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 64
        },
        {
          "type": "null"
        }
      ],
      "title": "Account Number"
    },
    "proxy_server": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 255
        },
        {
          "type": "null"
        }
      ],
      "title": "Proxy Server"
    },
    "default_bank_account_id": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Default Bank Account Id"
    }
  },
  "type": "object",
  "title": "FnbSettingsIn",
  "description": "Partial update for the FNB Bank Sync settings. A field omitted (``None``)\nis left untouched; an empty string clears that field's override."
}

200 — Successful Response

{}

422 — Validation Error

{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

---

GET /api/v1/fnb-bank-sync/status

Status

Settings + a quick reconciliation snapshot for the configured account.

200 — Successful Response

{}

---

POST /api/v1/fnb-bank-sync/scrape

Scrape

Pull FNB transactions into the configured default bank account. Pass statement_text (downloaded OFX/CSV) for the working path; the credential-driven live login is a gated scaffold.

Request body

{
  "properties": {
    "statement_text": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Statement Text"
    },
    "fmt": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Fmt"
    }
  },
  "type": "object",
  "title": "Body_scrape_api_v1_fnb_bank_sync_scrape_post"
}

200 — Successful Response

{}

422 — Validation Error

{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}