Invoices

Purchase invoices (received from suppliers and subcontractors, paid by the tenant; contractor module) and sales invoices (issued to customers; subcontractor module), numbered in sequence per direction. Lines are part of the invoice; totals, VAT applicability and a purchase invoice's CIS deduction are computed. Payments are a child of the invoice and drive its paid state; a purchase invoice's payments must fall in a tax month whose CIS return is not yet submitted. A monthly analysis serves charts. Webhooks: invoice.created, invoice.updated, invoice.deleted.

GET List purchase invoices
Lists the tenant's purchase invoices (received from a supplier or subcontractor), without lines. Filter by contact and by the year and month of dateFi...
/tenants/{tenant}/purchase-invoices
POST Create purchase invoice
Creates a purchase invoice for a contact. The number is allocated in sequence; whether VAT applies follows from the parties' VAT registration; totals ...
/tenants/{tenant}/purchase-invoices
GET PurchaseInvoice monthly analysis
Invoice counts and totals per month for the months ending in the given year and month (months = 12 for a year of chart data), by the date field, for e...
/tenants/{tenant}/purchase-invoices/monthly-analysis
GET PurchaseInvoice summary
The count, totals and earliest and latest invoice, due and paid dates of the tenant's purchase invoices, or of one contact's. A list filtered to a per...
/tenants/{tenant}/purchase-invoices/summary
GET Get purchase invoice
Returns the purchase invoice with its lines.
/tenants/{tenant}/purchase-invoices/{number}
PUT Update purchase invoice
Replaces the purchase invoice's editable fields and lines (a line with an existing code updates it, without a code adds one, a line left out is delete...
/tenants/{tenant}/purchase-invoices/{number}
DELETE Delete purchase invoice
Deletes the purchase invoice and its payments. Refused (400) when a payment falls in a tax month whose CIS return is submitted.
/tenants/{tenant}/purchase-invoices/{number}
GET List purchase invoice payments
The payments recorded against the purchase invoice, oldest first.
/tenants/{tenant}/purchase-invoices/{number}/payments
POST Create purchase invoice payment
Records a payment against the purchase invoice; the invoice's paid state follows. Refused (400) when the payments would exceed the amount payable, or ...
/tenants/{tenant}/purchase-invoices/{number}/payments
GET Get purchase invoice payment
Returns one payment of the purchase invoice.
/tenants/{tenant}/purchase-invoices/{number}/payments/{payment}
PUT Update purchase invoice payment
Replaces the payment's date and amount, under the same rules as creating one.
/tenants/{tenant}/purchase-invoices/{number}/payments/{payment}
DELETE Delete purchase invoice payment
Deletes the payment; the invoice's paid state follows. Refused (400) on a purchase invoice when the payment falls in a tax month whose CIS return is s...
/tenants/{tenant}/purchase-invoices/{number}/payments/{payment}
GET List purchase payments
Every payment of every purchase invoice dated from and to inclusive, oldest first, each with its invoice's number, dates and references, the contact, ...
/tenants/{tenant}/purchase-invoices/payments
GET List purchase payment dates
The dates from and to inclusive on which purchase invoices were paid, oldest first, each with how many invoices and contacts were paid, the total paid...
/tenants/{tenant}/purchase-invoices/payments/dates
GET List purchase invoice emails
The emails sent of the purchase invoice, newest first, with their delivery status.
/tenants/{tenant}/purchase-invoices/{number}/emails
POST Send purchase invoice email
Queues an email of the purchase invoice (from the tenant's invoice email template), to the given recipient or the contact's own email address, optiona...
/tenants/{tenant}/purchase-invoices/{number}/emails
GET Get Timesheet Template
The timesheet CSV template: the header row plus one row per CIS subcontractor with their code, name, default hourly rate, one hour, default VAT rate (...
/tenants/{tenant}/purchase-invoices/timesheets/template
POST Analyze Timesheets
Validates a filled-in timesheet CSV (multipart/form-data, field 'file'; header names are matched case-insensitively and missing columns are allowed) w...
/tenants/{tenant}/purchase-invoices/timesheets/analyze
POST Import Timesheets
Imports the selected rows of a timesheet CSV (multipart/form-data: the file as 'file' and 'selections', a JSON array of { rowId } from the analysis). ...
/tenants/{tenant}/purchase-invoices/timesheets
GET List sales invoices
Lists the tenant's sales invoices (issued to a customer), without lines. Filter by contact and by the year and month of dateField (Date, the invoice d...
/tenants/{tenant}/sales-invoices
POST Create sales invoice
Creates a sales invoice for a contact. The number is allocated in sequence; whether VAT applies follows from the parties' VAT registration; totals and...
/tenants/{tenant}/sales-invoices
GET SalesInvoice monthly analysis
Invoice counts and totals per month for the months ending in the given year and month (months = 12 for a year of chart data), by the date field, for e...
/tenants/{tenant}/sales-invoices/monthly-analysis
GET SalesInvoice summary
The count, totals and earliest and latest invoice, due and paid dates of the tenant's sales invoices, or of one contact's. A list filtered to a period...
/tenants/{tenant}/sales-invoices/summary
GET Get sales invoice
Returns the sales invoice with its lines.
/tenants/{tenant}/sales-invoices/{number}
PUT Update sales invoice
Replaces the sales invoice's editable fields and lines (a line with an existing code updates it, without a code adds one, a line left out is deleted)....
/tenants/{tenant}/sales-invoices/{number}
DELETE Delete sales invoice
Deletes the sales invoice and its payments. Refused (400) when a payment falls in a tax month whose CIS return is submitted.
/tenants/{tenant}/sales-invoices/{number}
GET List sales invoice payments
The payments recorded against the sales invoice, oldest first.
/tenants/{tenant}/sales-invoices/{number}/payments
POST Create sales invoice payment
Records a payment against the sales invoice; the invoice's paid state follows. Refused (400) when the payments would exceed the amount payable, or (pu...
/tenants/{tenant}/sales-invoices/{number}/payments
GET Get sales invoice payment
Returns one payment of the sales invoice.
/tenants/{tenant}/sales-invoices/{number}/payments/{payment}
PUT Update sales invoice payment
Replaces the payment's date and amount, under the same rules as creating one.
/tenants/{tenant}/sales-invoices/{number}/payments/{payment}
DELETE Delete sales invoice payment
Deletes the payment; the invoice's paid state follows. Refused (400) on a purchase invoice when the payment falls in a tax month whose CIS return is s...
/tenants/{tenant}/sales-invoices/{number}/payments/{payment}
GET List sales payments
Every payment of every sales invoice dated from and to inclusive, oldest first, each with its invoice's number, dates and references, the contact, the...
/tenants/{tenant}/sales-invoices/payments
GET List sales payment dates
The dates from and to inclusive on which sales invoices were paid, oldest first, each with how many invoices and contacts were paid, the total paid an...
/tenants/{tenant}/sales-invoices/payments/dates
GET List sales invoice emails
The emails sent of the sales invoice, newest first, with their delivery status.
/tenants/{tenant}/sales-invoices/{number}/emails
POST Send sales invoice email
Queues an email of the sales invoice (from the tenant's invoice email template), to the given recipient or the contact's own email address, optionally...
/tenants/{tenant}/sales-invoices/{number}/emails