Articles – API reference

List articles (products and services)

GET/api/v1/articles

Alphabetical by name.

Permission: articles:read

Query parameters

archived"true" | "false"
true = archived only, false = active only (default: all)
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<Article>required
- idstringrequired
  max. 128 characters
- object"article"required
- numberstring | nullrequired
- titlestringrequired
- descriptionstring | nullrequired
- unitstring | nullrequired
- unitPriceCentsintegerrequired
  Amount in cents
  -100000000000–100000000000
- priceMode"net" | "gross"required
- taxRatenumberrequired
- archivedbooleanrequired
- createdAtstring (date-time)required
  Timestamp (ISO 8601)
- updatedAtstring (date-time)required
  Timestamp (ISO 8601)
hasMorebooleanrequired
nextCursorstring | nullrequired

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

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

Response 200

{
  "object": "list",
  "data": [
    {
      "id": "string",
      "object": "article",
      "number": "string",
      "title": "string",
      "description": "string",
      "unit": "string",
      "unitPriceCents": 0,
      "priceMode": "net",
      "taxRate": 0,
      "archived": false,
      "createdAt": "2026-11-01T09:30:00.000Z",
      "updatedAt": "2026-11-01T09:30:00.000Z"
    }
  ],
  "hasMore": false,
  "nextCursor": "string"
}

Create article

POST/api/v1/articles

Permission: articles: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) · ArticleCreate

numberstring
Article number (free-form)
max. 40 characters
titlestringrequired
max. 300 characters
descriptionstring
max. 5000 characters
unitstring
max. 20 characters
unitPriceCentsinteger
Amount in cents
-100000000000–100000000000 · Default: 0
priceMode"net" | "gross"
Default: "net"
taxRatenumber
Tax rate in per cent (19, 7, 0 …)
0–100 · Default: 19
archivedboolean

Response 201 · Article

idstringrequired
max. 128 characters
object"article"required
numberstring | nullrequired
titlestringrequired
descriptionstring | nullrequired
unitstring | nullrequired
unitPriceCentsintegerrequired
Amount in cents
-100000000000–100000000000
priceMode"net" | "gross"required
taxRatenumberrequired
archivedbooleanrequired
createdAtstring (date-time)required
Timestamp (ISO 8601)
updatedAtstring (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/articles' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "number": "string",
  "title": "string",
  "description": "string",
  "unit": "string",
  "unitPriceCents": 0,
  "priceMode": "net",
  "taxRate": 19,
  "archived": false
}'

Response 201

{
  "id": "string",
  "object": "article",
  "number": "string",
  "title": "string",
  "description": "string",
  "unit": "string",
  "unitPriceCents": 0,
  "priceMode": "net",
  "taxRate": 0,
  "archived": false,
  "createdAt": "2026-11-01T09:30:00.000Z",
  "updatedAt": "2026-11-01T09:30:00.000Z"
}

Retrieve article

GET/api/v1/articles/{id}

Permission: articles:read

Path parameters

idstringrequired
Resource ID
max. 128 characters

Response 200 · Article

idstringrequired
max. 128 characters
object"article"required
numberstring | nullrequired
titlestringrequired
descriptionstring | nullrequired
unitstring | nullrequired
unitPriceCentsintegerrequired
Amount in cents
-100000000000–100000000000
priceMode"net" | "gross"required
taxRatenumberrequired
archivedbooleanrequired
createdAtstring (date-time)required
Timestamp (ISO 8601)
updatedAtstring (date-time)required
Timestamp (ISO 8601)

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

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

Response 200

{
  "id": "string",
  "object": "article",
  "number": "string",
  "title": "string",
  "description": "string",
  "unit": "string",
  "unitPriceCents": 0,
  "priceMode": "net",
  "taxRate": 0,
  "archived": false,
  "createdAt": "2026-11-01T09:30:00.000Z",
  "updatedAt": "2026-11-01T09:30:00.000Z"
}

Update article

PATCH/api/v1/articles/{id}

Existing invoices and quotes keep their line items (copy).

Permission: articles:write

Path parameters

idstringrequired
Resource ID
max. 128 characters

Body (JSON) · ArticleUpdate

numberstring
Article number (free-form)
max. 40 characters
titlestring
max. 300 characters
descriptionstring
max. 5000 characters
unitstring
max. 20 characters
unitPriceCentsinteger
Amount in cents
-100000000000–100000000000
priceMode"net" | "gross"
taxRatenumber
Tax rate in per cent (19, 7, 0 …)
0–100
archivedboolean

Response 200 · Article

idstringrequired
max. 128 characters
object"article"required
numberstring | nullrequired
titlestringrequired
descriptionstring | nullrequired
unitstring | nullrequired
unitPriceCentsintegerrequired
Amount in cents
-100000000000–100000000000
priceMode"net" | "gross"required
taxRatenumberrequired
archivedbooleanrequired
createdAtstring (date-time)required
Timestamp (ISO 8601)
updatedAtstring (date-time)required
Timestamp (ISO 8601)

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

curl -X PATCH 'https://www.debt-flow.io/api/v1/articles/ID' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "number": "string",
  "title": "string",
  "description": "string",
  "unit": "string",
  "unitPriceCents": 0,
  "priceMode": "net",
  "taxRate": 0,
  "archived": false
}'

Response 200

{
  "id": "string",
  "object": "article",
  "number": "string",
  "title": "string",
  "description": "string",
  "unit": "string",
  "unitPriceCents": 0,
  "priceMode": "net",
  "taxRate": 0,
  "archived": false,
  "createdAt": "2026-11-01T09:30:00.000Z",
  "updatedAt": "2026-11-01T09:30:00.000Z"
}

Delete article

DELETE/api/v1/articles/{id}

Alternatively, set archived: true to just hide the article.

Permission: articles:write

Path parameters

idstringrequired
Resource ID
max. 128 characters

Response 204

Success, no content

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

curl -X DELETE 'https://www.debt-flow.io/api/v1/articles/ID' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"