POST Invoice/Create

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CustomerDisplayName	string	None.
CustomerID	string	None.
TotalAmt	decimal number	None.
TotalAmtSpecified	boolean	None.
Balance	decimal number	None.
BalanceSpecified	boolean	None.
lstLineModel	Collection of LineModel	None.
BillingAddress	PhysicalAddress	None.
ShippingAddress	PhysicalAddress	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerDisplayName": "sample string 1",
  "CustomerID": "sample string 2",
  "TotalAmt": 3.0,
  "TotalAmtSpecified": true,
  "Balance": 5.0,
  "BalanceSpecified": true,
  "lstLineModel": [
    {
      "Description": "sample string 1",
      "Amount": 2.0,
      "ItemPrice": 3.0,
      "ItemQty": 4,
      "AmountSpecified": true,
      "DetailType": 0,
      "DetailTypeSpecified": true
    },
    {
      "Description": "sample string 1",
      "Amount": 2.0,
      "ItemPrice": 3.0,
      "ItemQty": 4,
      "AmountSpecified": true,
      "DetailType": 0,
      "DetailTypeSpecified": true
    }
  ],
  "BillingAddress": {
    "idField": "sample string 1",
    "line1Field": "sample string 2",
    "line2Field": "sample string 3",
    "line3Field": "sample string 4",
    "line4Field": "sample string 5",
    "line5Field": "sample string 6",
    "cityField": "sample string 7",
    "countryField": "sample string 8",
    "countryCodeField": "sample string 9",
    "countyField": "sample string 10",
    "countrySubDivisionCodeField": "sample string 11",
    "postalCodeField": "sample string 12",
    "postalCodeSuffixField": "sample string 13",
    "latField": "sample string 14",
    "longField": "sample string 15",
    "tagField": "sample string 16",
    "noteField": "sample string 17"
  },
  "ShippingAddress": {
    "idField": "sample string 1",
    "line1Field": "sample string 2",
    "line2Field": "sample string 3",
    "line3Field": "sample string 4",
    "line4Field": "sample string 5",
    "line5Field": "sample string 6",
    "cityField": "sample string 7",
    "countryField": "sample string 8",
    "countryCodeField": "sample string 9",
    "countyField": "sample string 10",
    "countrySubDivisionCodeField": "sample string 11",
    "postalCodeField": "sample string 12",
    "postalCodeSuffixField": "sample string 13",
    "latField": "sample string 14",
    "longField": "sample string 15",
    "tagField": "sample string 16",
    "noteField": "sample string 17"
  }
}

application/xml, text/xml

Sample:

<InvoiceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QBAPI.Models">
  <Balance>5</Balance>
  <BalanceSpecified>true</BalanceSpecified>
  <BillingAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/Intuit.Ipp.Data">
    <d2p1:cityField>sample string 7</d2p1:cityField>
    <d2p1:countryCodeField>sample string 9</d2p1:countryCodeField>
    <d2p1:countryField>sample string 8</d2p1:countryField>
    <d2p1:countrySubDivisionCodeField>sample string 11</d2p1:countrySubDivisionCodeField>
    <d2p1:countyField>sample string 10</d2p1:countyField>
    <d2p1:idField>sample string 1</d2p1:idField>
    <d2p1:latField>sample string 14</d2p1:latField>
    <d2p1:line1Field>sample string 2</d2p1:line1Field>
    <d2p1:line2Field>sample string 3</d2p1:line2Field>
    <d2p1:line3Field>sample string 4</d2p1:line3Field>
    <d2p1:line4Field>sample string 5</d2p1:line4Field>
    <d2p1:line5Field>sample string 6</d2p1:line5Field>
    <d2p1:longField>sample string 15</d2p1:longField>
    <d2p1:noteField>sample string 17</d2p1:noteField>
    <d2p1:postalCodeField>sample string 12</d2p1:postalCodeField>
    <d2p1:postalCodeSuffixField>sample string 13</d2p1:postalCodeSuffixField>
    <d2p1:tagField>sample string 16</d2p1:tagField>
  </BillingAddress>
  <CustomerDisplayName>sample string 1</CustomerDisplayName>
  <CustomerID>sample string 2</CustomerID>
  <ShippingAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/Intuit.Ipp.Data">
    <d2p1:cityField>sample string 7</d2p1:cityField>
    <d2p1:countryCodeField>sample string 9</d2p1:countryCodeField>
    <d2p1:countryField>sample string 8</d2p1:countryField>
    <d2p1:countrySubDivisionCodeField>sample string 11</d2p1:countrySubDivisionCodeField>
    <d2p1:countyField>sample string 10</d2p1:countyField>
    <d2p1:idField>sample string 1</d2p1:idField>
    <d2p1:latField>sample string 14</d2p1:latField>
    <d2p1:line1Field>sample string 2</d2p1:line1Field>
    <d2p1:line2Field>sample string 3</d2p1:line2Field>
    <d2p1:line3Field>sample string 4</d2p1:line3Field>
    <d2p1:line4Field>sample string 5</d2p1:line4Field>
    <d2p1:line5Field>sample string 6</d2p1:line5Field>
    <d2p1:longField>sample string 15</d2p1:longField>
    <d2p1:noteField>sample string 17</d2p1:noteField>
    <d2p1:postalCodeField>sample string 12</d2p1:postalCodeField>
    <d2p1:postalCodeSuffixField>sample string 13</d2p1:postalCodeSuffixField>
    <d2p1:tagField>sample string 16</d2p1:tagField>
  </ShippingAddress>
  <TotalAmt>3</TotalAmt>
  <TotalAmtSpecified>true</TotalAmtSpecified>
  <lstLineModel>
    <LineModel>
      <Amount>2</Amount>
      <AmountSpecified>true</AmountSpecified>
      <Description>sample string 1</Description>
      <DetailType>PaymentLineDetail</DetailType>
      <DetailTypeSpecified>true</DetailTypeSpecified>
      <ItemPrice>3</ItemPrice>
      <ItemQty>4</ItemQty>
    </LineModel>
    <LineModel>
      <Amount>2</Amount>
      <AmountSpecified>true</AmountSpecified>
      <Description>sample string 1</Description>
      <DetailType>PaymentLineDetail</DetailType>
      <DetailTypeSpecified>true</DetailTypeSpecified>
      <ItemPrice>3</ItemPrice>
      <ItemQty>4</ItemQty>
    </LineModel>
  </lstLineModel>
</InvoiceModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.