Invoice Object

The Invoice object represents a billing document in the Tupel system. Invoices formalize financial transactions and can be standard invoices or credit notes.

Attributes

• uid string
  Unique identifier for the invoice.

• entity object
  The Entity object representing the organization associated with this invoice.

• type string
  The type of invoice. Possible values: INVOICE, CREDIT_NOTE.

• status string
  Current status of the invoice. Possible values: ISSUED, PAID, OVERDUE.

• currency string
  Three-letter ISO currency code of the invoice which can be any of the accepted currency codes. Maximum length: 3 characters. Example: USD.

• payment_method object
  The Payment Method object representing how payments for this invoice should be processed.

• attachments array of objects
  List of Attachment objects with supporting documentation for this invoice.

• issued_at nullable timestamp
  Time at which the invoice was issued. Can be null if not yet issued.

• due_at timestamp
  Time at which the invoice payment is due.

• number nullable string
  The invoice number. Maximum length: 20 characters.

• subtotal decimal
  The subtotal amount of the invoice before tax and discounts.

• tax decimal
  The tax amount applied to the invoice.

• discount decimal
  Any discount amount applied to the invoice. Default: 0.00.

• total decimal
  The total amount of the invoice.

• paid decimal
  The amount that has been paid against this invoice. Default: 0.00.

• balance decimal
  The remaining amount to be paid on the invoice.

• created_at timestamp
  Time at which the invoice was created in the system.

• updated_at timestamp
  Time at which the invoice was last updated.

Invoice Types

Invoices can be categorized as:

• INVOICE - Standard invoice for amounts owed to your organization
• 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 without full payment

Invoice Calculations

The relationship between the key financial fields in an invoice is:

• total = subtotal + tax - discount
• balance = total - paid

As payments are made against an invoice, the paid amount increases and the balance decreases. When the invoice is fully paid, its status changes to PAID.

Supporting Documentation

Invoices can have associated attachments, which may include:

• INVOICE - The formal invoice document
• RECEIPT - Receipt for payments
• REMITTANCE - Remittance advice
• CONTRACT - Associated contract documentation

Invoice Operations

The API provides several endpoints for managing invoices:

• Get a Specific Invoice - Retrieve a single invoice by its UID
• List All Invoices - Retrieve a paginated list of invoices with filtering options

For detailed information about these operations, refer to the Invoices documentation.