Delete an invoice

DELETE/v2/api/store/{team_slug}/v2/invoice/{unique_key}

v2Operation ID v2_public_invoice_destroy

Deletes an invoice and its lines. Payments stay recorded on the sales order: the amounts that were allocated to this invoice are automatically redistributed across the order's other invoices, or returned to unallocated balance.

Deleting an invoice that is already deleted succeeds and changes nothing.

Permission

Any member of the team. Unlike Update an invoice, this route checks no sales order permission.

Business rules

• Auto Invoice invoices can't be deleted, nor can an invoice holding lines YoPrint manages: 422 "You cannot delete an auto managed invoice." Turn off Auto Invoice on the order first.
• Invoices synced from an external system (Shopify) can't be deleted: 422 "Cannot delete external object from API."
• Paid and part-paid invoices can be deleted.

Side effects

• Removes the invoice's payment allocations and redistributes the order's payments across its remaining invoices.
• Recalculates the order's invoiced totals and each line's invoiced status.
• May queue a QuickBooks Online sync of the order. Open Admin Portal pages refresh, and so do Customer Portal pages the order's customer has open.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• unique_keystringrequired

  The invoice's id (a hash id), as its answers show it. Its unique key (ordinv_...) also works, but API answers don't include it.

  • Example cBRpSf5nw6upt5

Request body

This operation takes no request body.

Response

200Successful response.

• datanullrequired
• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

  When

  The invoice isn't your team's.

  Fix

  Check the id.

• 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

  When

  An Auto Invoice or external invoice (see rules).

  Fix

  Turn off Auto Invoice, or change the invoice in its source system.

Related

• GETGet an invoice/v2/api/store/{team_slug}/v2/invoice/{unique_key}
• GETList the invoices of a sales order/v2/api/store/{team_slug}/v2/sales_order/{unique_key}/invoice

Example request

curl

curl -X DELETE 'https://secure.yoprint.com/v2/api/store/your-team/v2/invoice/cBRpSf5nw6upt5' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": null,
  "status": 200,
  "success": true
}