What parameters does POST /V1/order/:orderId/invoice accept?

This endpoint accepts 7 parameters: orderId (int) required; capture (bool|false); items (Magento\Sales\Api\Data\InvoiceItemCreationInterface[]); notify (bool|false); appendComment (bool|false); comment (Data\InvoiceCommentCreationInterface); arguments (Data\InvoiceCreationArgumentsInterface).

MageSmith

POSTSales · Magento 2.4.9 Admin · Magento_Sales::invoice

POST /V1/order/:orderId/invoice

Q: What does the POST /V1/order/:orderId/invoice endpoint do in Magento 2?

POST /V1/order/:orderId/invoice is a Magento 2 REST endpoint in the Sales module. Requires an admin Bearer token with ACL Magento_Sales::invoice.

Q: Does POST /V1/order/:orderId/invoice require authentication?

This endpoint requires an admin Bearer token with ACL: Magento_Sales::invoice.

POST /V1/order/:orderId/invoice is a Magento 2 REST endpoint in the Sales module. Requires an admin Bearer token with ACL Magento_Sales::invoice.

Last verified: 2026-05-23 against Magento 2.4.9.

Returns

int

Service contract

Magento\Sales\Api\InvoiceOrderInterface::execute

Authorization

Admin Bearer token with ACL:

Magento_Sales::invoice

Path parameters

orderId int Required

Body parameters

capture bool|false default: false

items Magento\Sales\Api\Data\InvoiceItemCreationInterface[] default: []

notify bool|false default: false

appendComment bool|false default: false

comment Data\InvoiceCommentCreationInterface default: null

arguments Data\InvoiceCreationArgumentsInterface default: null

Example request

Auto-generated from the service contract — paste-ready against your store's /rest/default base. Replace the host, store code, ACL token, and any required values before running.

Headers

application/json

Content-Type

application/json

Authorization

Bearer <ACCESS_TOKEN> admin token with ACL: Magento_Sales::invoice

Path

/V1/order/{orderId}/invoice

Body

{
  "appendComment": false,
  "arguments": {},
  "capture": false,
  "comment": {},
  "items": [
    {
      "extension_attributes": {},
      "order_item_id": 0,
      "qty": 0
    }
  ],
  "notify": false
}