Performs persist operations for a specified invoice

POST /V1/invoices/

Performs persist operations for a specified invoice.

Body

Responses

POST /V1/invoices/
curl \
 -X POST https://magento2.winkelstraat.mac/rest/all/V1/invoices/ \
 -d '{"entity":{"base_currency_code":"string","base_discount_amount":42.0,"base_grand_total":42.0,"base_discount_tax_compensation_amount":42.0,"base_shipping_amount":42.0,"base_shipping_discount_tax_compensation_amnt":42.0,"base_shipping_incl_tax":42.0,"base_shipping_tax_amount":42.0,"base_subtotal":42.0,"base_subtotal_incl_tax":42.0,"base_tax_amount":42.0,"base_total_refunded":42.0,"base_to_global_rate":42.0,"base_to_order_rate":42.0,"billing_address_id":42,"can_void_flag":42,"created_at":"string","discount_amount":42.0,"discount_description":"string","email_sent":42,"entity_id":42,"global_currency_code":"string","grand_total":42.0,"discount_tax_compensation_amount":42.0,"increment_id":"string","is_used_for_refund":42,"order_currency_code":"string","order_id":42,"shipping_address_id":42,"shipping_amount":42.0,"shipping_discount_tax_compensation_amount":42.0,"shipping_incl_tax":42.0,"shipping_tax_amount":42.0,"state":42,"store_currency_code":"string","store_id":42,"store_to_base_rate":42.0,"store_to_order_rate":42.0,"subtotal":42.0,"subtotal_incl_tax":42.0,"tax_amount":42.0,"total_qty":42.0,"transaction_id":"string","updated_at":"string","items":[{"additional_data":"string","base_cost":42.0,"base_discount_amount":42.0,"base_discount_tax_compensation_amount":42.0,"base_price":42.0,"base_price_incl_tax":42.0,"base_row_total":42.0,"base_row_total_incl_tax":42.0,"base_tax_amount":42.0,"description":"string","discount_amount":42.0,"entity_id":42,"discount_tax_compensation_amount":42.0,"name":"string","parent_id":42,"price":42.0,"price_incl_tax":42.0,"product_id":42,"row_total":42.0,"row_total_incl_tax":42.0,"sku":"string","tax_amount":42.0,"extension_attributes":{"list_price":42.0,"size":"string","color":"string","merchant_product_reference":"string","category_code":"string","image":"string","mpn":"string","msrp":42.0,"manufacturer_code":"string","manufacturer_name":"string","merchant_code":"string","merchant_name":"string","merchant_city":"string","merchant_commission_percentage":42.0,"merchant_deficiency_percentage":42.0,"merchant_handling_fee":42.0,"is_sale":true,"return_item_fee":42.0,"base_return_item_fee":42.0,"is_outlet":true},"order_item_id":42,"qty":42.0}],"comments":[{"is_customer_notified":42,"parent_id":42,"extension_attributes":{},"comment":"string","is_visible_on_front":42,"created_at":"string","entity_id":42}],"extension_attributes":{"base_customer_balance_amount":42.0,"customer_balance_amount":42.0,"base_gift_cards_amount":42.0,"gift_cards_amount":42.0,"gw_base_price":"string","gw_price":"string","gw_items_base_price":"string","gw_items_price":"string","gw_card_base_price":"string","gw_card_price":"string","gw_base_tax_amount":"string","gw_tax_amount":"string","gw_items_base_tax_amount":"string","gw_items_tax_amount":"string","gw_card_base_tax_amount":"string","gw_card_tax_amount":"string","company_id":42}}}'
Request examples
{
  "entity": {
    "base_currency_code": "string",
    "base_discount_amount": 42.0,
    "base_grand_total": 42.0,
    "base_discount_tax_compensation_amount": 42.0,
    "base_shipping_amount": 42.0,
    "base_shipping_discount_tax_compensation_amnt": 42.0,
    "base_shipping_incl_tax": 42.0,
    "base_shipping_tax_amount": 42.0,
    "base_subtotal": 42.0,
    "base_subtotal_incl_tax": 42.0,
    "base_tax_amount": 42.0,
    "base_total_refunded": 42.0,
    "base_to_global_rate": 42.0,
    "base_to_order_rate": 42.0,
    "billing_address_id": 42,
    "can_void_flag": 42,
    "created_at": "string",
    "discount_amount": 42.0,
    "discount_description": "string",
    "email_sent": 42,
    "entity_id": 42,
    "global_currency_code": "string",
    "grand_total": 42.0,
    "discount_tax_compensation_amount": 42.0,
    "increment_id": "string",
    "is_used_for_refund": 42,
    "order_currency_code": "string",
    "order_id": 42,
    "shipping_address_id": 42,
    "shipping_amount": 42.0,
    "shipping_discount_tax_compensation_amount": 42.0,
    "shipping_incl_tax": 42.0,
    "shipping_tax_amount": 42.0,
    "state": 42,
    "store_currency_code": "string",
    "store_id": 42,
    "store_to_base_rate": 42.0,
    "store_to_order_rate": 42.0,
    "subtotal": 42.0,
    "subtotal_incl_tax": 42.0,
    "tax_amount": 42.0,
    "total_qty": 42.0,
    "transaction_id": "string",
    "updated_at": "string",
    "items": [
      {
        "additional_data": "string",
        "base_cost": 42.0,
        "base_discount_amount": 42.0,
        "base_discount_tax_compensation_amount": 42.0,
        "base_price": 42.0,
        "base_price_incl_tax": 42.0,
        "base_row_total": 42.0,
        "base_row_total_incl_tax": 42.0,
        "base_tax_amount": 42.0,
        "description": "string",
        "discount_amount": 42.0,
        "entity_id": 42,
        "discount_tax_compensation_amount": 42.0,
        "name": "string",
        "parent_id": 42,
        "price": 42.0,
        "price_incl_tax": 42.0,
        "product_id": 42,
        "row_total": 42.0,
        "row_total_incl_tax": 42.0,
        "sku": "string",
        "tax_amount": 42.0,
        "extension_attributes": {
          "list_price": 42.0,
          "size": "string",
          "color": "string",
          "merchant_product_reference": "string",
          "category_code": "string",
          "image": "string",
          "mpn": "string",
          "msrp": 42.0,
          "manufacturer_code": "string",
          "manufacturer_name": "string",
          "merchant_code": "string",
          "merchant_name": "string",
          "merchant_city": "string",
          "merchant_commission_percentage": 42.0,
          "merchant_deficiency_percentage": 42.0,
          "merchant_handling_fee": 42.0,
          "is_sale": true,
          "return_item_fee": 42.0,
          "base_return_item_fee": 42.0,
          "is_outlet": true
        },
        "order_item_id": 42,
        "qty": 42.0
      }
    ],
    "comments": [
      {
        "is_customer_notified": 42,
        "parent_id": 42,
        "extension_attributes": {},
        "comment": "string",
        "is_visible_on_front": 42,
        "created_at": "string",
        "entity_id": 42
      }
    ],
    "extension_attributes": {
      "base_customer_balance_amount": 42.0,
      "customer_balance_amount": 42.0,
      "base_gift_cards_amount": 42.0,
      "gift_cards_amount": 42.0,
      "gw_base_price": "string",
      "gw_price": "string",
      "gw_items_base_price": "string",
      "gw_items_price": "string",
      "gw_card_base_price": "string",
      "gw_card_price": "string",
      "gw_base_tax_amount": "string",
      "gw_tax_amount": "string",
      "gw_items_base_tax_amount": "string",
      "gw_items_tax_amount": "string",
      "gw_card_base_tax_amount": "string",
      "gw_card_tax_amount": "string",
      "company_id": 42
    }
  }
}
Response examples (200)
{
  "base_currency_code": "string",
  "base_discount_amount": 42.0,
  "base_grand_total": 42.0,
  "base_discount_tax_compensation_amount": 42.0,
  "base_shipping_amount": 42.0,
  "base_shipping_discount_tax_compensation_amnt": 42.0,
  "base_shipping_incl_tax": 42.0,
  "base_shipping_tax_amount": 42.0,
  "base_subtotal": 42.0,
  "base_subtotal_incl_tax": 42.0,
  "base_tax_amount": 42.0,
  "base_total_refunded": 42.0,
  "base_to_global_rate": 42.0,
  "base_to_order_rate": 42.0,
  "billing_address_id": 42,
  "can_void_flag": 42,
  "created_at": "string",
  "discount_amount": 42.0,
  "discount_description": "string",
  "email_sent": 42,
  "entity_id": 42,
  "global_currency_code": "string",
  "grand_total": 42.0,
  "discount_tax_compensation_amount": 42.0,
  "increment_id": "string",
  "is_used_for_refund": 42,
  "order_currency_code": "string",
  "order_id": 42,
  "shipping_address_id": 42,
  "shipping_amount": 42.0,
  "shipping_discount_tax_compensation_amount": 42.0,
  "shipping_incl_tax": 42.0,
  "shipping_tax_amount": 42.0,
  "state": 42,
  "store_currency_code": "string",
  "store_id": 42,
  "store_to_base_rate": 42.0,
  "store_to_order_rate": 42.0,
  "subtotal": 42.0,
  "subtotal_incl_tax": 42.0,
  "tax_amount": 42.0,
  "total_qty": 42.0,
  "transaction_id": "string",
  "updated_at": "string",
  "items": [
    {
      "additional_data": "string",
      "base_cost": 42.0,
      "base_discount_amount": 42.0,
      "base_discount_tax_compensation_amount": 42.0,
      "base_price": 42.0,
      "base_price_incl_tax": 42.0,
      "base_row_total": 42.0,
      "base_row_total_incl_tax": 42.0,
      "base_tax_amount": 42.0,
      "description": "string",
      "discount_amount": 42.0,
      "entity_id": 42,
      "discount_tax_compensation_amount": 42.0,
      "name": "string",
      "parent_id": 42,
      "price": 42.0,
      "price_incl_tax": 42.0,
      "product_id": 42,
      "row_total": 42.0,
      "row_total_incl_tax": 42.0,
      "sku": "string",
      "tax_amount": 42.0,
      "extension_attributes": {
        "list_price": 42.0,
        "size": "string",
        "color": "string",
        "merchant_product_reference": "string",
        "category_code": "string",
        "image": "string",
        "mpn": "string",
        "msrp": 42.0,
        "manufacturer_code": "string",
        "manufacturer_name": "string",
        "merchant_code": "string",
        "merchant_name": "string",
        "merchant_city": "string",
        "merchant_commission_percentage": 42.0,
        "merchant_deficiency_percentage": 42.0,
        "merchant_handling_fee": 42.0,
        "is_sale": true,
        "return_item_fee": 42.0,
        "base_return_item_fee": 42.0,
        "is_outlet": true
      },
      "order_item_id": 42,
      "qty": 42.0
    }
  ],
  "comments": [
    {
      "is_customer_notified": 42,
      "parent_id": 42,
      "extension_attributes": {},
      "comment": "string",
      "is_visible_on_front": 42,
      "created_at": "string",
      "entity_id": 42
    }
  ],
  "extension_attributes": {
    "base_customer_balance_amount": 42.0,
    "customer_balance_amount": 42.0,
    "base_gift_cards_amount": 42.0,
    "gift_cards_amount": 42.0,
    "gw_base_price": "string",
    "gw_price": "string",
    "gw_items_base_price": "string",
    "gw_items_price": "string",
    "gw_card_base_price": "string",
    "gw_card_price": "string",
    "gw_base_tax_amount": "string",
    "gw_tax_amount": "string",
    "gw_items_base_tax_amount": "string",
    "gw_items_tax_amount": "string",
    "gw_card_base_tax_amount": "string",
    "gw_card_tax_amount": "string",
    "company_id": 42
  }
}
Response examples (401)
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (default)
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}