GuidesDiscussions
API Reference
Start typing to search…

Detailed Invoice object

Properties of the Detailed Invoice and nested objects

Overview

The Detailed Invoice object is returned by some endpoints in this section and contains all the invoice properties.

Some properties contain nested objects that are described below.

📘

To learn about invoices on the Inspire Payment Platform, read About Invoices.

Detailed Invoice Object

  • id (String): Invoice ID.
  • getInvoiceNumber (String): Invoice number.
  • dueDate (String): Due date.
  • paidDate (String): Date and time the invoice was paid.
  • paymentId (String): Payment ID.
  • paymentMethodId (String): Payment method ID.
  • paymentMethodName (String): Payment method name.
  • subscriptionId (String): Subscription ID.
  • coupons (Array): Coupons added to the invoice.
  • subscriptions: (Object) Subscription.
  • getCurrency: (Object) An object describing the currency of the invoice.
  • amountDue (Number): Amount due on the invoice.
  • amountSubtotal (String): Invoice subtotal.
  • discountAmount (Number): Discount amount.
  • amountPaid (Number): Amount already paid.
  • amountRemaining (Number): Amount remaining unpaid on the invoice.
  • invoiceStatus (String): Invoice status.
  • invoiceItems: (Array) An array of invoice items with product descriptions.
  • createdDate (String): Date and time this invoice was created.
  • customer: (Object) Object describing the customer.
  • metadata (Array): Custom properties of the invoice stored as key-value pairs.
  • memo (String): Memo.
  • footer (String): Invoice footer text.
  • transactions (Array): Array of Invoce Transaction objects associated with this invoice.
  • linkUrl (String): The URL of the invoice on the Inspire Platform.
  • confirmationDate (String): Confirmation date.
  • referenceDate (String): Reference date.
  • referenceDatePeriod: (Object) Object containing to date-time strings:
    • referenceDateFrom: The start of the reference period.
    • referenceDateTo: The end of the reference period.
  • installments (Number): Number of installments.

Invoice Item Object with Product Description

  • id (String): Invoice item ID.
  • quantity (Number): Quantity.
  • productPricesId (String): Product price ID.
  • maxInstallments (Number): The maximum number of installments.
  • product: (Object) An object describing the product:
    • id (String): Product ID
    • name (String): Product name
    • description (String): Product description
    • statementDescriptor: Transaction description that will on a bank statement
    • unitLabel (String): Unit label
    • isActive (Boolean): If True, the product is active.
    • setupFee (Number): An optional fee for the set-up of the product
    • metadata (Object): Any custom properties of the product stored as key-value pairs
    • createdDate (DateTime): Date the product record was created
    • updatedDate (DateTime): Date the product record was last updated
  • coupons (Array): The array of coupons that were used, if any.
  • billingPeriods: (Object) The billing period for this item.
  • discountAmount (Number): Discount amount.
  • aount (Number): The ammount for this invoice item.
  • unitPrice (Number): Unit price.

Invoice Transaction Object

  • id (String): Transaction ID.
  • amount (Number): Transaction amount.
  • createdDate (String): Date and time the transaction was created.
  • status (String): Transaction status.