NMnmi
Invoicing

Update Invoice

Update an existing invoice. All variables (besides currency) on an invoice may be updated. Updating an invoice will not result in a new invoice being sent to the customer.

put/v5/invoices/{invoice_id}

Request

  • Base URL
    https://sandbox.nmi.com/api
  • URL
    https://sandbox.nmi.com/api/v5/invoices/{invoice_id}
  • Auth
    API key in header Authorization

Path parameters

invoice_idinteger required

The invoice ID to be updated.

Request body

amountnumber

Total amount to be invoiced. Must be greater than 0.00. Format: x.xx

subtotalnumber float

Subtotal amount before tax and shipping

payment_termsstring

When the invoice should be paid. Values: 'upon_receipt', or integers from 0-999. Default - upon_receipt.

payment_methods_allowedstring[]

Payment methods allowed for this invoice. 'cc' = Credit Card, 'ck' = Check, 'cs' = Cash

processor_idstring

If using Multiple MIDs, route to this processor (processor_id is obtained under Settings → Transaction Routing in the Control Panel).

If allowing multiple payment types, one processor_id can be selected per payment type by submitting comma-separated values.

currencystring

The transaction currency. Format: ISO 4217 (must be uppercase 3-letter code)

Response

Success

object'invoice' required

Resource type identifier

idinteger required

Invoice ID

status'open' | 'partially_paid' | 'paid' | 'closed' | 'overdue'

Current status of the invoice

amountstring

Total amount of the invoice. Format: x.xx

subtotalnumber nullable

Subtotal amount before tax and shipping

payment_termsstring

Payment terms for the invoice (e.g., 'Due Upon Receipt', '30 days')

payment_methods_allowedstring[]

Allowed payment methods: 'cc' = Credit Card, 'ck' = Check, 'cs' = Cash

processor_idstring nullable

Processor ID for payment processing

currencystring

Currency code (ISO 4217, e.g., USD, EUR)

created_datestring date-time nullable

Date and time when the invoice was created in UTC ISO 8601 format

updated_datestring date-time nullable

Date and time when the invoice was last updated in UTC ISO 8601 format

Changes

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