Wolfeo Developers

# Financials

NOTE

The URI for the API endpoint is often the same for multiple endpoints, the difference being in HTTP methods.

# List Transactions

GET https://api.wolfeo.me/v1/transactions

Returns a paginated list of payment transactions for your account, ordered by most recent first.

# Example Request

curl --request GET "https://api.wolfeo.me/v1/transactions?period=last30days&per_page=25" \
  --header "Authorization: Bearer YOUR_API_KEY"

# Parameters

Parameter Type Description
period string Time range to filter by (see possible values below)
range string Custom date range — only used when period=between
page integer Page number (default: 1)
per_page integer Results per page — max 100 (default: 50)

# Possible values for period

Value Description
all All transactions ever
today Transactions created today
yesterday Transactions created yesterday
last7days Transactions created in the last 7 days
last30days Transactions created in the last 30 days
between Custom date range (requires range)

# Format for range

Pass two dates separated by to:

2023-06-01to2023-06-29

# Sample Return

{
    "success": true,
    "data": [
        {
            "id": 1,
            "id_transaction": "ch_1ABCxyz",
            "id_order": "ORD-001",
            "id_invoice": 12,
            "id_customer": 45,
            "status": "completed",
            "type": "one_time",
            "amount": 49.00,
            "currency": "EUR",
            "created_at": "2024-01-01T09:00:00.000000Z"
        }
    ],
    "meta": {
        "current_page": 1,
        "last_page": 4,
        "per_page": 50,
        "total": 172
    }
}

# Transaction statuses

Status Description
waiting Payment initiated, not yet processed
processing Payment is being processed
completed Payment succeeded
refunded Payment was refunded
cancelled Payment was cancelled
error Payment failed with an error

# Possible Errors

Code HTTP Description
INVALID_PERIOD 400 period value is unrecognised or between is missing a valid range

# List Invoices

GET https://api.wolfeo.me/v1/invoices

Returns a paginated list of invoices for your account, ordered by most recent first.

# Example Request

curl --request GET "https://api.wolfeo.me/v1/invoices?period=last30days" \
  --header "Authorization: Bearer YOUR_API_KEY"

# Parameters

Parameter Type Description
period string Time range to filter by (same values as above)
range string Custom date range — only used when period=between
page integer Page number (default: 1)
per_page integer Results per page — max 100 (default: 50)

# Sample Return

{
    "success": true,
    "data": [
        {
            "id": 12,
            "id_order": "ORD-001",
            "id_customer": 45,
            "prefix": "INV-",
            "number": "2400001",
            "amount": 49.00,
            "amount_incl_vat": 58.80,
            "currency": "EUR",
            "status": "paid",
            "type": "one_time",
            "created_at": "2024-01-01T09:00:00.000000Z",
            "filename": "/docs/7/INV-2400001.pdf"
        }
    ],
    "meta": {
        "current_page": 1,
        "last_page": 2,
        "per_page": 50,
        "total": 87
    }
}

# Invoice statuses

Status Description
payment_due Invoice issued, payment not yet received
paid Invoice fully paid
partially_paid Partial payment received

TIP

filename is the path to the PDF invoice file relative to your account's document store.

# Possible Errors

Code HTTP Description
INVALID_PERIOD 400 Invalid period or missing range

# List Credit Notes

GET https://api.wolfeo.me/v1/credit-notes

Returns a paginated list of credit notes for your account, ordered by most recent first.

# Example Request

curl --request GET "https://api.wolfeo.me/v1/credit-notes?period=last30days" \
  --header "Authorization: Bearer YOUR_API_KEY"

# Parameters

Parameter Type Description
period string Time range to filter by (same values as above)
range string Custom date range — only used when period=between
page integer Page number (default: 1)
per_page integer Results per page — max 100 (default: 50)

# Sample Return

{
    "success": true,
    "data": [
        {
            "id": 3,
            "id_order": "ORD-001",
            "id_customer": 45,
            "prefix": "CN",
            "number": "2400001",
            "amount": -49.00,
            "amount_incl_vat": -49.00,
            "currency": "EUR",
            "type": "one_time",
            "created_at": "2024-01-15T14:30:00.000000Z",
            "filename": "/docs/7/CN2400001.pdf"
        }
    ],
    "meta": {
        "current_page": 1,
        "last_page": 1,
        "per_page": 50,
        "total": 3
    }
}

TIP

amount and amount_incl_vat on credit notes are negative values representing the amount credited back to the customer.

# Possible Errors

Code HTTP Description
INVALID_PERIOD 400 Invalid period or missing range

# What's next

  • Contacts — manage contacts, tags, and sequences
  • Orders — retrieve revenue totals

← Webhooks Management →