Answer5

AppResellerAccount6

AppResellerAssignment3

AppResellerCatalog2

AppResellerCompanyAssociation3

AppResellerLeads11

AppResellerOpportunities23

AppResellerOrder1

AppResellerPaymentMethod3

AppResellerQuoteVersion4

AppResellerReconciliation3

AppResellerSubscription5

Bundle3

checkoutItemDetails1

Comment5

Companies7

CompanyMemberships15

CurrencyExchangeRate4

CustomerNotification9

DataUploader3

DefaultNotificationTemplateApi5

Discount5

Domains3

Edition1

Event2

Group10

InboundEvents1

Integration4

Invitation5

Invoice7

Marketplace Product Settings5

MyApps4

Navigation1

Payment5

Payment Methods7

PaymentInstrument6

PaymentPlan3

Payments v29

Product8

Product Management API4

ProductContext2

PurchaseOrder7

Question4

Reconciliation1

Reporting3

Reporting V22

Review5

Search1

SegmentFolders15

Settings2

ShoppingCart28

SubscriptionAssignments5

Subscriptions23

Sync5

User13

UserAccounts2

Invoice

Patch method to partially update an invoice

Changed on Nov 6, 2026

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

patch/billing/v1/invoices/{invoiceNumber}

Request

Base URL
https://marketplace.appdirect.com/api
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.

Path parameters

invoiceNumberinteger required

The unique identifier of the invoice that should be patched.

Request body

creationDatenumber nullable

Creation date for the invoice.

orderIdsstring[]

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

dueDatenumber nullable

Due date for the invoice.

invoiceIdnumber nullable

Invoice ID.

referenceNumberstring nullable

Reference number.

status'PAID' | 'UNPAID' | 'CARRIED' | 'VOIDED'

totalnumber nullable

Invoice total.

Example request

{
  "company": {
    "href": "...",
    "id": "..."
  },
  "orderIds": [
    "1234"
  ],
  "creationDate": 12345,
  "currency": "KRW",
  "delegatedToInvoice": {
    "href": "...",
    "id": "..."
  },
  "dueDate": 12345,
  "includedInvoices": [
    {
      "href": "...",
      "id": "..."
    },
    {
      "href": "...",
      "id": "..."
    }
  ],
  "invoiceId": 12345,
  "invoiceLines": [
    {
      "description": "...",
      "id": 12345,
      "itemId": 12345,
      "percentage": 12345,
      "periodEnd": 12345,
      "periodStart": 12345,
      "price": 12345,
      "quantity": 12345,
      "total": 12345,
      "type": "ITEM"
    },
    {
      "description": "...",
      "id": 12345,
      "itemId": 12345,
      "percentage": 12345,
      "periodEnd": 12345,
      "periodStart": 12345,
      "price": 12345,
      "quantity": 12345,
      "total": 12345,
      "type": "TAX"
    }
  ],
  "links": [
    {
      "href": "...",
      "rel": "..."
    },
    {
      "href": "...",
      "rel": "..."
    }
  ],
  "referenceNumber": "...",
  "status": "VOIDED",
  "total": 12345,
  "user": {
    "href": "...",
    "id": "..."
  }
}

Response