Skip Navigation
Log In Sign Up

Invoices

·

The Invoices API allows you to manage billing documents within the Tupel platform. Invoices represent formal financial records of transactions, including both standard invoices and credit notes.

What is an Invoice?

In Tupel, an invoice represents a formalized financial document associated with an entity. Each invoice includes:

  • The invoice type (standard invoice or credit note)
  • Financial details (subtotal, tax, discount, total)
  • Payment status tracking
  • Associated payment method
  • Supporting documentation

Invoice Types

Tupel supports the following invoice directions:

  • INVOICE - Standard invoice for amounts owed
  • CREDIT_NOTE - Credit note for refunds or adjustments

Invoice Status

Invoices can have the following statuses:

  • ISSUED - The invoice has been created and sent
  • PAID - The invoice has been fully paid
  • OVERDUE - The invoice is past its due date

Available Endpoints

Endpoint Description
Retrieve an Invoice Get details about a specific invoice
List All Invoices Get a paginated list of invoices with filtering options

Best Practices

  • Regularly monitor invoice statuses to track payment compliance
  • Use appropriate filtering when listing invoices to improve performance
  • Store the invoice UID in your system for future reference
  • For reconciliation, combine date filters with status and entity filters
  • Consider using webhooks to receive real-time notifications of invoice status changes
  • Loans - Invoices may be associated with loans
  • Entities - Organizations related to invoices
  • Payment Methods - Methods used for invoice payments
  • Attachments - Supporting documentation for invoices

Common Use Cases

Tracking Unpaid Invoices

# List all overdue invoices
curl -X GET "https://tupel.com/api/invoices/?status=OVERDUE" \
  -u <YOUR_ORG_ID>:<YOUR_API_KEY>

Invoice Reconciliation

Generate filtered lists of invoices for reconciliation:

# Get all invoices for a date range
curl -X GET "https://tupel.com/api/invoices/?created_from=2023-01-01T00:00:00Z&created_to=2023-01-31T23:59:59Z" \
  -u <YOUR_ORG_ID>:<YOUR_API_KEY>

Entity-Specific Invoices

Review all invoices for a specific entity:

# Get all invoices for a specific entity
curl -X GET "https://tupel.com/api/invoices/?entity=7aB9cD" \
  -u <YOUR_ORG_ID>:<YOUR_API_KEY>