GET api/magento/invoices/{invoiceId}

Gets an invoice by id

Request Information

URI Parameters

Name	Description	Type	Additional information
invoiceId	invoice Id	string	Required

Body Parameters

None.

Response Information

Resource Description

invoice

SuiteBridge.MagentoWebService.salesOrderInvoiceEntity

Name	Type	Additional information
increment_id	string	None.
parent_id	string	None.
store_id	string	None.
created_at	string	None.
updated_at	string	None.
is_active	string	None.
global_currency_code	string	None.
base_currency_code	string	None.
store_currency_code	string	None.
order_currency_code	string	None.
store_to_base_rate	string	None.
store_to_order_rate	string	None.
base_to_global_rate	string	None.
base_to_order_rate	string	None.
subtotal	string	None.
base_subtotal	string	None.
base_grand_total	string	None.
discount_amount	string	None.
base_discount_amount	string	None.
shipping_amount	string	None.
base_shipping_amount	string	None.
tax_amount	string	None.
base_tax_amount	string	None.
billing_address_id	string	None.
billing_firstname	string	None.
billing_lastname	string	None.
order_id	string	None.
order_increment_id	string	None.
order_created_at	string	None.
state	string	None.
grand_total	string	None.
invoice_id	string	None.
items	Collection of SuiteBridge.MagentoWebService.salesOrderInvoiceItemEntity	None.
comments	Collection of SuiteBridge.MagentoWebService.salesOrderInvoiceCommentEntity	None.

Response Formats

application/json, text/json

Sample:

{
  "increment_id": "sample string 1",
  "parent_id": "sample string 2",
  "store_id": "sample string 3",
  "created_at": "sample string 4",
  "updated_at": "sample string 5",
  "is_active": "sample string 6",
  "global_currency_code": "sample string 7",
  "base_currency_code": "sample string 8",
  "store_currency_code": "sample string 9",
  "order_currency_code": "sample string 10",
  "store_to_base_rate": "sample string 11",
  "store_to_order_rate": "sample string 12",
  "base_to_global_rate": "sample string 13",
  "base_to_order_rate": "sample string 14",
  "subtotal": "sample string 15",
  "base_subtotal": "sample string 16",
  "base_grand_total": "sample string 17",
  "discount_amount": "sample string 18",
  "base_discount_amount": "sample string 19",
  "shipping_amount": "sample string 20",
  "base_shipping_amount": "sample string 21",
  "tax_amount": "sample string 22",
  "base_tax_amount": "sample string 23",
  "billing_address_id": "sample string 24",
  "billing_firstname": "sample string 25",
  "billing_lastname": "sample string 26",
  "order_id": "sample string 27",
  "order_increment_id": "sample string 28",
  "order_created_at": "sample string 29",
  "state": "sample string 30",
  "grand_total": "sample string 31",
  "invoice_id": "sample string 32",
  "items": [
    {
      "increment_id": "sample string 1",
      "parent_id": "sample string 2",
      "created_at": "sample string 3",
      "updated_at": "sample string 4",
      "is_active": "sample string 5",
      "weee_tax_applied": "sample string 6",
      "qty": "sample string 7",
      "cost": "sample string 8",
      "price": "sample string 9",
      "tax_amount": "sample string 10",
      "row_total": "sample string 11",
      "base_price": "sample string 12",
      "base_tax_amount": "sample string 13",
      "base_row_total": "sample string 14",
      "base_weee_tax_applied_amount": "sample string 15",
      "base_weee_tax_applied_row_amount": "sample string 16",
      "weee_tax_applied_amount": "sample string 17",
      "weee_tax_applied_row_amount": "sample string 18",
      "weee_tax_disposition": "sample string 19",
      "weee_tax_row_disposition": "sample string 20",
      "base_weee_tax_disposition": "sample string 21",
      "base_weee_tax_row_disposition": "sample string 22",
      "sku": "sample string 23",
      "name": "sample string 24",
      "order_item_id": "sample string 25",
      "product_id": "sample string 26",
      "item_id": "sample string 27"
    },
    {
      "increment_id": "sample string 1",
      "parent_id": "sample string 2",
      "created_at": "sample string 3",
      "updated_at": "sample string 4",
      "is_active": "sample string 5",
      "weee_tax_applied": "sample string 6",
      "qty": "sample string 7",
      "cost": "sample string 8",
      "price": "sample string 9",
      "tax_amount": "sample string 10",
      "row_total": "sample string 11",
      "base_price": "sample string 12",
      "base_tax_amount": "sample string 13",
      "base_row_total": "sample string 14",
      "base_weee_tax_applied_amount": "sample string 15",
      "base_weee_tax_applied_row_amount": "sample string 16",
      "weee_tax_applied_amount": "sample string 17",
      "weee_tax_applied_row_amount": "sample string 18",
      "weee_tax_disposition": "sample string 19",
      "weee_tax_row_disposition": "sample string 20",
      "base_weee_tax_disposition": "sample string 21",
      "base_weee_tax_row_disposition": "sample string 22",
      "sku": "sample string 23",
      "name": "sample string 24",
      "order_item_id": "sample string 25",
      "product_id": "sample string 26",
      "item_id": "sample string 27"
    }
  ],
  "comments": [
    {
      "increment_id": "sample string 1",
      "parent_id": "sample string 2",
      "created_at": "sample string 3",
      "updated_at": "sample string 4",
      "is_active": "sample string 5",
      "comment": "sample string 6",
      "is_customer_notified": "sample string 7",
      "comment_id": "sample string 8"
    },
    {
      "increment_id": "sample string 1",
      "parent_id": "sample string 2",
      "created_at": "sample string 3",
      "updated_at": "sample string 4",
      "is_active": "sample string 5",
      "comment": "sample string 6",
      "is_customer_notified": "sample string 7",
      "comment_id": "sample string 8"
    }
  ]
}

application/xml, text/xml

Sample:

<salesOrderInvoiceEntity xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <increment_id>sample string 1</increment_id>
  <parent_id>sample string 2</parent_id>
  <store_id>sample string 3</store_id>
  <created_at>sample string 4</created_at>
  <updated_at>sample string 5</updated_at>
  <is_active>sample string 6</is_active>
  <global_currency_code>sample string 7</global_currency_code>
  <base_currency_code>sample string 8</base_currency_code>
  <store_currency_code>sample string 9</store_currency_code>
  <order_currency_code>sample string 10</order_currency_code>
  <store_to_base_rate>sample string 11</store_to_base_rate>
  <store_to_order_rate>sample string 12</store_to_order_rate>
  <base_to_global_rate>sample string 13</base_to_global_rate>
  <base_to_order_rate>sample string 14</base_to_order_rate>
  <subtotal>sample string 15</subtotal>
  <base_subtotal>sample string 16</base_subtotal>
  <base_grand_total>sample string 17</base_grand_total>
  <discount_amount>sample string 18</discount_amount>
  <base_discount_amount>sample string 19</base_discount_amount>
  <shipping_amount>sample string 20</shipping_amount>
  <base_shipping_amount>sample string 21</base_shipping_amount>
  <tax_amount>sample string 22</tax_amount>
  <base_tax_amount>sample string 23</base_tax_amount>
  <billing_address_id>sample string 24</billing_address_id>
  <billing_firstname>sample string 25</billing_firstname>
  <billing_lastname>sample string 26</billing_lastname>
  <order_id>sample string 27</order_id>
  <order_increment_id>sample string 28</order_increment_id>
  <order_created_at>sample string 29</order_created_at>
  <state>sample string 30</state>
  <grand_total>sample string 31</grand_total>
  <invoice_id>sample string 32</invoice_id>
  <items>
    <complexObjectArray>
      <increment_id>sample string 1</increment_id>
      <parent_id>sample string 2</parent_id>
      <created_at>sample string 3</created_at>
      <updated_at>sample string 4</updated_at>
      <is_active>sample string 5</is_active>
      <weee_tax_applied>sample string 6</weee_tax_applied>
      <qty>sample string 7</qty>
      <cost>sample string 8</cost>
      <price>sample string 9</price>
      <tax_amount>sample string 10</tax_amount>
      <row_total>sample string 11</row_total>
      <base_price>sample string 12</base_price>
      <base_tax_amount>sample string 13</base_tax_amount>
      <base_row_total>sample string 14</base_row_total>
      <base_weee_tax_applied_amount>sample string 15</base_weee_tax_applied_amount>
      <base_weee_tax_applied_row_amount>sample string 16</base_weee_tax_applied_row_amount>
      <weee_tax_applied_amount>sample string 17</weee_tax_applied_amount>
      <weee_tax_applied_row_amount>sample string 18</weee_tax_applied_row_amount>
      <weee_tax_disposition>sample string 19</weee_tax_disposition>
      <weee_tax_row_disposition>sample string 20</weee_tax_row_disposition>
      <base_weee_tax_disposition>sample string 21</base_weee_tax_disposition>
      <base_weee_tax_row_disposition>sample string 22</base_weee_tax_row_disposition>
      <sku>sample string 23</sku>
      <name>sample string 24</name>
      <order_item_id>sample string 25</order_item_id>
      <product_id>sample string 26</product_id>
      <item_id>sample string 27</item_id>
    </complexObjectArray>
    <complexObjectArray>
      <increment_id>sample string 1</increment_id>
      <parent_id>sample string 2</parent_id>
      <created_at>sample string 3</created_at>
      <updated_at>sample string 4</updated_at>
      <is_active>sample string 5</is_active>
      <weee_tax_applied>sample string 6</weee_tax_applied>
      <qty>sample string 7</qty>
      <cost>sample string 8</cost>
      <price>sample string 9</price>
      <tax_amount>sample string 10</tax_amount>
      <row_total>sample string 11</row_total>
      <base_price>sample string 12</base_price>
      <base_tax_amount>sample string 13</base_tax_amount>
      <base_row_total>sample string 14</base_row_total>
      <base_weee_tax_applied_amount>sample string 15</base_weee_tax_applied_amount>
      <base_weee_tax_applied_row_amount>sample string 16</base_weee_tax_applied_row_amount>
      <weee_tax_applied_amount>sample string 17</weee_tax_applied_amount>
      <weee_tax_applied_row_amount>sample string 18</weee_tax_applied_row_amount>
      <weee_tax_disposition>sample string 19</weee_tax_disposition>
      <weee_tax_row_disposition>sample string 20</weee_tax_row_disposition>
      <base_weee_tax_disposition>sample string 21</base_weee_tax_disposition>
      <base_weee_tax_row_disposition>sample string 22</base_weee_tax_row_disposition>
      <sku>sample string 23</sku>
      <name>sample string 24</name>
      <order_item_id>sample string 25</order_item_id>
      <product_id>sample string 26</product_id>
      <item_id>sample string 27</item_id>
    </complexObjectArray>
  </items>
  <comments>
    <complexObjectArray>
      <increment_id>sample string 1</increment_id>
      <parent_id>sample string 2</parent_id>
      <created_at>sample string 3</created_at>
      <updated_at>sample string 4</updated_at>
      <is_active>sample string 5</is_active>
      <comment>sample string 6</comment>
      <is_customer_notified>sample string 7</is_customer_notified>
      <comment_id>sample string 8</comment_id>
    </complexObjectArray>
    <complexObjectArray>
      <increment_id>sample string 1</increment_id>
      <parent_id>sample string 2</parent_id>
      <created_at>sample string 3</created_at>
      <updated_at>sample string 4</updated_at>
      <is_active>sample string 5</is_active>
      <comment>sample string 6</comment>
      <is_customer_notified>sample string 7</is_customer_notified>
      <comment_id>sample string 8</comment_id>
    </complexObjectArray>
  </comments>
</salesOrderInvoiceEntity>