Zum Inhalt springen

Reports

Cash-basis income statement (EÜR), advance VAT return (Umsatzsteuer-Voranmeldung) boxes and DATEV export.
GET/api/v1/exports

Permission: reports:read

Query parameters

  • limitinteger
    Number of entries (1–100)
    1–100 · Default: 25
  • cursorstring
    `nextCursor` of the previous page
    max. 500 characters

Response 200

  • object"list"required
  • dataArray<Export>required
    • idstringrequired
    • kind"datev"required
    • fromstring (date)required
      Date (YYYY-MM-DD)
    • tostring (date)required
      Date (YYYY-MM-DD)
    • status"ready" | "failed"required
    • includeobjectrequired
      • bookingsbooleanrequired
      • partnersbooleanrequired
      • documentsbooleanrequired
    • countsobjectrequired
      • entriesintegerrequired
        -9007199254740991–9007199254740991
      • rowsintegerrequired
        -9007199254740991–9007199254740991
      • partnersintegerrequired
        -9007199254740991–9007199254740991
      • documentsintegerrequired
        -9007199254740991–9007199254740991
      • batchesinteger
        Number of DATEV batches (locked and open separately, DA-05)
        -9007199254740991–9007199254740991
    • warningsArray<string>required
    • fileNamestringrequired
    • sizeintegerrequired
      -9007199254740991–9007199254740991
    • errorstring | nullrequired
    • createdAtstring (date-time)required
      Timestamp (ISO 8601)
  • hasMorebooleanrequired
  • nextCursorstring | nullrequired

Possible errors: 400, 401, 403, 429, 500

curl 'https://www.debt-flow.io/api/v1/exports' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"
Response 200
{
  "object": "list",
  "data": [
    {
      "id": "string",
      "kind": "datev",
      "from": "2026-11-01",
      "to": "2026-11-01",
      "status": "ready",
      "include": {
        "bookings": false,
        "partners": false,
        "documents": false
      },
      "counts": {
        "entries": 0,
        "rows": 0,
        "partners": 0,
        "documents": 0,
        "batches": 0
      },
      "warnings": [
        "string"
      ],
      "fileName": "string",
      "size": 0,
      "error": "string",
      "createdAt": "2026-11-01T09:30:00.000Z"
    }
  ],
  "hasMore": false,
  "nextCursor": "string"
}
POST/api/v1/exports

Generates a ZIP containing a DATEV batch of journal entries (Buchungsstapel; EXTF, format version 13), debtor/creditor master data and optionally receipt images (document.xml, linked via “Beleglink”). Period within one financial year. Requires the DATEV consultant number and client number in the settings. Event export.ready.

Permission: reports:read

Headers

  • Idempotency-Keystring
    Unique key (8–255 characters). Repeated requests with the same key return the same response for 24 h.
    max. 255 characters

Body (JSON) · ExportCreate

  • kind"datev"
    Default: "datev"
  • fromstring (date)required
    Date (YYYY-MM-DD)
  • tostring (date)required
    Date (YYYY-MM-DD)
  • includeobject
    Default: {"bookings":true,"partners":true,"documents":false}
    • bookingsboolean
      Posting batch
      Default: true
    • partnersboolean
      Debtor/creditor master data
      Default: true
    • documentsboolean
      Document images (PDF/images) with document.xml
      Default: false

Response 201 · Export

  • idstringrequired
  • kind"datev"required
  • fromstring (date)required
    Date (YYYY-MM-DD)
  • tostring (date)required
    Date (YYYY-MM-DD)
  • status"ready" | "failed"required
  • includeobjectrequired
    • bookingsbooleanrequired
    • partnersbooleanrequired
    • documentsbooleanrequired
  • countsobjectrequired
    • entriesintegerrequired
      -9007199254740991–9007199254740991
    • rowsintegerrequired
      -9007199254740991–9007199254740991
    • partnersintegerrequired
      -9007199254740991–9007199254740991
    • documentsintegerrequired
      -9007199254740991–9007199254740991
    • batchesinteger
      Number of DATEV batches (locked and open separately, DA-05)
      -9007199254740991–9007199254740991
  • warningsArray<string>required
  • fileNamestringrequired
  • sizeintegerrequired
    -9007199254740991–9007199254740991
  • errorstring | nullrequired
  • createdAtstring (date-time)required
    Timestamp (ISO 8601)

Possible errors: 400, 401, 403, 409, 422, 429, 500

curl -X POST 'https://www.debt-flow.io/api/v1/exports' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "kind": "datev",
  "from": "2026-11-01",
  "to": "2026-11-01",
  "include": {
    "bookings": true,
    "partners": true,
    "documents": false
  }
}'
Response 201
{
  "id": "string",
  "kind": "datev",
  "from": "2026-11-01",
  "to": "2026-11-01",
  "status": "ready",
  "include": {
    "bookings": false,
    "partners": false,
    "documents": false
  },
  "counts": {
    "entries": 0,
    "rows": 0,
    "partners": 0,
    "documents": 0,
    "batches": 0
  },
  "warnings": [
    "string"
  ],
  "fileName": "string",
  "size": 0,
  "error": "string",
  "createdAt": "2026-11-01T09:30:00.000Z"
}
GET/api/v1/exports/{id}

Permission: reports:read

Path parameters

  • idstringrequired
    Resource ID
    max. 128 characters

Response 200 · Export

  • idstringrequired
  • kind"datev"required
  • fromstring (date)required
    Date (YYYY-MM-DD)
  • tostring (date)required
    Date (YYYY-MM-DD)
  • status"ready" | "failed"required
  • includeobjectrequired
    • bookingsbooleanrequired
    • partnersbooleanrequired
    • documentsbooleanrequired
  • countsobjectrequired
    • entriesintegerrequired
      -9007199254740991–9007199254740991
    • rowsintegerrequired
      -9007199254740991–9007199254740991
    • partnersintegerrequired
      -9007199254740991–9007199254740991
    • documentsintegerrequired
      -9007199254740991–9007199254740991
    • batchesinteger
      Number of DATEV batches (locked and open separately, DA-05)
      -9007199254740991–9007199254740991
  • warningsArray<string>required
  • fileNamestringrequired
  • sizeintegerrequired
    -9007199254740991–9007199254740991
  • errorstring | nullrequired
  • createdAtstring (date-time)required
    Timestamp (ISO 8601)

Possible errors: 400, 401, 403, 404, 429, 500

curl 'https://www.debt-flow.io/api/v1/exports/ID' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"
Response 200
{
  "id": "string",
  "kind": "datev",
  "from": "2026-11-01",
  "to": "2026-11-01",
  "status": "ready",
  "include": {
    "bookings": false,
    "partners": false,
    "documents": false
  },
  "counts": {
    "entries": 0,
    "rows": 0,
    "partners": 0,
    "documents": 0,
    "batches": 0
  },
  "warnings": [
    "string"
  ],
  "fileName": "string",
  "size": 0,
  "error": "string",
  "createdAt": "2026-11-01T09:30:00.000Z"
}
GET/api/v1/exports/{id}/download

Permission: reports:read

Path parameters

  • idstringrequired
    Resource ID
    max. 128 characters

Response 200

File (application/zip).

Possible errors: 400, 401, 403, 404, 429, 500

curl 'https://www.debt-flow.io/api/v1/exports/ID/download' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"
GET/api/v1/reports/asset-register

Fixed assets with book value at the start of the year, additions, depreciation, disposals (remaining book value) and book value at the end of the year – the basis of the Anlage AVEÜR form.

Permission: reports:read

Query parameters

  • yearintegerrequired
    2000–2100

Response 200 · AssetRegister

  • yearintegerrequired
    -9007199254740991–9007199254740991
  • itemsArray<object>required
    • idstringrequired
    • namestringrequired
    • inventoryNumberstring | nullrequired
    • assetClass"software" | "vehicle" | "office" | "equipment"required
    • method"linear" | "pool" | "gwg" | "immediate"required
    • acquisitionDatestring (date)required
      Date (YYYY-MM-DD)
    • costCentsintegerrequired
      Amount in cents
      -100000000000–100000000000
    • usefulLifeMonthsinteger | nullrequired
      -9007199254740991–9007199254740991
    • openingCentsintegerrequired
      Amount in cents
      -100000000000–100000000000
    • additionCentsintegerrequired
      Amount in cents
      -100000000000–100000000000
    • depreciationCentsintegerrequired
      Amount in cents
      -100000000000–100000000000
    • disposalCentsintegerrequired
      Amount in cents
      -100000000000–100000000000
    • closingCentsintegerrequired
      Amount in cents
      -100000000000–100000000000
  • totalsobjectrequired
    • openingCentsintegerrequired
      Amount in cents
      -100000000000–100000000000
    • additionCentsintegerrequired
      Amount in cents
      -100000000000–100000000000
    • depreciationCentsintegerrequired
      Amount in cents
      -100000000000–100000000000
    • disposalCentsintegerrequired
      Amount in cents
      -100000000000–100000000000
    • closingCentsintegerrequired
      Amount in cents
      -100000000000–100000000000
  • notesArray<string>required

Possible errors: 400, 401, 403, 429, 500

curl 'https://www.debt-flow.io/api/v1/reports/asset-register?year=2000' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"
Response 200
{
  "year": 0,
  "items": [
    {
      "id": "string",
      "name": "string",
      "inventoryNumber": "string",
      "assetClass": "software",
      "method": "linear",
      "acquisitionDate": "2026-11-01",
      "costCents": 0,
      "usefulLifeMonths": 0,
      "openingCents": 0,
      "additionCents": 0,
      "depreciationCents": 0,
      "disposalCents": 0,
      "closingCents": 0
    }
  ],
  "totals": {
    "openingCents": 0,
    "additionCents": 0,
    "depreciationCents": 0,
    "disposalCents": 0,
    "closingCents": 0
  },
  "notes": [
    "string"
  ]
}
GET/api/v1/reports/euer

Business income and expenses by the boxes of Anlage EÜR, determined on a cash-received/cash-paid basis (§ 11 EStG) – regardless of the VAT accounting method. unmapped lists revenue/expense accounts that are not mapped to a box.

Permission: reports:read

Query parameters

  • yearintegerrequired
    2000–2100

Response 200 · EuerReport

  • kind"euer"required
  • yearintegerrequired
    -9007199254740991–9007199254740991
  • fromstring (date)required
    Date (YYYY-MM-DD)
  • tostring (date)required
    Date (YYYY-MM-DD)
  • labelstringrequired
  • basis"cash" | "accrual"required
    cash = cash basis (Ist), accrual = invoice basis (Soll)
  • entryCountintegerrequired
    -9007199254740991–9007199254740991
  • closedbooleanrequired
    Period fully locked
  • warningsArray<JournalIssue>required
    • typeenumrequired
      Values: unbooked_receipt, unassigned_bank_transaction, unknown_category, payment_without_invoice, unsupported_tax, changed_after_closing, missing_after_closing, assumed_service_date, tax_missing_after_closing, tax_changed_after_closing, small_business_reporting, small_business_tax_payment, asset_not_registered, review_required
    • sourceIdstringrequired
    • datestring (date)required
      Date (YYYY-MM-DD)
    • messagestringrequired
    • amountCentsinteger
      Amount in cents
      -100000000000–100000000000
  • linesArray<object>required
    • kzstringrequired
    • labelstringrequired
    • sectionstringrequired
    • centsintegerrequired
      Amount in cents
      -100000000000–100000000000
    • sumbooleanrequired
  • incomeCentsintegerrequired
    Amount in cents
    -100000000000–100000000000
  • expenseCentsintegerrequired
    Amount in cents
    -100000000000–100000000000
  • profitCentsintegerrequired
    Amount in cents
    -100000000000–100000000000
  • unmappedArray<object>required
    • accountstringrequired
    • labelstringrequired
    • centsintegerrequired
      Amount in cents
      -100000000000–100000000000

Possible errors: 400, 401, 403, 429, 500

curl 'https://www.debt-flow.io/api/v1/reports/euer?year=2000' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"
Response 200
{
  "kind": "euer",
  "year": 0,
  "from": "2026-11-01",
  "to": "2026-11-01",
  "label": "string",
  "basis": "cash",
  "entryCount": 0,
  "closed": false,
  "warnings": [
    {
      "type": "unbooked_receipt",
      "sourceId": "string",
      "date": "2026-11-01",
      "message": "string",
      "amountCents": 0
    }
  ],
  "lines": [
    {
      "kz": "string",
      "label": "string",
      "section": "string",
      "cents": 0,
      "sum": false
    }
  ],
  "incomeCents": 0,
  "expenseCents": 0,
  "profitCents": 0,
  "unmapped": [
    {
      "account": "string",
      "label": "string",
      "cents": 0
    }
  ]
}
GET/api/v1/reports/euer/pdf

Permission: reports:read

Query parameters

  • yearintegerrequired
    2000–2100

Response 200

File (application/pdf).

Possible errors: 400, 401, 403, 429, 500

curl 'https://www.debt-flow.io/api/v1/reports/euer/pdf?year=2000' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"
GET/api/v1/reports/open-items

Open receivables (finalised invoices less payments) or open payables (posted, unpaid receipts) as at the reference date, with ageing by due date.

Permission: reports:read

Query parameters

  • kind"receivables" | "payables"
    Default: "receivables"
  • asOfstring (date)
    Reference date (default: today)

Response 200 · OpenItems

  • kind"receivables" | "payables"required
  • asOfstring (date)required
    Date (YYYY-MM-DD)
  • itemsArray<object>required
    • idstringrequired
    • kind"receivable" | "payable"required
    • documentType"invoice" | "credit_note" | "cancellation" | "receipt"required
      Invoice corrections/cancellations with a pending refund appear as negative
    • numberstringrequired
    • namestringrequired
    • datestring (date)required
      Date (YYYY-MM-DD)
    • dueDatestring (date) | nullrequired
      Date (YYYY-MM-DD)
    • grossCentsintegerrequired
      Amount in cents
      -100000000000–100000000000
    • amountDueCentsintegerrequired
      Receivable after deducting progress invoices
      -100000000000–100000000000
    • paidCentsintegerrequired
      Payments up to the reference date (net of reversals)
      -100000000000–100000000000
    • creditedCentsintegerrequired
      reduced by invoice corrections up to the reference date
      -100000000000–100000000000
    • openCentsintegerrequired
      amount actually outstanding (DA-09)
      -100000000000–100000000000
    • daysOverdueintegerrequired
      -9007199254740991–9007199254740991
    • bucket"not_due" | "d1_30" | "d31_60" | "d61_90" | "d90_plus"required
  • totalsobjectrequired
    • not_dueintegerrequired
      Amount in cents
      -100000000000–100000000000
    • d1_30integerrequired
      Amount in cents
      -100000000000–100000000000
    • d31_60integerrequired
      Amount in cents
      -100000000000–100000000000
    • d61_90integerrequired
      Amount in cents
      -100000000000–100000000000
    • d90_plusintegerrequired
      Amount in cents
      -100000000000–100000000000
    • totalCentsintegerrequired
      Amount in cents
      -100000000000–100000000000

Possible errors: 400, 401, 403, 429, 500

curl 'https://www.debt-flow.io/api/v1/reports/open-items' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"
Response 200
{
  "kind": "receivables",
  "asOf": "2026-11-01",
  "items": [
    {
      "id": "string",
      "kind": "receivable",
      "documentType": "invoice",
      "number": "string",
      "name": "string",
      "date": "2026-11-01",
      "dueDate": "2026-11-01",
      "grossCents": 0,
      "amountDueCents": 0,
      "paidCents": 0,
      "creditedCents": 0,
      "openCents": 0,
      "daysOverdue": 0,
      "bucket": "not_due"
    }
  ],
  "totals": {
    "not_due": 0,
    "d1_30": 0,
    "d31_60": 0,
    "d61_90": 0,
    "d90_plus": 0,
    "totalCents": 0
  }
}
GET/api/v1/reports/summary

Revenue and expenses (net) per month and per account from the journal.

Permission: reports:read

Query parameters

  • fromstring (date)required
    Date (YYYY-MM-DD)
  • tostring (date)required
    Date (YYYY-MM-DD)

Response 200 · AccountingSummary

  • fromstring (date)required
    Date (YYYY-MM-DD)
  • tostring (date)required
    Date (YYYY-MM-DD)
  • labelstringrequired
  • basis"cash" | "accrual"required
    cash = cash basis (Ist), accrual = invoice basis (Soll)
  • entryCountintegerrequired
    -9007199254740991–9007199254740991
  • closedbooleanrequired
    Period fully locked
  • warningsArray<JournalIssue>required
    • typeenumrequired
      Values: unbooked_receipt, unassigned_bank_transaction, unknown_category, payment_without_invoice, unsupported_tax, changed_after_closing, missing_after_closing, assumed_service_date, tax_missing_after_closing, tax_changed_after_closing, small_business_reporting, small_business_tax_payment, asset_not_registered, review_required
    • sourceIdstringrequired
    • datestring (date)required
      Date (YYYY-MM-DD)
    • messagestringrequired
    • amountCentsinteger
      Amount in cents
      -100000000000–100000000000
  • monthsArray<object>required
    • monthstringrequired
    • revenueCentsintegerrequired
      Amount in cents
      -100000000000–100000000000
    • expenseCentsintegerrequired
      Amount in cents
      -100000000000–100000000000
    • resultCentsintegerrequired
      Amount in cents
      -100000000000–100000000000
  • revenueByAccountArray<object>required
    • accountstringrequired
    • labelstringrequired
    • centsintegerrequired
      Amount in cents
      -100000000000–100000000000
  • expenseByAccountArray<object>required
    • accountstringrequired
    • labelstringrequired
    • centsintegerrequired
      Amount in cents
      -100000000000–100000000000
  • revenueCentsintegerrequired
    Amount in cents
    -100000000000–100000000000
  • expenseCentsintegerrequired
    Amount in cents
    -100000000000–100000000000
  • resultCentsintegerrequired
    Amount in cents
    -100000000000–100000000000

Possible errors: 400, 401, 403, 429, 500

curl 'https://www.debt-flow.io/api/v1/reports/summary?from=2026-11-01&to=2026-11-01' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"
Response 200
{
  "from": "2026-11-01",
  "to": "2026-11-01",
  "label": "string",
  "basis": "cash",
  "entryCount": 0,
  "closed": false,
  "warnings": [
    {
      "type": "unbooked_receipt",
      "sourceId": "string",
      "date": "2026-11-01",
      "message": "string",
      "amountCents": 0
    }
  ],
  "months": [
    {
      "month": "string",
      "revenueCents": 0,
      "expenseCents": 0,
      "resultCents": 0
    }
  ],
  "revenueByAccount": [
    {
      "account": "string",
      "label": "string",
      "cents": 0
    }
  ],
  "expenseByAccount": [
    {
      "account": "string",
      "label": "string",
      "cents": 0
    }
  ],
  "revenueCents": 0,
  "expenseCents": 0,
  "resultCents": 0
}
GET/api/v1/reports/trial-balance

Debit, credit and balance per account (including tax and personal accounts) for the period.

Permission: reports:read

Query parameters

  • fromstring (date)required
    Date (YYYY-MM-DD)
  • tostring (date)required
    Date (YYYY-MM-DD)

Response 200 · TrialBalance

  • fromstring (date)required
    Date (YYYY-MM-DD)
  • tostring (date)required
    Date (YYYY-MM-DD)
  • labelstringrequired
  • basis"cash" | "accrual"required
    cash = cash basis (Ist), accrual = invoice basis (Soll)
  • entryCountintegerrequired
    -9007199254740991–9007199254740991
  • closedbooleanrequired
    Period fully locked
  • warningsArray<JournalIssue>required
    • typeenumrequired
      Values: unbooked_receipt, unassigned_bank_transaction, unknown_category, payment_without_invoice, unsupported_tax, changed_after_closing, missing_after_closing, assumed_service_date, tax_missing_after_closing, tax_changed_after_closing, small_business_reporting, small_business_tax_payment, asset_not_registered, review_required
    • sourceIdstringrequired
    • datestring (date)required
      Date (YYYY-MM-DD)
    • messagestringrequired
    • amountCentsinteger
      Amount in cents
      -100000000000–100000000000
  • rowsArray<object>required
    • accountstringrequired
    • labelstringrequired
    • typestringrequired
    • debitCentsintegerrequired
      Amount in cents
      -100000000000–100000000000
    • creditCentsintegerrequired
      Amount in cents
      -100000000000–100000000000
    • balanceCentsintegerrequired
      Amount in cents
      -100000000000–100000000000

Possible errors: 400, 401, 403, 429, 500

curl 'https://www.debt-flow.io/api/v1/reports/trial-balance?from=2026-11-01&to=2026-11-01' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"
Response 200
{
  "from": "2026-11-01",
  "to": "2026-11-01",
  "label": "string",
  "basis": "cash",
  "entryCount": 0,
  "closed": false,
  "warnings": [
    {
      "type": "unbooked_receipt",
      "sourceId": "string",
      "date": "2026-11-01",
      "message": "string",
      "amountCents": 0
    }
  ],
  "rows": [
    {
      "account": "string",
      "label": "string",
      "type": "string",
      "debitCents": 0,
      "creditCents": 0,
      "balanceCents": 0
    }
  ]
}
GET/api/v1/reports/vat-return

Boxes of the advance VAT return (Umsatzsteuer-Voranmeldung) (including Kz 81, 86, 35/36, 41, 43, 21, 45, 60, 46/47, 84/85, 89, 93, 66, 61, 62, 67, 39, 83) for a month, quarter or year from the journal (accrual or cash VAT accounting (Soll-/Ist-Versteuerung) as per the settings). Tax bases in whole euros. No submission to ELSTER.

Permission: reports:read

Query parameters

  • yearintegerrequired
    2000–2100
  • periodenumrequired
    M01–M12 (month), Q1–Q4 (quarter) or Y (year)
    Values: M01, M02, M03, M04, M05, M06, M07, M08, M09, M10, M11, M12, Q1, Q2, Q3, Q4, Y

Response 200 · VatReturn

  • kind"ustva"required
  • yearintegerrequired
    -9007199254740991–9007199254740991
  • periodenumrequired
    Values: M01, M02, M03, M04, M05, M06, M07, M08, M09, M10, M11, M12, Q1, Q2, Q3, Q4, Y
  • fromstring (date)required
    Date (YYYY-MM-DD)
  • tostring (date)required
    Date (YYYY-MM-DD)
  • labelstringrequired
  • basis"cash" | "accrual"required
    cash = cash basis (Ist), accrual = invoice basis (Soll)
  • entryCountintegerrequired
    -9007199254740991–9007199254740991
  • closedbooleanrequired
    Period fully locked
  • warningsArray<JournalIssue>required
    • typeenumrequired
      Values: unbooked_receipt, unassigned_bank_transaction, unknown_category, payment_without_invoice, unsupported_tax, changed_after_closing, missing_after_closing, assumed_service_date, tax_missing_after_closing, tax_changed_after_closing, small_business_reporting, small_business_tax_payment, asset_not_registered, review_required
    • sourceIdstringrequired
    • datestring (date)required
      Date (YYYY-MM-DD)
    • messagestringrequired
    • amountCentsinteger
      Amount in cents
      -100000000000–100000000000
  • linesArray<object>required
    • kzstringrequired
    • labelstringrequired
    • baseCentsinteger | nullrequired
      Taxable amount (whole euros, in cents)
      -100000000000–100000000000
    • taxCentsinteger | nullrequired
      Amount in cents
      -100000000000–100000000000
    • exactBaseCentsinteger | null
      ST-17: tax base according to the tax journal (to the cent, before rounding)
      -100000000000–100000000000
    • bookedTaxCentsinteger | null
      ST-17: booked VAT according to the tax journal (fields 81/86/89/93: difference to the formula tax = rounding)
      -100000000000–100000000000
    • rateLabelstring | null
      Tax rate of the formula tax (e.g. 19%)
  • payableCentsintegerrequired
    Box 83: positive = VAT payable, negative = refund
    -100000000000–100000000000
  • bookedOutputTaxCentsintegerrequired
    Amount in cents
    -100000000000–100000000000
  • inputTaxCentsintegerrequired
    Amount in cents
    -100000000000–100000000000
  • explanationArray<string>required
  • smallBusinessbooleanrequired

Possible errors: 400, 401, 403, 429, 500

curl 'https://www.debt-flow.io/api/v1/reports/vat-return?year=2000&period=M01' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"
Response 200
{
  "kind": "ustva",
  "year": 0,
  "period": "M01",
  "from": "2026-11-01",
  "to": "2026-11-01",
  "label": "string",
  "basis": "cash",
  "entryCount": 0,
  "closed": false,
  "warnings": [
    {
      "type": "unbooked_receipt",
      "sourceId": "string",
      "date": "2026-11-01",
      "message": "string",
      "amountCents": 0
    }
  ],
  "lines": [
    {
      "kz": "string",
      "label": "string",
      "baseCents": 0,
      "taxCents": 0,
      "exactBaseCents": 0,
      "bookedTaxCents": 0,
      "rateLabel": "string"
    }
  ],
  "payableCents": 0,
  "bookedOutputTaxCents": 0,
  "inputTaxCents": 0,
  "explanation": [
    "string"
  ],
  "smallBusiness": false
}
GET/api/v1/reports/vat-return/pdf

Boxes with explanations as a PDF for your own records or for your tax adviser.

Permission: reports:read

Query parameters

  • yearintegerrequired
    2000–2100
  • periodenumrequired
    M01–M12 (month), Q1–Q4 (quarter) or Y (year)
    Values: M01, M02, M03, M04, M05, M06, M07, M08, M09, M10, M11, M12, Q1, Q2, Q3, Q4, Y

Response 200

File (application/pdf).

Possible errors: 400, 401, 403, 429, 500

curl 'https://www.debt-flow.io/api/v1/reports/vat-return/pdf?year=2000&period=M01' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"
GET/api/v1/tax-reports

Permission: reports:read

Query parameters

  • limitinteger
    Number of entries (1–100)
    1–100 · Default: 25
  • cursorstring
    `nextCursor` of the previous page
    max. 500 characters

Response 200

  • object"list"required
  • dataArray<TaxReport>required
    • idstringrequired
    • kind"ustva" | "euer"required
    • yearintegerrequired
      -9007199254740991–9007199254740991
    • periodenum | nullrequired
      Values: M01, M02, M03, M04, M05, M06, M07, M08, M09, M10, M11, M12, Q1, Q2, Q3, Q4, Y
    • labelstringrequired
    • fromstring (date)required
      Date (YYYY-MM-DD)
    • tostring (date)required
      Date (YYYY-MM-DD)
    • basis"cash" | "accrual"required
    • linesArray<object>required
      • kzstringrequired
      • labelstringrequired
      • baseCentsinteger | nullrequired
        Amount in cents
        -100000000000–100000000000
      • taxCentsinteger | nullrequired
        Amount in cents
        -100000000000–100000000000
    • resultCentsintegerrequired
      Advance VAT return: box 83, EÜR: profit/loss
      -100000000000–100000000000
    • notestringrequired
    • contentHashstringrequired
    • createdByActorrequired
      • type"user" | "api_key" | "oauth" | "system"required
      • idstringrequired
      • labelstring
    • createdAtstring (date-time)required
      Timestamp (ISO 8601)
  • hasMorebooleanrequired
  • nextCursorstring | nullrequired

Possible errors: 400, 401, 403, 429, 500

curl 'https://www.debt-flow.io/api/v1/tax-reports' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"
Response 200
{
  "object": "list",
  "data": [
    {
      "id": "string",
      "kind": "ustva",
      "year": 0,
      "period": "M01",
      "label": "string",
      "from": "2026-11-01",
      "to": "2026-11-01",
      "basis": "cash",
      "lines": [
        {
          "kz": "string",
          "label": "string",
          "baseCents": null,
          "taxCents": null
        }
      ],
      "resultCents": 0,
      "note": "string",
      "contentHash": "string",
      "createdBy": {
        "type": "user",
        "id": "string",
        "label": "string"
      },
      "createdAt": "2026-11-01T09:30:00.000Z"
    }
  ],
  "hasMore": false,
  "nextCursor": "string"
}
POST/api/v1/tax-reports

Saves the current advance VAT return (kind: ustva, period) or cash-basis income statement (EÜR) as an immutable snapshot with a checksum, e.g. after transferring it to ELSTER. DebtFlow does not submit anything to the tax office.

Permission: accounting:write

Headers

  • Idempotency-Keystring
    Unique key (8–255 characters). Repeated requests with the same key return the same response for 24 h.
    max. 255 characters

Body (JSON) · TaxReportCreate

  • kind"ustva" | "euer"required
  • yearintegerrequired
    2000–2100
  • periodenum
    advance VAT return only
    Values: M01, M02, M03, M04, M05, M06, M07, M08, M09, M10, M11, M12, Q1, Q2, Q3, Q4, Y
  • notestring
    e.g. “submitted to ELSTER on …, transfer ticket …”
    max. 500 characters · Default: ""

Response 201 · TaxReport

  • idstringrequired
  • kind"ustva" | "euer"required
  • yearintegerrequired
    -9007199254740991–9007199254740991
  • periodenum | nullrequired
    Values: M01, M02, M03, M04, M05, M06, M07, M08, M09, M10, M11, M12, Q1, Q2, Q3, Q4, Y
  • labelstringrequired
  • fromstring (date)required
    Date (YYYY-MM-DD)
  • tostring (date)required
    Date (YYYY-MM-DD)
  • basis"cash" | "accrual"required
  • linesArray<object>required
    • kzstringrequired
    • labelstringrequired
    • baseCentsinteger | nullrequired
      Amount in cents
      -100000000000–100000000000
    • taxCentsinteger | nullrequired
      Amount in cents
      -100000000000–100000000000
  • resultCentsintegerrequired
    Advance VAT return: box 83, EÜR: profit/loss
    -100000000000–100000000000
  • notestringrequired
  • contentHashstringrequired
  • createdByActorrequired
    • type"user" | "api_key" | "oauth" | "system"required
    • idstringrequired
    • labelstring
  • createdAtstring (date-time)required
    Timestamp (ISO 8601)

Possible errors: 400, 401, 403, 409, 422, 429, 500

curl -X POST 'https://www.debt-flow.io/api/v1/tax-reports' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "kind": "ustva",
  "year": 2000,
  "period": "M01",
  "note": ""
}'
Response 201
{
  "id": "string",
  "kind": "ustva",
  "year": 0,
  "period": "M01",
  "label": "string",
  "from": "2026-11-01",
  "to": "2026-11-01",
  "basis": "cash",
  "lines": [
    {
      "kz": "string",
      "label": "string",
      "baseCents": 0,
      "taxCents": 0
    }
  ],
  "resultCents": 0,
  "note": "string",
  "contentHash": "string",
  "createdBy": {
    "type": "user",
    "id": "string",
    "label": "string"
  },
  "createdAt": "2026-11-01T09:30:00.000Z"
}
GET/api/v1/tax-reports/{id}

Permission: reports:read

Path parameters

  • idstringrequired
    Resource ID
    max. 128 characters

Response 200 · TaxReport

  • idstringrequired
  • kind"ustva" | "euer"required
  • yearintegerrequired
    -9007199254740991–9007199254740991
  • periodenum | nullrequired
    Values: M01, M02, M03, M04, M05, M06, M07, M08, M09, M10, M11, M12, Q1, Q2, Q3, Q4, Y
  • labelstringrequired
  • fromstring (date)required
    Date (YYYY-MM-DD)
  • tostring (date)required
    Date (YYYY-MM-DD)
  • basis"cash" | "accrual"required
  • linesArray<object>required
    • kzstringrequired
    • labelstringrequired
    • baseCentsinteger | nullrequired
      Amount in cents
      -100000000000–100000000000
    • taxCentsinteger | nullrequired
      Amount in cents
      -100000000000–100000000000
  • resultCentsintegerrequired
    Advance VAT return: box 83, EÜR: profit/loss
    -100000000000–100000000000
  • notestringrequired
  • contentHashstringrequired
  • createdByActorrequired
    • type"user" | "api_key" | "oauth" | "system"required
    • idstringrequired
    • labelstring
  • createdAtstring (date-time)required
    Timestamp (ISO 8601)

Possible errors: 400, 401, 403, 404, 429, 500

curl 'https://www.debt-flow.io/api/v1/tax-reports/ID' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"
Response 200
{
  "id": "string",
  "kind": "ustva",
  "year": 0,
  "period": "M01",
  "label": "string",
  "from": "2026-11-01",
  "to": "2026-11-01",
  "basis": "cash",
  "lines": [
    {
      "kz": "string",
      "label": "string",
      "baseCents": 0,
      "taxCents": 0
    }
  ],
  "resultCents": 0,
  "note": "string",
  "contentHash": "string",
  "createdBy": {
    "type": "user",
    "id": "string",
    "label": "string"
  },
  "createdAt": "2026-11-01T09:30:00.000Z"
}
GET/api/v1/tax-reports/{id}/pdf

Permission: reports:read

Path parameters

  • idstringrequired
    Resource ID
    max. 128 characters

Response 200

File (application/pdf).

Possible errors: 400, 401, 403, 404, 429, 500

curl 'https://www.debt-flow.io/api/v1/tax-reports/ID/pdf' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"