Path parameters

• id integer Required

  The invoice ID.

Responses

• 200

  200 Success.

  Hide response attributes Show response attributes object

  • base_currency_code string

    Base currency code.

  • base_discount_amount number

    Base discount amount.

  • base_grand_total number

    Base grand total.

  • base_discount_tax_compensation_amount number

    Base discount tax compensation amount.

  • base_shipping_amount number

    Base shipping amount.

  • base_shipping_discount_tax_compensation_amnt number

    Base shipping discount tax compensation amount.

  • base_shipping_incl_tax number

    Base shipping including tax.

  • base_shipping_tax_amount number

    Base shipping tax amount.

  • base_subtotal number

    Base subtotal.

  • base_subtotal_incl_tax number

    Base subtotal including tax.

  • base_tax_amount number

    Base tax amount.

  • base_total_refunded number

    Base total refunded.

  • base_to_global_rate number

    Base-to-global rate.

  • base_to_order_rate number

    Base-to-order rate.

  • billing_address_id integer

    Billing address ID.

  • can_void_flag integer

    Can void flag value.

  • created_at string

    Created-at timestamp.

  • discount_amount number

    Discount amount.

  • discount_description string

    Discount description.

  • email_sent integer

    Email-sent flag value.

  • entity_id integer

    Invoice ID.

  • global_currency_code string

    Global currency code.

  • grand_total number

    Grand total.

  • discount_tax_compensation_amount number

    Discount tax compensation amount.

  • increment_id string

    Increment ID.

  • is_used_for_refund integer

    Is-used-for-refund flag value.

  • order_currency_code string

    Order currency code.

  • order_id integer Required

    Order ID.

  • shipping_address_id integer

    Shipping address ID.

  • shipping_amount number

    Shipping amount.

  • shipping_discount_tax_compensation_amount number

    Shipping discount tax compensation amount.

  • shipping_incl_tax number

    Shipping including tax.

  • shipping_tax_amount number

    Shipping tax amount.

  • state integer

    State.

  • store_currency_code string

    Store currency code.

  • store_id integer

    Store ID.

  • store_to_base_rate number

    Store-to-base rate.

  • store_to_order_rate number

    Store-to-order rate.

  • subtotal number

    Subtotal.

  • subtotal_incl_tax number

    Subtotal including tax.

  • tax_amount number

    Tax amount.

  • total_qty number Required

    Total quantity.

  • transaction_id string

    Transaction ID.

  • updated_at string

    Updated-at timestamp.

  • items array[object] Required

    Invoice item interface. An invoice is a record of the receipt of payment for an order. An invoice item is a purchased item in an invoice.

    Hide items attributes Show items attributes object

    Invoice item interface. An invoice is a record of the receipt of payment for an order. An invoice item is a purchased item in an invoice.

    • additional_data string

      Additional data.

    • base_cost number

      Base cost.

    • base_discount_amount number

      Base discount amount.

    • base_discount_tax_compensation_amount number

      Base discount tax compensation amount.

    • base_price number

      Base price.

    • base_price_incl_tax number

      Base price including tax.

    • base_row_total number

      Base row total.

    • base_row_total_incl_tax number

      Base row total including tax.

    • base_tax_amount number

      Base tax amount.

    • description string

      Description.

    • discount_amount number

      Discount amount.

    • entity_id integer

      Invoice item ID.

    • discount_tax_compensation_amount number

      Discount tax compensation amount.

    • name string

      Name.

    • parent_id integer

      Parent ID.

    • price number

      Price.

    • price_incl_tax number

      Price including tax.

    • product_id integer

      Product ID.

    • row_total number

      Row total.

    • row_total_incl_tax number

      Row total including tax.

    • sku string Required

      SKU.

    • tax_amount number

      Tax amount.

    • extension_attributes object

      ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceItemInterface

      Hide extension_attributes attributes Show extension_attributes attributes object

      • list_price number
      • size string
      • color string
      • merchant_product_reference string
      • category_code string
      • image string
      • mpn string
      • msrp number
      • manufacturer_code string
      • manufacturer_name string
      • merchant_code string
      • merchant_name string
      • merchant_city string
      • merchant_commission_percentage number
      • merchant_deficiency_percentage number
      • merchant_handling_fee number
      • is_sale boolean
      • return_item_fee number
      • base_return_item_fee number
      • is_outlet boolean
    • order_item_id integer Required

      Order item ID.

    • qty number Required

      Quantity.

  • comments array[object]

    Invoice comment interface. An invoice is a record of the receipt of payment for an order. An invoice can include comments that detail the invoice history.

    Hide comments attributes Show comments attributes object

    Invoice comment interface. An invoice is a record of the receipt of payment for an order. An invoice can include comments that detail the invoice history.

    • is_customer_notified integer Required

      Is-customer-notified flag value.

    • parent_id integer Required

      Parent ID.

    • extension_attributes object

      ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceCommentInterface

    • comment string Required

      Comment.

    • is_visible_on_front integer Required

      Is-visible-on-storefront flag value.

    • created_at string

      Created-at timestamp.

    • entity_id integer

      Invoice ID.

  • extension_attributes object

    ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceInterface

    Hide extension_attributes attributes Show extension_attributes attributes object

    • base_customer_balance_amount number
    • customer_balance_amount number
    • base_gift_cards_amount number
    • gift_cards_amount number
    • 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 integer
• 401

  401 Unauthorized

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Error details

    Hide errors attributes Show errors attributes object

    Error details

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

  • code integer

    Error code

  • parameters array[object]

    Error parameters item

    Hide parameters attributes Show parameters attributes object

    Error parameters item

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace

• default

  Unexpected error

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Error details

    Hide errors attributes Show errors attributes object

    Error details

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

  • code integer

    Error code

  • parameters array[object]

    Error parameters item

    Hide parameters attributes Show parameters attributes object

    Error parameters item

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace