Array of Invoice Line items containing metadata associated with the invoice (see example API response below).
status
string
Current state of an invoice, one of:
open - Invoice is no longer a draft. It has been processed and/or sent to the customer. In this state, it will impact the ledger. It also has no payments made against it (amountDue == totalAmount). partially_paid - The balance paid against the invoice is positive, but less than the total invoice amount (0 < amountDue < totalAmount). paid - Invoice is paid in full. This includes if the invoice has been credited or overpaid. (amountDue == 0). void - An invoice can become void by being deleted, refunded, written off, or cancelled. A voided invoice may still be partially paid and so all outstanding amounts on voided invoices are removed from the accounts receivable account. draft - Invoice is yet to be authorized and sent to the customer, and will not be used in any reports. It may contain incomplete line items. unknown - Unable to recognize the status of the invoice. This can be due to missing values in the accounting service provider or unavailable in the data we received.
total_discount
number
Total value of discounts applied to the invoice.
sub_total
number
Total amount of the invoice excluding any taxes.
tax_amount
number
Total tax amount on the invoice.
total_amount
number
Total amount of the invoice.
amount_due
number
Outstanding amount to be paid for the invoice.
memo
string
Overall description for the invoice.
payments
object[]
Array of payments associated with the invoice.
Invoice Line Item
Field
Type
Description
id
string
A Rutter designated ID for this invoice line item. It always will be in UUID format.
description
string
Contains the description of the product/service for this invoice line item, usually the name.
unit_amount
number
Price per quantity for this invoice line item.
quantity
number
The quantity of the product/service for this invoice line item.
discount_amount
number
The amount discounted for this invoice line item.
sub_total
number
Total amount for this invoice line item, excluding any taxes.
tax_amount
number
The amount taxed for this invoice line item.
amount
number
The total amount for this invoice line item.
discount_percentage
number
The percentage discounted for this invoice line item.
tax_rate_id
string
The id of the tax rate.
item_id
string
Platform ID of the product/service for this invoice line item.
account_id
string
Platform ID of the account that this invoice line item impacts.
