Skip Navigation
Log In Sign Up

Retrieve an Invoice

·

Retrieve detailed information about a specific invoice by its unique identifier.

Request

GET https://tupel.com/api/invoices/{uid}/

Authentication

This endpoint requires basic authentication with your Organization ID and API Key.

Path Parameters

  • uid string Required
    The unique identifier of the invoice to retrieve.

Notes

  • This endpoint returns all details for a specific invoice, including the associated entity, payment method, and attachment information.
  • The invoice must belong to your organization to be accessible.
  • The response includes payment status tracking, with the paid field showing the amount that has been paid and the balance field showing the remaining amount due.
  • The status field indicates whether the invoice is ISSUED, PAID, or OVERDUE.
  • For invoices with type CREDIT_NOTE, the amounts may represent reversals or credits.
  • Any attachments related to the invoice, such as PDF documents or receipts, are included in the attachments array.
  • The payment_method field indicates how the invoice should be paid.

Example Request

curl -X GET https://tupel.com/api/invoices/inv_5hN3mP7/ \
  -u <YOUR_ORG_ID>:<YOUR_API_KEY>

Response

A successful request returns a 200 OK status code and a complete Invoice in the response body.

Error Responses

Code Description
401 Unauthorized - Authentication failed. Check your Organization ID and API Key.
403 Forbidden - Insufficient permissions to access the specified invoice.
404 Not Found - The specified invoice could not be found.

Example Error Response

{
  "detail": [
    {
      "type": "not_found",
      "loc": ["path", "uid"],
      "msg": "Invoice with id inv_5hN3mP7 not found."
    }
  ]
}