Get rental invoice

Retrieve the details of a specific rental invoice by ID.

GET /v1/invoices/{type}/{invoice_id}

cURL

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

200

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

{
  "error": {
    "code": "TOKEN_EXPIRED",
    "message": "Expired token."
  }
}

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:

Hide properties

InvoiceID · string

Unique identifier for the invoice.

UserID · string

The ID of the user who owns this invoice.

due_date_month · string

The month portion of the invoice due date.

due_date_year · string

The year portion of the invoice due date.

Error responses

Status	Error code	Description
204	—	No invoice found for the given invoice_id and authenticated user. Body is empty.
400	MISSING_FIELDS	The type or invoice_id path parameter is absent.
401	INVALID_CREDENTIALS	The Authorization header is missing or the token is invalid.
401	TOKEN_EXPIRED	The JWT has expired.
502	DEPENDENCY_FAILURE	A downstream dependency (DynamoDB) returned an error.
500	INTERNAL_SERVER_ERROR	An unexpected server-side error occurred.

Error responses follow this structure:

{
  "error": {
    "code": "MISSING_FIELDS",
    "message": "Missing fields in URL"
  }
}

cURL

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

200

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

{
  "error": {
    "code": "TOKEN_EXPIRED",
    "message": "Expired token."
  }
}