accounting-migration

← All modules

4 endpoints.

GET /api/v1/accounting/migration/catalogue

Catalogue

What can be imported, from where, and which columns each dataset wants.

200 — Successful Response

{
  "additionalProperties": true,
  "type": "object",
  "title": "Response Catalogue Api V1 Accounting Migration Catalogue Get"
}

---

POST /api/v1/accounting/migration/preview

Preview

Dry-run the import and report what it would do.

Answers 200 with ok: false and a message for a problem WITH THE FILE (a trial balance that doesn't balance, an unmapped required column) — that is the normal outcome of a first upload, not an API error, and the page shows it beside the mapping controls so it can be corrected in place.

200 — Successful Response

{
  "additionalProperties": true,
  "type": "object",
  "title": "Response Preview Api V1 Accounting Migration Preview Post"
}

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"
}

---

POST /api/v1/accounting/migration/import

Run Import

Import the file into these books and record the run.

200 — Successful Response

{
  "additionalProperties": true,
  "type": "object",
  "title": "Response Run Import Api V1 Accounting Migration Import Post"
}

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/accounting/migration/runs

Runs

Import history for these books, most recent first.

Parameters

Name	In	Required	Type	Description
company_id	query	no
limit	query	no	integer

200 — Successful Response

{
  "type": "array",
  "items": {
    "type": "object",
    "additionalProperties": true
  },
  "title": "Response Runs Api V1 Accounting Migration Runs Get"
}

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"
}