Send a draft invoice
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.
x-api-keyapplication/jsonField | Type | Required |
|---|---|---|
| to | object | Yes |
| to. | string | Yes |
| to. | string | Yes |
| dueDate | date-time | null | No |
| subtotal | number | Yes |
| taxAmount | number | Yes |
| shippingFee | number | null | No |
| total | number | Yes |
| lineItems[] | object[] | Yes |
| lineItems[]. | string | Yes |
| lineItems[]. | integer | Yes |
| lineItems[]. | number | Yes |
| lineItems[]. | number | Yes |
| notes | string | null | No |
| paymentTerms | string | null | No |
| externalId | string | null | No |
| externalIdLink | string | null | No |
Status | When |
|---|---|
| 200 | Success |
| 400 | Bad Request |
| 401 | Unauthorized |
| 500 | An unexpected error occurred on the server. |
Field | Type | Required | Description |
|---|---|---|---|
| data | object | null | No | |
| data. | string | No | Unique identifier for the invoice that was sent |
| data. | string | No | Status of the invoice after sending (e.g., "sent") |
| errors[] | object[] | null | No | One or more errors describing why the request failed. Absent ( |
| errors[]. | string | null | No | 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[]. | string | null | No | Machine-readable, stable error identifier. Consumers should branch on this value
rather than on Description. See |
| paging | object | null | No | Paging metadata for list endpoints. Absent on single-item responses. |
| paging. | integer | No | |
| paging. | integer | No | |
| paging. | integer | No |
{
"data": {
"invoiceId": "string",
"status": "string"
},
"errors": [
{
"description": "string",
"errorId": "string"
}
],
"paging": {
"limit": 0,
"start": 0,
"total": 0
}
}