Get overdue invoices grid
Returns a paginated, filterable, and sortable grid of invoices that are past their payment due date.
What are Overdue Invoices? The “Overdue” tab shows all invoices where the payment term has passed. These invoices are in status “New” or “Sent” and have a due date that is in the past. This view helps you monitor open receivables, send reminders, and manage payment deadlines.
What is returned:
- Invoice identification (ID, number)
- Project reference (projectId)
- Invoice type (Mixed, Subscription, TimeBased, ExpressQuotation, SingleProject, InterimPayment)
- Creation and sending dates (createdAt, sentAt)
- Payment due date (dueDate)
- Reminder dates (firstReminderAt, secondReminderAt)
- Number of days overdue (overdueDays)
- Net amount before taxes and fees (netto)
- Invoice status (New, Sent)
Filtering and search:
- Quick search across invoice number
- Filter by project, type, status, dates, amount, and overdue days
- Sort by any field (default: overdueDays descending)
Retrieves a paginated grid of overdue invoices with filtering and sorting capabilities. Quick search available on: number. Filterable fields: id, number, projectId, type, createdAt, sentAt, dueDate, firstReminderAt, secondReminderAt, netto, status, overdueDays. Sortable fields: id, number, projectId, type, createdAt, sentAt, dueDate, firstReminderAt, secondReminderAt, netto, status, overdueDays.
/billing/invoices/overdueAuthorizationOAuth2 access token · headerrequiredapi:readAuthorizationBearer token (JWT) · headerrequiredpagenumberPage number (1-based)
pageSizenumberNumber of items per page
viewIdstringView identifier for saved grid configurations
quickSearchstringQuick search text. Searches across: number
filtersstringJSON string containing filter configuration.
Available Fields:
- id (string): Invoice ID
- number (string): Invoice number
- projectId (string): Project ID
- type (set): Invoice type (Mixed, Subscription, TimeBased, ExpressQuotation, SingleProject, InterimPayment)
- createdAt (date): Invoice creation date
- sentAt (date): Date when invoice was sent
- dueDate (date): Payment due date
- firstReminderAt (date): Date when first reminder was sent
- secondReminderAt (date): Date when second reminder was sent
- netto (number): Net amount (before taxes and fees)
- status (set): Invoice status (New, Sent)
- overdueDays (number): Number of days overdue
Filter Structure:
[
{
"type": "string|number|date|set|boolean|array|task_status|task_type",
"fieldName": "field_name",
"value": {
"comparison": "comparison_type",
"value": "filter_value"
}
}
]
Group Filters (AND/OR Combinations):
[
{
"type": "group",
"fieldName": "group0.18807479823070028",
"value": {
"type": "or",
"filters": [
{
"type": "string",
"fieldName": "fileName",
"value": {
"comparison": "contain",
"value": "aa"
}
},
{
"type": "number",
"fieldName": "rowCount",
"value": {
"comparison": ">=",
"value": 33
}
}
]
}
}
]
Available Comparison Operators:
- id (string): Invoice ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
- number (string): Invoice number (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
- projectId (string): Project ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
- type (set): Invoice type (Mixed, Subscription, TimeBased, ExpressQuotation, SingleProject, InterimPayment) (set filter). Available comparisons: in, not_in, is_empty, is_not_empty
- createdAt (date): Invoice creation date (date filter). Available comparisons: equal, not_equal, >, <, >=, <=, between, lastMonth, thisMonth, is_empty, is_not_empty
- sentAt (date): Date when invoice was sent (date filter). Available comparisons: equal, not_equal, >, <, >=, <=, between, lastMonth, thisMonth, is_empty, is_not_empty
- dueDate (date): Payment due date (date filter). Available comparisons: equal, not_equal, >, <, >=, <=, between, lastMonth, thisMonth, is_empty, is_not_empty
- firstReminderAt (date): Date when first reminder was sent (date filter). Available comparisons: equal, not_equal, >, <, >=, <=, between, lastMonth, thisMonth, is_empty, is_not_empty
- secondReminderAt (date): Date when second reminder was sent (date filter). Available comparisons: equal, not_equal, >, <, >=, <=, between, lastMonth, thisMonth, is_empty, is_not_empty
- netto (number): Net amount (before taxes and fees) (number filter). Available comparisons: equal, not_equal, >, <, >=, <=, is_empty, is_not_empty
- status (set): Invoice status (New, Sent) (set filter). Available comparisons: in, not_in, is_empty, is_not_empty
- overdueDays (number): Number of days overdue (number filter). Available comparisons: equal, not_equal, >, <, >=, <=, is_empty, is_not_empty
Note: Use quickSearch parameter for simple text search instead of adding it to filters.
sortstringJSON array of sort objects.
Sortable Fields:
- id: Invoice ID
- number: Invoice number
- projectId: Project ID
- type: Invoice type (Mixed, Subscription, TimeBased, ExpressQuotation, SingleProject, InterimPayment)
- createdAt: Invoice creation date
- sentAt: Date when invoice was sent
- dueDate: Payment due date
- firstReminderAt: Date when first reminder was sent
- secondReminderAt: Date when second reminder was sent
- netto: Net amount (before taxes and fees)
- status: Invoice status (New, Sent)
- overdueDays: Number of days overdue
Sort Structure:
[
{
"field": "field_name",
"direction": "asc|desc"
}
]
Default Sort: overdueDays (desc)
fieldsToReturnstring[]Comma-separated list of field names to include in response items. If not provided, all fields are returned.
Available Fields: id, number, projectId, type, createdAt, sentAt, dueDate, firstReminderAt, secondReminderAt, netto, status, overdueDays
Successfully retrieved overdue invoices grid
Invalid query parameters
Unauthorized - Invalid or missing authentication token
Forbidden - Insufficient API scopes or permissions