Skip to content
Stella ConnectDocs
Invoice

Send a draft invoice

POST{baseUrl}/v1.0/invoice/send-draft

Create a draft invoice. Draft invoices are not automatically sent to the recipient, a user needs to subsequently open the Stella Invoice app, review the draft, and explicitly send it.

Authx-api-key

application/json
Field
Type
Required
toobjectYes
to.emailAddressstringYes
to.businessNamestringYes
dueDatedate-time | nullNo
subtotalnumberYes
taxAmountnumberYes
shippingFeenumber | nullNo
totalnumberYes
lineItems[]object[]Yes
lineItems[].descriptionstringYes
lineItems[].quantityintegerYes
lineItems[].unitPricenumberYes
lineItems[].itemTotalnumberYes
notesstring | nullNo
paymentTermsstring | nullNo
externalIdstring | nullNo
externalIdLinkstring | nullNo

Status
When
200

Success

400

Bad Request

401

Unauthorized

500

An unexpected error occurred on the server.

Field
Type
Required
Description
dataobject | nullNo
data.invoiceIdstringNo

Unique identifier for the invoice that was sent

data.statusstringNo

Status of the invoice after sending (e.g., "sent")

errors[]object[] | nullNo

One or more errors describing why the request failed. Absent (null) on success.

errors[].descriptionstring | nullNo

Human-readable explanation of the error. Intended for display to end users or logs. Wording is not stable and should not be branched on.

errors[].errorIdstring | nullNo

Machine-readable, stable error identifier. Consumers should branch on this value rather than on Description. See ConnectErrorIds for the catalog.

pagingobject | nullNo

Paging metadata for list endpoints. Absent on single-item responses.

paging.limitintegerNo
paging.startintegerNo
paging.totalintegerNo

Example 200 response
{
  "data": {
    "invoiceId": "string",
    "status": "string"
  },
  "errors": [
    {
      "description": "string",
      "errorId": "string"
    }
  ],
  "paging": {
    "limit": 0,
    "start": 0,
    "total": 0
  }
}