GET api/BillingService/GetInvoice?invoiceNumber={invoiceNumber}

Documentation for 'GetInvoice'.

Request Information

Parameters

Name	Description	Additional information
invoiceNumber	Documentation for 'invoiceNumber'.	Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "invoice_number": "sample string 1",
  "description": "sample string 2",
  "invoice_date": "sample string 3",
  "invoice_type": 64,
  "invoice_state": 64,
  "order_amount": 6.0,
  "tax_amount": 7.0,
  "shipping_amount": 8.0,
  "currency_type": "sample string 9",
  "due_to_pay_utc_time": "sample string 10",
  "subscription_detail": [
    {
      "subscription_text_id": "sample string 1",
      "product_text_id": "sample string 2",
      "device_guid": "sample string 3",
      "quantity": 4,
      "Promotion_code": "sample string 5",
      "discount": 6.0,
      "original_amount": 7.0,
      "real_amount": 8.0,
      "from_date": "sample string 9",
      "to_date": "sample string 10",
      "is_adjusted": true,
      "l1_distributor_uuid": "sample string 12",
      "l2_distributor_uuid": "sample string 13",
      "l1_distributor_name": "sample string 14",
      "l2_distributor_name": "sample string 15",
      "l1_distributor_rebate_rate": 16.0,
      "l2_distributor_rebate_rate": 17.0
    },
    {
      "subscription_text_id": "sample string 1",
      "product_text_id": "sample string 2",
      "device_guid": "sample string 3",
      "quantity": 4,
      "Promotion_code": "sample string 5",
      "discount": 6.0,
      "original_amount": 7.0,
      "real_amount": 8.0,
      "from_date": "sample string 9",
      "to_date": "sample string 10",
      "is_adjusted": true,
      "l1_distributor_uuid": "sample string 12",
      "l2_distributor_uuid": "sample string 13",
      "l1_distributor_name": "sample string 14",
      "l2_distributor_name": "sample string 15",
      "l1_distributor_rebate_rate": 16.0,
      "l2_distributor_rebate_rate": 17.0
    },
    {
      "subscription_text_id": "sample string 1",
      "product_text_id": "sample string 2",
      "device_guid": "sample string 3",
      "quantity": 4,
      "Promotion_code": "sample string 5",
      "discount": 6.0,
      "original_amount": 7.0,
      "real_amount": 8.0,
      "from_date": "sample string 9",
      "to_date": "sample string 10",
      "is_adjusted": true,
      "l1_distributor_uuid": "sample string 12",
      "l2_distributor_uuid": "sample string 13",
      "l1_distributor_name": "sample string 14",
      "l2_distributor_name": "sample string 15",
      "l1_distributor_rebate_rate": 16.0,
      "l2_distributor_rebate_rate": 17.0
    }
  ],
  "plan_change_detail": {
    "from_plan_id": 1,
    "to_plan_id": 2,
    "from_plan_name": "sample string 3",
    "to_plan_name": "sample string 4",
    "total_device_count": 5,
    "old_plan_price": 6.0,
    "new_plan_price": 7.0,
    "from_date": "sample string 8",
    "to_date": "sample string 9",
    "related_subscription_ids": [
      "sample string 1",
      "sample string 2",
      "sample string 3"
    ]
  },
  "is_success": true,
  "error_message": "sample string 12",
  "exception_name": "sample string 13",
  "error_code": 14
}

application/xml, text/xml

Sample:

<InvoiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MMS.RestApi.Entities.Billing">
  <error_code xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">14</error_code>
  <error_message xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">sample string 12</error_message>
  <exception_name xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">sample string 13</exception_name>
  <is_success xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">true</is_success>
  <currency_type>sample string 9</currency_type>
  <description>sample string 2</description>
  <due_to_pay_utc_time>sample string 10</due_to_pay_utc_time>
  <invoice_date>sample string 3</invoice_date>
  <invoice_number>sample string 1</invoice_number>
  <invoice_state>64</invoice_state>
  <invoice_type>64</invoice_type>
  <order_amount>6</order_amount>
  <plan_change_detail>
    <from_date>sample string 8</from_date>
    <from_plan_id>1</from_plan_id>
    <from_plan_name>sample string 3</from_plan_name>
    <new_plan_price>7</new_plan_price>
    <old_plan_price>6</old_plan_price>
    <related_subscription_ids xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
      <d3p1:string>sample string 3</d3p1:string>
    </related_subscription_ids>
    <to_date>sample string 9</to_date>
    <to_plan_id>2</to_plan_id>
    <to_plan_name>sample string 4</to_plan_name>
    <total_device_count>5</total_device_count>
  </plan_change_detail>
  <shipping_amount>8</shipping_amount>
  <subscription_detail>
    <InvoiceDetailItem>
      <Promotion_code>sample string 5</Promotion_code>
      <device_guid>sample string 3</device_guid>
      <discount>6</discount>
      <from_date>sample string 9</from_date>
      <is_adjusted>true</is_adjusted>
      <l1_distributor_name>sample string 14</l1_distributor_name>
      <l1_distributor_rebate_rate>16</l1_distributor_rebate_rate>
      <l1_distributor_uuid>sample string 12</l1_distributor_uuid>
      <l2_distributor_name>sample string 15</l2_distributor_name>
      <l2_distributor_rebate_rate>17</l2_distributor_rebate_rate>
      <l2_distributor_uuid>sample string 13</l2_distributor_uuid>
      <original_amount>7</original_amount>
      <product_text_id>sample string 2</product_text_id>
      <quantity>4</quantity>
      <real_amount>8</real_amount>
      <subscription_text_id>sample string 1</subscription_text_id>
      <to_date>sample string 10</to_date>
    </InvoiceDetailItem>
    <InvoiceDetailItem>
      <Promotion_code>sample string 5</Promotion_code>
      <device_guid>sample string 3</device_guid>
      <discount>6</discount>
      <from_date>sample string 9</from_date>
      <is_adjusted>true</is_adjusted>
      <l1_distributor_name>sample string 14</l1_distributor_name>
      <l1_distributor_rebate_rate>16</l1_distributor_rebate_rate>
      <l1_distributor_uuid>sample string 12</l1_distributor_uuid>
      <l2_distributor_name>sample string 15</l2_distributor_name>
      <l2_distributor_rebate_rate>17</l2_distributor_rebate_rate>
      <l2_distributor_uuid>sample string 13</l2_distributor_uuid>
      <original_amount>7</original_amount>
      <product_text_id>sample string 2</product_text_id>
      <quantity>4</quantity>
      <real_amount>8</real_amount>
      <subscription_text_id>sample string 1</subscription_text_id>
      <to_date>sample string 10</to_date>
    </InvoiceDetailItem>
    <InvoiceDetailItem>
      <Promotion_code>sample string 5</Promotion_code>
      <device_guid>sample string 3</device_guid>
      <discount>6</discount>
      <from_date>sample string 9</from_date>
      <is_adjusted>true</is_adjusted>
      <l1_distributor_name>sample string 14</l1_distributor_name>
      <l1_distributor_rebate_rate>16</l1_distributor_rebate_rate>
      <l1_distributor_uuid>sample string 12</l1_distributor_uuid>
      <l2_distributor_name>sample string 15</l2_distributor_name>
      <l2_distributor_rebate_rate>17</l2_distributor_rebate_rate>
      <l2_distributor_uuid>sample string 13</l2_distributor_uuid>
      <original_amount>7</original_amount>
      <product_text_id>sample string 2</product_text_id>
      <quantity>4</quantity>
      <real_amount>8</real_amount>
      <subscription_text_id>sample string 1</subscription_text_id>
      <to_date>sample string 10</to_date>
    </InvoiceDetailItem>
  </subscription_detail>
  <tax_amount>7</tax_amount>
</InvoiceResponse>