Skip to main content
GET
/
v1
/
invoices
/
{type}
/
{invoice_id}
curl --request GET \
  --url https://api.paypulse.io/v1/invoices/rental/inv_abc123 \
  --header 'Authorization: Bearer <token>'

{
  "message": "Invoice details retrieved successfully!",
  "code": 200,
  "data": {
    "InvoiceID": "inv_abc123",
    "UserID": "user_xyz789",
    "due_date_month": "3",
    "due_date_year": "2025"
  }
}

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/azfar-imtiaz/PayPulse-Cloud/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint is not currently used in the PayPulse app. It is available for direct API access and future use.

​
Authentication

All requests to this endpoint must include a valid JWT in the Authorization header. 
Authorization: Bearer <token>

​
Path parameters

​
type
string
required
The invoice type. Must be rental for this endpoint.
​
invoice_id
string
required
The unique identifier of the rental invoice to retrieve.

​
Response

​
message
string
A human-readable confirmation message. Example: "Invoice details retrieved successfully!"
​
code
number
HTTP status code. 200 on success, 204 when the invoice does not exist.
​
data
object | null
The full invoice item as stored in DynamoDB. null when status is 204. Fields present depend on what was parsed from the invoice PDF. Common fields include:

​
Error responses

StatusError codeDescription
204—No invoice found for the given invoice_id and authenticated user. Body is empty.
400MISSING_FIELDSThe type or invoice_id path parameter is absent.
401INVALID_CREDENTIALSThe Authorization header is missing or the token is invalid.
401TOKEN_EXPIREDThe JWT has expired.
502DEPENDENCY_FAILUREA downstream dependency (DynamoDB) returned an error.
500INTERNAL_SERVER_ERRORAn unexpected server-side error occurred.
Error responses follow this structure: 
{
  "error": {
    "code": "MISSING_FIELDS",
    "message": "Missing fields in URL"
  }
}

curl --request GET \
  --url https://api.paypulse.io/v1/invoices/rental/inv_abc123 \
  --header 'Authorization: Bearer <token>'

{
  "message": "Invoice details retrieved successfully!",
  "code": 200,
  "data": {
    "InvoiceID": "inv_abc123",
    "UserID": "user_xyz789",
    "due_date_month": "3",
    "due_date_year": "2025"
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us