Skip to main content
GET
/
v1
/
recurring-invoices
List recurring invoices
curl --request GET \
  --url https://app.blinksale.test/api/v1/recurring-invoices \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Resources retrieved successfully",
  "data": [
    {
      "id": "01jtbf0c9zaraqx3swthf88n5y",
      "organization_id": "01jtbf0c9zaraqx3swthf88n5y",
      "client_id": "01jtbf0c9zaraqx3swthf88n5y",
      "name": "Monthly Hosting",
      "frequency": "MONTHLY",
      "frequency_name": "Monthly",
      "status": "ACTIVE",
      "status_name": "Active",
      "start_date": "2023-06-01",
      "end_date": null,
      "max_occurrences": null,
      "occurrences": 3,
      "last_generated_date": "2023-08-01",
      "next_date": "2023-09-01",
      "client": {
        "id": "01jtbf0c9zaraqx3swthf88n5y",
        "name": "Acme Inc",
        "email": "[email protected]",
        "kind": "BUSINESS",
        "kind_name": "Business",
        "profile": {
          "company_name": "Acme Inc",
          "website": "https://acme.com"
        },
        "address": {
          "line1": "123 Main St",
          "line2": "Suite 101",
          "city": "San Francisco",
          "state": "CA",
          "zip": "94107",
          "country": "US"
        },
        "document_defaults": {
          "currency": "USD"
        },
        "contact_count": 3,
        "note_count": 2,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "template": {
        "id": "01jtbf0c9zaraqx3swthf88n5y",
        "currency": "USD",
        "tax_id": "01jtbf0c9zaraqx3swthf88n5y",
        "tax_name": "Sales Tax",
        "tax_percent": 8.5,
        "tax_distribution": "PER_DOCUMENT",
        "discount_type": "PERCENTAGE",
        "discount_value": 10,
        "discount_distribution": "PER_DOCUMENT",
        "net_terms": "NET30",
        "has_late_fee": true,
        "late_fee_kind": "PERCENTAGE",
        "late_fee_interval": "ONE_TIME",
        "late_fee": 5,
        "shipping": 15,
        "notes": "Monthly hosting services.",
        "options": {},
        "items": [
          {
            "id": "01jtbf0c9zaraqx3swthf88n5y",
            "organization_id": "01jtbf0c9zaraqx3swthf88n5y",
            "name": "Consulting Services",
            "description": "Professional consulting services",
            "quantity": 10,
            "price": 150,
            "unit_of_measurement_id": "01jtbf0c9zaraqx3swthf88n5y",
            "unit_name": "Hour",
            "tax_id": "01jtbf0c9zaraqx3swthf88n5y",
            "tax_name": "Sales Tax",
            "tax_percent": 8.5,
            "discount_type": "PERCENTAGE",
            "discount_value": 10,
            "subtotal": 1500,
            "tax_amount": 127.5,
            "total": 1627.5
          }
        ]
      },
      "is_due_for_generation": false,
      "can_generate_invoices": true,
      "is_editable": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "path": "<string>",
    "per_page": 15,
    "to": 15,
    "total": 75
  }
}

Authorizations

Authorization
string
header
required

Access token obtained from the /v1/auth/login endpoint

Query Parameters

per_page
integer
default:15

Number of records per page

Search term to filter recurring invoices

client_id
string<uuid>

Filter by client ID

Response

Recurring invoices retrieved successfully

success
boolean
required
Example:

true

message
string
required
Example:

"Resources retrieved successfully"

data
object[]
required
meta
object