Sign in

v2

latestOpenAPI 3.0.02026-08-08112115411.4 KB
Invoices

Update the status of an invoice

Updates an invoice to a native Nutshell status (READY, SENT, REVOKED, ACCEPTED, ARCHIVED). ACCEPTED marks the invoice as paid. Optional comment is stored as payment/completion metadata.

post/invoices/{id}/status

Path parameters

idstring required

Invoice ID

Request body

status'READY' | 'SENT' | 'REVOKED' | 'ACCEPTED' | 'ARCHIVED' required
commentstring

Payment or completion note (invoices only, on ACCEPTED or REVOKED)

acceptedNamestring

Optional name recorded when marking the invoice paid

acceptedEmailstring

Optional email recorded when marking the invoice paid

Example request

{
  "status": "ACCEPTED",
  "comment": "Paid via ACH"
}

Response

Invoice

Example response

{
  "invoices": [
    {
      "id": "789-quotes",
      "type": "invoices",
      "number": "1000-01",
      "total": {
        "amount": "3200.50",
        "currency": "USD",
        "formatted": "$3,200.50"
      },
      "validThroughTime": "2024-12-31T23:59:59Z",
      "createdTime": "2024-01-15T10:30:00Z",
      "publishedTime": "2024-01-16T14:20:00Z",
      "sentTime": "2024-01-17T09:15:00Z",
      "paidTime": "2024-01-20T16:45:00Z",
      "acceptedName": "Jane Customer",
      "acceptedEmail": "jane@example.com",
      "completionComment": "Paid via ACH",
      "deletedTime": null,
      "links": {
        "lead": "456-leads"
      }
    }
  ]
}