Skip to main content

invoices/items/new/clientinvoice

This API is work in progress

To create a new client invoice.

URL

CODE
(POST) /api/invoices/items/new/clientinvoice

PARAMETERS

The request BODY contains a JSON payload with the new invoice’s properties:

projectId

The project to which to attach the new invoice.

int, Mandatory

orderId

Optional. The order to which to attach the invoice. The order must belong to the project.

int?, Optional

properties

The invoice properties you may specify are described in Invoice Properties Record, refer to section “INSERTING”

object, Mandatory

lines

An array if invoice lines. You must submit at least 1 line.

See Invoice Line Record and make sure to read the notes on Inserting and Updating lines.

object[], Mandatory

distribution

This is optional. It will be populated with the presets configured in the client record by default (which usually is what is wanted).

If you want to customize this section, submit this object: Invoice Distribution Record

object?, Optional

RESULTS

The result is the new invoice document.

See Invoice Document Record for details.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.