Sign in
Billing

Void an invoice

Void an invoice

Only invoices that have been alread issued can be voided.

Voiding an invoice will mark it as voided, the user can specify how to handle the voided line items.

post/api/v1/billing/invoices/{invoiceId}/void

Path parameters

invoiceIdstring required
Example:01G65Z755AFWAKHE12NY0CQ9FH

Request body

reasonstring required

The reason for voiding the invoice.

Example request

{
  "action": {
    "action": {
      "nextInvoiceAt": "2023-01-01T01:01:01.001Z"
    },
    "percentage": 50
  },
  "overrides": [
    {
      "action": {
        "action": {
          "nextInvoiceAt": "2023-01-01T01:01:01.001Z"
        },
        "percentage": 50
      },
      "lineId": "01G65Z755AFWAKHE12NY0CQ9FH"
    }
  ]
}

Response

The request has succeeded.

collectionAtstring date-time

The time when the invoice will be/has been collected.

createdAtstring date-time required

Timestamp of when the resource was created.

currencystring required

Three-letter ISO4217 currency code. Custom three-letter currency codes are also supported for convenience.

deletedAtstring date-time

Timestamp of when the resource was permanently deleted.

descriptionstring

Optional description of the resource. Maximum 1024 characters.

draftUntilstring date-time

The time until the invoice is in draft status.

On draft invoice creation it is calculated from the workflow settings.

If manual approval is required, the draftUntil time is set.

dueAtstring date-time

Due time of the fulfillment of the invoice (if available).

idstring required

A unique identifier for the resource.

issuedAtstring date-time

The time the invoice was issued.

Depending on the status of the invoice this can mean multiple things:

  • draft, gathering: The time the invoice will be issued based on the workflow settings.
  • issued: The time the invoice was issued.
metadataMetadata

Set of key-value pairs. Metadata can be used to store additional information about a resource.

numberstring required

InvoiceNumber is a unique identifier for the invoice, generated by the invoicing app.

The uniqueness depends on a lot of factors:

  • app setting (unique per app or unique per customer)
  • multiple app scenarios (multiple apps generating invoices with the same prefix)
quantitySnapshotedAtstring date-time

The time when the quantity snapshots on the invoice lines were taken.

sentToCustomerAtstring date-time

The time the invoice was sent to customer.

status'gathering' | 'draft' | 'issuing' | 'issued' | 'payment_processing' | 'overdue' | 'paid' | 'uncollectible' | 'voided' required

InvoiceStatus describes the status of an invoice.

type'standard' | 'credit_note' required

InvoiceType represents the type of invoice.

The type of invoice determines the purpose of the invoice and how it should be handled.

updatedAtstring date-time required

Timestamp of when the resource was last updated.

voidedAtstring date-time

The time the invoice was voided.

If the invoice was voided, this field will be set to the time the invoice was voided.

Changes

No recorded changes to this endpoint across all 1 revision of this API.