v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB
Bills

Revert bill to awaiting invoice

Revert bill completely back to awaiting invoice state.

What happens

  • Bill record is deleted
  • Any payments are deleted
  • Entity status reverts to AWAITING_INVOICE

Use case

Use when a bill was recorded incorrectly and needs to start over.

post/bills/{id}/revert

Path parameters

idstring required

Resource ID (UUID) or client key

Query parameters

by'id' | 'key'

Specify lookup type for faster retrieval. If omitted, defaults to looking up by ID first, then falls back to client key if not found. Use by=key when you know you're providing a client key for best performance.

Request body

reasonstring

Reason for reverting

Response

Bill reverted successfully

successboolean
entityStatusstring

New status of the load carrier or vended service