Get recurring template history

GET /api/v1/recurring/{template_id}/history

Get all bills or invoices generated from this recurring template.

Operation ID: get_recurring_template_history_api_v1_recurring__template_id__history_get · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

template_id string required

Query

limit integer default: 50: Maximum items to return

Responses

200 Successful Response

Schema: RecurringTemplateHistoryResponse

template_id string required

template_name string required

document_type RecurrenceTypeEnum-Output requiredRecurrenceTypeEnum-Output

total_generated integer required

items array · GeneratedDocumentItem requiredGeneratedDocumentItem

11 fields

id string required
document_type RecurrenceTypeEnum-Output requiredRecurrenceTypeEnum-Output
status string required
number string
description string
amount integer
amount_in_dollars number
due_date string · date
created_at string · date-time required
vendor_name string
customer_name string

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

GET /api/v1/recurring/{template_id}/history

bash

curl -X GET 'https://api.ondayzero.com/api/v1/recurring/{template_id}/history' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/recurring/{template_id}/history', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

response = httpx.get("https://api.ondayzero.com/api/v1/recurring/{template_id}/history", headers=headers)
data = response.json()