POST api/magento/orders/{orderId}/bill

Bills order (creates invoice and captures fund)

Request Information

URI Parameters

Name	Description	Type	Additional information
orderId	order id	string	Required

Body Parameters

bill order request

SuiteBridge.Models.Magento.BillOrderRequest

Name	Description	Type	Additional information
invoice_capture	invoice capture flag - true for invoice and capture - false invoice only	boolean	None.
items	an array of items/quantity to bill	Collection of SuiteBridge.MagentoWebService.orderItemIdQty	None.

Request Formats

application/json, text/json

Sample:

{
  "invoice_capture": true,
  "items": [
    {
      "order_item_id": 1,
      "qty": 2.1
    },
    {
      "order_item_id": 1,
      "qty": 2.1
    }
  ]
}

application/xml, text/xml

Sample:

<BillOrderRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <invoice_capture>true</invoice_capture>
  <items>
    <orderItemIdQty>
      <order_item_id>1</order_item_id>
      <qty>2.1</qty>
    </orderItemIdQty>
    <orderItemIdQty>
      <order_item_id>1</order_item_id>
      <qty>2.1</qty>
    </orderItemIdQty>
  </items>
</BillOrderRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

invoice reference and adds a url link in the header to the created invoice with 201 Created response

SuiteBridge.Models.Magento.ResourceRef

Name	Description	Type	Additional information
increment_id	resource id	string	None.
type	resource type	string	None.

Response Formats

application/json, text/json

Sample:

{
  "increment_id": "sample string 1",
  "type": "sample string 2"
}

application/xml, text/xml

Sample:

<ResourceRef xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <increment_id>sample string 1</increment_id>
  <type>sample string 2</type>
</ResourceRef>