---
title: "Patch method to partially update an invoice"
method: PATCH
path: "/billing/v1/invoices/{invoiceNumber}"
tags: ["Invoice"]
---

# Patch method to partially update an invoice

`PATCH /billing/v1/invoices/{invoiceNumber}`

## Request

- Base URL: `https://marketplace.appdirect.com/api`
- URL: `https://marketplace.appdirect.com/api/billing/v1/invoices/{invoiceNumber}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/appdirect/apis/companies/docs/billing/v1/invoices/:invoiceNumber/patch.ts> (a function with typed inputs; its response is checked against the schema)

Currently only used to void an invoice by updating the invoice status

## Path parameters

- `invoiceNumber` integer, required

## Request body

- InvoiceWS, nullable: Resource links
  - `links` Link[]: Resource links
    - `href` string
    - `rel` string
  - `company` LinkWS, nullable
    - `href` string
    - `id` string
  - `creationDate` number, nullable: Creation date for the invoice.
  - `orderIds` string[]: Array of Order IDs
  - `currency` 'USD' | 'CAD' | 'EUR' | 'JPY' | 'GBP' | 'KRW' | 'CHF' | 'SEK' | 'SGD' | 'MYR' | 'AUD' | 'MXN' | 'INR' | 'BRL' | 'DKK' | 'NZD' | 'NOK' | 'ZAR' | 'PHP' | 'CNY' | 'SAR' | 'GTQ' | 'IDR' | 'ARS' | 'COP' | 'PEN': Supported currencies for the system
  - `dueDate` number, nullable: Due date for the invoice.
  - `invoiceId` number, nullable: Invoice ID.
  - `referenceNumber` string, nullable: Reference number.
  - `status` 'PAID' | 'UNPAID' | 'CARRIED' | 'VOIDED'
  - `total` number, nullable: Invoice total.
  - `user` LinkWS, nullable
    - `href` string
    - `id` string
  - `delegatedToInvoice` LinkWS, nullable
    - `href` string
    - `id` string
  - `includedInvoices` LinkWS[], nullable: List of links to the included invoices
    - `href` string
    - `id` string
  - `invoiceLines` InvoiceLineWS[]: List of Invoice lines
    - `description` string: Description
    - `id` number, nullable: ID
    - `itemId` number, nullable: Deprecated: Item ID
    - `percentage` number, nullable: Percentage
    - `periodEnd` number, nullable: Period end
    - `periodStart` number, nullable: Period start
    - `price` number, nullable: Item price
    - `quantity` number, nullable: Quantity
    - `total` number, nullable: Total
    - `type` 'ITEM' | 'DISCOUNT' | 'TAX' | 'DELEGATED_INVOICE' | 'TERMINATION_FEE' | 'SUB_ACCOUNT', nullable
    - `paymentPlanId` number, nullable: Payment Plan ID
    - `editionId` number, nullable: Edition ID
    - `productId` number, nullable: Product ID
    - `pricingUnit` string, nullable: Pricing Unit
    - `vendor` VendorWS, nullable
      - `uuid` string, nullable
      - `name` string, nullable
    - `saleRepCompany` SaleRepCompanyWS, nullable
      - `uuid` string, nullable
      - `name` string, nullable
      - `isReseller` boolean
      - `isSalesSupport` boolean
    - `saleRepUser` SaleRepUserWS, nullable
      - `uuid` string, nullable
      - `name` string, nullable
      - `isReseller` boolean
      - `isSalesSupport` boolean

## Response `200`

OK

- InvoiceWS, nullable: Resource links
  - `links` Link[]: Resource links
    - `href` string
    - `rel` string
  - `company` LinkWS, nullable
    - `href` string
    - `id` string
  - `creationDate` number, nullable: Creation date for the invoice.
  - `orderIds` string[]: Array of Order IDs
  - `currency` 'USD' | 'CAD' | 'EUR' | 'JPY' | 'GBP' | 'KRW' | 'CHF' | 'SEK' | 'SGD' | 'MYR' | 'AUD' | 'MXN' | 'INR' | 'BRL' | 'DKK' | 'NZD' | 'NOK' | 'ZAR' | 'PHP' | 'CNY' | 'SAR' | 'GTQ' | 'IDR' | 'ARS' | 'COP' | 'PEN': Supported currencies for the system
  - `dueDate` number, nullable: Due date for the invoice.
  - `invoiceId` number, nullable: Invoice ID.
  - `referenceNumber` string, nullable: Reference number.
  - `status` 'PAID' | 'UNPAID' | 'CARRIED' | 'VOIDED'
  - `total` number, nullable: Invoice total.
  - `user` LinkWS, nullable
    - `href` string
    - `id` string
  - `delegatedToInvoice` LinkWS, nullable
    - `href` string
    - `id` string
  - `includedInvoices` LinkWS[], nullable: List of links to the included invoices
    - `href` string
    - `id` string
  - `invoiceLines` InvoiceLineWS[]: List of Invoice lines
    - `description` string: Description
    - `id` number, nullable: ID
    - `itemId` number, nullable: Deprecated: Item ID
    - `percentage` number, nullable: Percentage
    - `periodEnd` number, nullable: Period end
    - `periodStart` number, nullable: Period start
    - `price` number, nullable: Item price
    - `quantity` number, nullable: Quantity
    - `total` number, nullable: Total
    - `type` 'ITEM' | 'DISCOUNT' | 'TAX' | 'DELEGATED_INVOICE' | 'TERMINATION_FEE' | 'SUB_ACCOUNT', nullable
    - `paymentPlanId` number, nullable: Payment Plan ID
    - `editionId` number, nullable: Edition ID
    - `productId` number, nullable: Product ID
    - `pricingUnit` string, nullable: Pricing Unit
    - `vendor` VendorWS, nullable
      - `uuid` string, nullable
      - `name` string, nullable
    - `saleRepCompany` SaleRepCompanyWS, nullable
      - `uuid` string, nullable
      - `name` string, nullable
      - `isReseller` boolean
      - `isSalesSupport` boolean
    - `saleRepUser` SaleRepUserWS, nullable
      - `uuid` string, nullable
      - `name` string, nullable
      - `isReseller` boolean
      - `isSalesSupport` boolean

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `404`: Not Found

## Changes

- **2026-11-06** `1fc240f06971`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/appdirect/apis/companies/changes/billing/v1/invoices/:invoiceNumber/patch.md)

---

[API](https://skmtc.dev/appdirect/apis/companies.md) - [All operations](https://skmtc.dev/appdirect/apis/companies/llms.txt) - [OpenAPI document](https://skmtc.dev/appdirect/apis/companies/revisions/1fc240f06971?raw)