SalesInvoiceRow
One line on a sales invoice: a label, a quantity, a unit price and a VAT percentage.
- Summary view
- SalesInvoiceRowList, 24 fields. What a list returns by default.
- Detail view
- SalesInvoiceRow, 24 fields. The default for a single read and for every write.
- Read with
- api:
read: andsales_invoices::sales_invoices read - Write with
- api:
write: andsales_invoices::sales_invoices create
An invoice's subtotal, VAT total and total are computed from nothing but its rows, and a row that settles budget hours also records the minutes it covers.
Used by
Fields
- Detail only
- Only in the detail view.
- Only with include
- Only when you ask for it with include.
- Server-assigned
- Set by plnnrly, never by a request.
The invoice this line belongs to. Taken from the path on create and never writable afterwards: a line cannot be moved to another invoice.
The invoice this line belongs to.
Subscription line this invoice line was generated from, when the row came out of a subscription renewal rather than being typed by hand.
Project budget this invoice line settles, when the row was generated from budget hours.
Exact Online article identifier this line bills against. Empty is accepted, but a row without it fails the whole invoice's Exact sync.
The line label, as printed on the invoice. Exact Online prints this when description is empty.
Number of units billed. Fractional and signed: a budget row carries hours, and a credit line carries a negative quantity.
2 decimal places, may be negative
Price per unit, excluding VAT. This is what actually bills.
2 decimal places, may be negative
Rate plnnrly recomputes unit_price from when the aggregated-price toggle is switched on a budget row. Stored exactly as sent and null when omitted; it feeds no server-side computation.
2 decimal places, may be negative
True: one line of quantity 1 priced at hours times rate. False: quantity carries the hours and unit_price the hourly rate.
VAT on this line: quantity times unit_price times vat_rate, rounded to two decimals. Recomputed by the server whenever one of those three changes.
2 decimal places, may be negative
Line total excluding VAT (quantity times unit_price), which is the convention the invoice form writes. Recomputed by the server whenever quantity or unit_price changes.
2 decimal places, may be negative
Position of the line within its invoice, and the default sort key. Assigned on create; there is no way to reorder lines through the API.
Variants
SalesInvoiceRowList 24 fields
What a collection returns, and what ?view=summary returns on a single record.
The same fields as the detail object.
SalesInvoiceRowSummary 3 fields
The embedded form: what you get when another resource carries this one and you did not include it.
Leaves out: sales_invoice_id, sales_invoice, subscription_item_id, budget_id, exact_item_id, exact_vat_code, exact_cost_center, exact_gl_account, description, quantity, unit_price, hourly_rate, billable_minutes, is_aggregated_price, vat_rate, vat_amount, sort_order, created_at, updated_at, deleted_at, links
SalesInvoiceRowLinks 1 field
The links object on this resource.
Keys: self
Something wrong or missing on this page? Tell us