POST v2/invoice/detail

Return details of an invoice.

Request Information

URI Parameters

None.

Body Parameters

InvoiceSelectRequest
NameDescriptionTypeAdditional information
Guid

globally unique identifier

None.

Request Formats

application/json, text/json

Sample: 
{
  "Guid": "77011da7-5d36-4348-a02b-dab351a5fce1"
}

application/xml, text/xml

Sample: 
<InvoiceSelectRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Guid>77011da7-5d36-4348-a02b-dab351a5fce1</Guid>
</InvoiceSelectRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'InvoiceSelectRequest'.

Response Information

Resource Description

InvoiceSelectResponse
NameDescriptionTypeAdditional information
GUID

string

None.
InvoiceID

integer

None.
InvoiceNumber

string

None.
InvoiceNumberExt

string

None.
InvoiceStatus

string

None.
InvoiceDate

date

None.
InvoiceDueDate

date

None.
TermsCode

string

None.
InvoiceNote

string

None.
RequestType

string

None.
PurchaseOrderNumber

string

None.
ItemDisplaySetting

string

None.
PaymentStatus

string

None.
PaymentType

string

None.
PaymentSource

string

None.
PaymentBilledDateTime

date

None.
TotalBilledAmount

decimal number

None.
InvoiceTaxAmount

decimal number

None.
AmountReceived

decimal number

None.
PaymentDueAmount

decimal number

None.
Balance

decimal number

None.
DiscountAmount

decimal number

None.
DiscountType

string

None.
CustomerId

integer

None.
ContactId

integer

None.
UserName

string

None.
EmailAddress

string

None.
Phone

string

None.
Extension

string

None.
Company

string

None.
Attn

string

None.
AddressLine1

string

None.
AddressLine2

string

None.
AddressLine3

string

None.
City

string

None.
StateCode

string

None.
ZipCode

string

None.
Country

string

None.
SubTotal

decimal number

None.
ServiceTotal

decimal number

None.
PostageTotal

decimal number

None.
ServiceTaxTotal

decimal number

None.
PostageTaxTotal

decimal number

None.
InvoiceLine

Collection of InvoiceLineSelectResponse

None.
isLinkedItemModified

boolean

None.
Title

string

None.
Note

string

None.
ShowClosedOrders

boolean

None.
InvoiceTaxAdvanceDetail

InvoiceTaxAdvanceDetailModel

None.

Response Formats

application/json, text/json

Sample: 
{
  "GUID": "sample string 1",
  "InvoiceID": 2,
  "InvoiceNumber": "sample string 3",
  "InvoiceNumberExt": "sample string 4",
  "InvoiceStatus": "sample string 5",
  "InvoiceDate": "2025-08-30T17:47:00.5839611+00:00",
  "InvoiceDueDate": "2025-08-30T17:47:00.5839611+00:00",
  "TermsCode": "sample string 6",
  "InvoiceNote": "sample string 7",
  "RequestType": "sample string 8",
  "PurchaseOrderNumber": "sample string 9",
  "ItemDisplaySetting": "sample string 10",
  "PaymentStatus": "sample string 11",
  "PaymentType": "sample string 12",
  "PaymentSource": "sample string 13",
  "PaymentBilledDateTime": "2025-08-30T17:47:00.5849647+00:00",
  "TotalBilledAmount": 14.0,
  "InvoiceTaxAmount": 15.0,
  "AmountReceived": 16.0,
  "PaymentDueAmount": 17.0,
  "Balance": 18.0,
  "DiscountAmount": 19.0,
  "DiscountType": "sample string 20",
  "CustomerId": 21,
  "ContactId": 22,
  "UserName": "sample string 23",
  "EmailAddress": "sample string 24",
  "Phone": "sample string 25",
  "Extension": "sample string 26",
  "Company": "sample string 27",
  "Attn": "sample string 28",
  "AddressLine1": "sample string 29",
  "AddressLine2": "sample string 30",
  "AddressLine3": "sample string 31",
  "City": "sample string 32",
  "StateCode": "sample string 33",
  "ZipCode": "sample string 34",
  "Country": "sample string 35",
  "SubTotal": 36.0,
  "ServiceTotal": 37.0,
  "PostageTotal": 38.0,
  "ServiceTaxTotal": 39.0,
  "PostageTaxTotal": 40.0,
  "InvoiceLine": [
    {
      "InvoiceLineID": 1,
      "InvoiceID": 2,
      "ParentInvoiceLineID": 1,
      "OrderID": 3,
      "InvoiceLineType": "sample string 4",
      "Title": "sample string 5",
      "Priority": 6,
      "Quantity": 7.0,
      "Rate": 8.0,
      "AmountBilled": 9.0,
      "PreviouslyInvoiced": 10.0,
      "PreviouslyInvoicedBalance": 11.0,
      "InitialTotal": 12.0,
      "Note": "sample string 13",
      "bNoteVisible": true,
      "DisplayItem": true,
      "LineSubTotal": 16.0,
      "Tax": 17.0,
      "ItemId": 18,
      "ItemType": "sample string 19",
      "LineType": "sample string 20",
      "TempInvoiceLineID": 21,
      "InvoiceLineGuid": "3eb75b10-7775-4be0-a6e1-8bab0f37e1c0",
      "ParentInvoiceLineGuid": "8c00ca13-255d-4552-b97a-921331b4bd61",
      "InvoiceLineItem": [
        {
          "InvoiceLineItemID": 1,
          "InvoiceID": 2,
          "InvoiceLineID": 3,
          "OrderID": 4,
          "OrderVersionID": 5,
          "OrderVersionDetailID": 6,
          "ServiceID": 7,
          "InvoiceLineDetailType": "sample string 8",
          "Quantity": 9.0,
          "Amount": 10.0,
          "Tax": 11.0,
          "AccountingGLID": "sample string 12",
          "PaymentAccountID": 13,
          "OrderVersionPostageID": 14,
          "AmountApplied": 15.0,
          "DisplayItem": true,
          "PreviouslyInvoiced": 17.0,
          "PreviouslyInvoicedBalance": 18.0,
          "InitialTotal": 19.0
        },
        {
          "InvoiceLineItemID": 1,
          "InvoiceID": 2,
          "InvoiceLineID": 3,
          "OrderID": 4,
          "OrderVersionID": 5,
          "OrderVersionDetailID": 6,
          "ServiceID": 7,
          "InvoiceLineDetailType": "sample string 8",
          "Quantity": 9.0,
          "Amount": 10.0,
          "Tax": 11.0,
          "AccountingGLID": "sample string 12",
          "PaymentAccountID": 13,
          "OrderVersionPostageID": 14,
          "AmountApplied": 15.0,
          "DisplayItem": true,
          "PreviouslyInvoiced": 17.0,
          "PreviouslyInvoicedBalance": 18.0,
          "InitialTotal": 19.0
        }
      ],
      "ParentObjectType": "sample string 23",
      "ParentObjectID": 24,
      "IsMerged": true,
      "GroupBilling": {
        "UnitMeasureCode": "sample string 1",
        "UnitName": "sample string 2"
      }
    },
    {
      "InvoiceLineID": 1,
      "InvoiceID": 2,
      "ParentInvoiceLineID": 1,
      "OrderID": 3,
      "InvoiceLineType": "sample string 4",
      "Title": "sample string 5",
      "Priority": 6,
      "Quantity": 7.0,
      "Rate": 8.0,
      "AmountBilled": 9.0,
      "PreviouslyInvoiced": 10.0,
      "PreviouslyInvoicedBalance": 11.0,
      "InitialTotal": 12.0,
      "Note": "sample string 13",
      "bNoteVisible": true,
      "DisplayItem": true,
      "LineSubTotal": 16.0,
      "Tax": 17.0,
      "ItemId": 18,
      "ItemType": "sample string 19",
      "LineType": "sample string 20",
      "TempInvoiceLineID": 21,
      "InvoiceLineGuid": "3eb75b10-7775-4be0-a6e1-8bab0f37e1c0",
      "ParentInvoiceLineGuid": "8c00ca13-255d-4552-b97a-921331b4bd61",
      "InvoiceLineItem": [
        {
          "InvoiceLineItemID": 1,
          "InvoiceID": 2,
          "InvoiceLineID": 3,
          "OrderID": 4,
          "OrderVersionID": 5,
          "OrderVersionDetailID": 6,
          "ServiceID": 7,
          "InvoiceLineDetailType": "sample string 8",
          "Quantity": 9.0,
          "Amount": 10.0,
          "Tax": 11.0,
          "AccountingGLID": "sample string 12",
          "PaymentAccountID": 13,
          "OrderVersionPostageID": 14,
          "AmountApplied": 15.0,
          "DisplayItem": true,
          "PreviouslyInvoiced": 17.0,
          "PreviouslyInvoicedBalance": 18.0,
          "InitialTotal": 19.0
        },
        {
          "InvoiceLineItemID": 1,
          "InvoiceID": 2,
          "InvoiceLineID": 3,
          "OrderID": 4,
          "OrderVersionID": 5,
          "OrderVersionDetailID": 6,
          "ServiceID": 7,
          "InvoiceLineDetailType": "sample string 8",
          "Quantity": 9.0,
          "Amount": 10.0,
          "Tax": 11.0,
          "AccountingGLID": "sample string 12",
          "PaymentAccountID": 13,
          "OrderVersionPostageID": 14,
          "AmountApplied": 15.0,
          "DisplayItem": true,
          "PreviouslyInvoiced": 17.0,
          "PreviouslyInvoicedBalance": 18.0,
          "InitialTotal": 19.0
        }
      ],
      "ParentObjectType": "sample string 23",
      "ParentObjectID": 24,
      "IsMerged": true,
      "GroupBilling": {
        "UnitMeasureCode": "sample string 1",
        "UnitName": "sample string 2"
      }
    }
  ],
  "isLinkedItemModified": true,
  "Title": "sample string 42",
  "Note": "sample string 43",
  "ShowClosedOrders": true,
  "InvoiceTaxAdvanceDetail": {
    "calculationRunId": "sample string 1",
    "taxEngineName": "sample string 2",
    "itemDetails": [
      {
        "itemNumber": "sample string 1",
        "invoiceId": 2,
        "invoiceNumber": "sample string 3",
        "invoiceLineItemId": 4,
        "objectId": 5,
        "objectType": "sample string 6",
        "taxCode": "sample string 7",
        "taxSurtaxCap": 1.1,
        "taxable": true,
        "taxRate": 9.0,
        "taxablePercent": 10.0,
        "lineSubTotal": 11.1,
        "taxableLineSubTotal": 12.1,
        "calculatedTaxAmount": 13.1,
        "surtaxCapLimit": 1.1,
        "surtaxCapApplied": true
      },
      {
        "itemNumber": "sample string 1",
        "invoiceId": 2,
        "invoiceNumber": "sample string 3",
        "invoiceLineItemId": 4,
        "objectId": 5,
        "objectType": "sample string 6",
        "taxCode": "sample string 7",
        "taxSurtaxCap": 1.1,
        "taxable": true,
        "taxRate": 9.0,
        "taxablePercent": 10.0,
        "lineSubTotal": 11.1,
        "taxableLineSubTotal": 12.1,
        "calculatedTaxAmount": 13.1,
        "surtaxCapLimit": 1.1,
        "surtaxCapApplied": true
      }
    ]
  }
}

application/xml, text/xml

Sample: 
<InvoiceSelectResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <GUID>sample string 1</GUID>
  <InvoiceID>2</InvoiceID>
  <InvoiceNumber>sample string 3</InvoiceNumber>
  <InvoiceNumberExt>sample string 4</InvoiceNumberExt>
  <InvoiceStatus>sample string 5</InvoiceStatus>
  <InvoiceDate>2025-08-30T17:47:00.5839611+00:00</InvoiceDate>
  <InvoiceDueDate>2025-08-30T17:47:00.5839611+00:00</InvoiceDueDate>
  <TermsCode>sample string 6</TermsCode>
  <InvoiceNote>sample string 7</InvoiceNote>
  <RequestType>sample string 8</RequestType>
  <PurchaseOrderNumber>sample string 9</PurchaseOrderNumber>
  <ItemDisplaySetting>sample string 10</ItemDisplaySetting>
  <PaymentStatus>sample string 11</PaymentStatus>
  <PaymentType>sample string 12</PaymentType>
  <PaymentSource>sample string 13</PaymentSource>
  <PaymentBilledDateTime>2025-08-30T17:47:00.5849647+00:00</PaymentBilledDateTime>
  <TotalBilledAmount>14</TotalBilledAmount>
  <InvoiceTaxAmount>15</InvoiceTaxAmount>
  <AmountReceived>16</AmountReceived>
  <PaymentDueAmount>17</PaymentDueAmount>
  <Balance>18</Balance>
  <DiscountAmount>19</DiscountAmount>
  <DiscountType>sample string 20</DiscountType>
  <CustomerId>21</CustomerId>
  <ContactId>22</ContactId>
  <UserName>sample string 23</UserName>
  <EmailAddress>sample string 24</EmailAddress>
  <Phone>sample string 25</Phone>
  <Extension>sample string 26</Extension>
  <Company>sample string 27</Company>
  <Attn>sample string 28</Attn>
  <AddressLine1>sample string 29</AddressLine1>
  <AddressLine2>sample string 30</AddressLine2>
  <AddressLine3>sample string 31</AddressLine3>
  <City>sample string 32</City>
  <StateCode>sample string 33</StateCode>
  <ZipCode>sample string 34</ZipCode>
  <Country>sample string 35</Country>
  <SubTotal>36</SubTotal>
  <ServiceTotal>37</ServiceTotal>
  <PostageTotal>38</PostageTotal>
  <ServiceTaxTotal>39</ServiceTaxTotal>
  <PostageTaxTotal>40</PostageTaxTotal>
  <InvoiceLine>
    <InvoiceLineSelectResponse>
      <InvoiceLineID>1</InvoiceLineID>
      <InvoiceID>2</InvoiceID>
      <ParentInvoiceLineID>1</ParentInvoiceLineID>
      <OrderID>3</OrderID>
      <InvoiceLineType>sample string 4</InvoiceLineType>
      <Title>sample string 5</Title>
      <Priority>6</Priority>
      <Quantity>7</Quantity>
      <Rate>8</Rate>
      <AmountBilled>9</AmountBilled>
      <PreviouslyInvoiced>10</PreviouslyInvoiced>
      <PreviouslyInvoicedBalance>11</PreviouslyInvoicedBalance>
      <InitialTotal>12</InitialTotal>
      <Note>sample string 13</Note>
      <bNoteVisible>true</bNoteVisible>
      <DisplayItem>true</DisplayItem>
      <LineSubTotal>16</LineSubTotal>
      <Tax>17</Tax>
      <ItemId>18</ItemId>
      <ItemType>sample string 19</ItemType>
      <LineType>sample string 20</LineType>
      <TempInvoiceLineID>21</TempInvoiceLineID>
      <InvoiceLineGuid>3eb75b10-7775-4be0-a6e1-8bab0f37e1c0</InvoiceLineGuid>
      <ParentInvoiceLineGuid>8c00ca13-255d-4552-b97a-921331b4bd61</ParentInvoiceLineGuid>
      <InvoiceLineItem>
        <InvoiceLineItemSelectResponse>
          <InvoiceLineItemID>1</InvoiceLineItemID>
          <InvoiceID>2</InvoiceID>
          <InvoiceLineID>3</InvoiceLineID>
          <OrderID>4</OrderID>
          <OrderVersionID>5</OrderVersionID>
          <OrderVersionDetailID>6</OrderVersionDetailID>
          <ServiceID>7</ServiceID>
          <InvoiceLineDetailType>sample string 8</InvoiceLineDetailType>
          <Quantity>9</Quantity>
          <Amount>10</Amount>
          <Tax>11</Tax>
          <AccountingGLID>sample string 12</AccountingGLID>
          <PaymentAccountID>13</PaymentAccountID>
          <OrderVersionPostageID>14</OrderVersionPostageID>
          <AmountApplied>15</AmountApplied>
          <DisplayItem>true</DisplayItem>
          <PreviouslyInvoiced>17</PreviouslyInvoiced>
          <PreviouslyInvoicedBalance>18</PreviouslyInvoicedBalance>
          <InitialTotal>19</InitialTotal>
        </InvoiceLineItemSelectResponse>
        <InvoiceLineItemSelectResponse>
          <InvoiceLineItemID>1</InvoiceLineItemID>
          <InvoiceID>2</InvoiceID>
          <InvoiceLineID>3</InvoiceLineID>
          <OrderID>4</OrderID>
          <OrderVersionID>5</OrderVersionID>
          <OrderVersionDetailID>6</OrderVersionDetailID>
          <ServiceID>7</ServiceID>
          <InvoiceLineDetailType>sample string 8</InvoiceLineDetailType>
          <Quantity>9</Quantity>
          <Amount>10</Amount>
          <Tax>11</Tax>
          <AccountingGLID>sample string 12</AccountingGLID>
          <PaymentAccountID>13</PaymentAccountID>
          <OrderVersionPostageID>14</OrderVersionPostageID>
          <AmountApplied>15</AmountApplied>
          <DisplayItem>true</DisplayItem>
          <PreviouslyInvoiced>17</PreviouslyInvoiced>
          <PreviouslyInvoicedBalance>18</PreviouslyInvoicedBalance>
          <InitialTotal>19</InitialTotal>
        </InvoiceLineItemSelectResponse>
      </InvoiceLineItem>
      <ParentObjectType>sample string 23</ParentObjectType>
      <ParentObjectID>24</ParentObjectID>
      <IsMerged>true</IsMerged>
      <GroupBilling>
        <UnitMeasureCode>sample string 1</UnitMeasureCode>
        <UnitName>sample string 2</UnitName>
      </GroupBilling>
    </InvoiceLineSelectResponse>
    <InvoiceLineSelectResponse>
      <InvoiceLineID>1</InvoiceLineID>
      <InvoiceID>2</InvoiceID>
      <ParentInvoiceLineID>1</ParentInvoiceLineID>
      <OrderID>3</OrderID>
      <InvoiceLineType>sample string 4</InvoiceLineType>
      <Title>sample string 5</Title>
      <Priority>6</Priority>
      <Quantity>7</Quantity>
      <Rate>8</Rate>
      <AmountBilled>9</AmountBilled>
      <PreviouslyInvoiced>10</PreviouslyInvoiced>
      <PreviouslyInvoicedBalance>11</PreviouslyInvoicedBalance>
      <InitialTotal>12</InitialTotal>
      <Note>sample string 13</Note>
      <bNoteVisible>true</bNoteVisible>
      <DisplayItem>true</DisplayItem>
      <LineSubTotal>16</LineSubTotal>
      <Tax>17</Tax>
      <ItemId>18</ItemId>
      <ItemType>sample string 19</ItemType>
      <LineType>sample string 20</LineType>
      <TempInvoiceLineID>21</TempInvoiceLineID>
      <InvoiceLineGuid>3eb75b10-7775-4be0-a6e1-8bab0f37e1c0</InvoiceLineGuid>
      <ParentInvoiceLineGuid>8c00ca13-255d-4552-b97a-921331b4bd61</ParentInvoiceLineGuid>
      <InvoiceLineItem>
        <InvoiceLineItemSelectResponse>
          <InvoiceLineItemID>1</InvoiceLineItemID>
          <InvoiceID>2</InvoiceID>
          <InvoiceLineID>3</InvoiceLineID>
          <OrderID>4</OrderID>
          <OrderVersionID>5</OrderVersionID>
          <OrderVersionDetailID>6</OrderVersionDetailID>
          <ServiceID>7</ServiceID>
          <InvoiceLineDetailType>sample string 8</InvoiceLineDetailType>
          <Quantity>9</Quantity>
          <Amount>10</Amount>
          <Tax>11</Tax>
          <AccountingGLID>sample string 12</AccountingGLID>
          <PaymentAccountID>13</PaymentAccountID>
          <OrderVersionPostageID>14</OrderVersionPostageID>
          <AmountApplied>15</AmountApplied>
          <DisplayItem>true</DisplayItem>
          <PreviouslyInvoiced>17</PreviouslyInvoiced>
          <PreviouslyInvoicedBalance>18</PreviouslyInvoicedBalance>
          <InitialTotal>19</InitialTotal>
        </InvoiceLineItemSelectResponse>
        <InvoiceLineItemSelectResponse>
          <InvoiceLineItemID>1</InvoiceLineItemID>
          <InvoiceID>2</InvoiceID>
          <InvoiceLineID>3</InvoiceLineID>
          <OrderID>4</OrderID>
          <OrderVersionID>5</OrderVersionID>
          <OrderVersionDetailID>6</OrderVersionDetailID>
          <ServiceID>7</ServiceID>
          <InvoiceLineDetailType>sample string 8</InvoiceLineDetailType>
          <Quantity>9</Quantity>
          <Amount>10</Amount>
          <Tax>11</Tax>
          <AccountingGLID>sample string 12</AccountingGLID>
          <PaymentAccountID>13</PaymentAccountID>
          <OrderVersionPostageID>14</OrderVersionPostageID>
          <AmountApplied>15</AmountApplied>
          <DisplayItem>true</DisplayItem>
          <PreviouslyInvoiced>17</PreviouslyInvoiced>
          <PreviouslyInvoicedBalance>18</PreviouslyInvoicedBalance>
          <InitialTotal>19</InitialTotal>
        </InvoiceLineItemSelectResponse>
      </InvoiceLineItem>
      <ParentObjectType>sample string 23</ParentObjectType>
      <ParentObjectID>24</ParentObjectID>
      <IsMerged>true</IsMerged>
      <GroupBilling>
        <UnitMeasureCode>sample string 1</UnitMeasureCode>
        <UnitName>sample string 2</UnitName>
      </GroupBilling>
    </InvoiceLineSelectResponse>
  </InvoiceLine>
  <isLinkedItemModified>true</isLinkedItemModified>
  <Title>sample string 42</Title>
  <Note>sample string 43</Note>
  <ShowClosedOrders>true</ShowClosedOrders>
  <InvoiceTaxAdvanceDetail>
    <calculationRunId>sample string 1</calculationRunId>
    <taxEngineName>sample string 2</taxEngineName>
    <itemDetails>
      <TaxItemDetail>
        <itemId>sample string 1</itemId>
        <invoiceId>2</invoiceId>
        <invoiceNumber>sample string 3</invoiceNumber>
        <invoiceLineItemId>4</invoiceLineItemId>
        <objectId>5</objectId>
        <objectType>sample string 6</objectType>
        <taxCode>sample string 7</taxCode>
        <taxSurtaxCap>1.1</taxSurtaxCap>
        <taxable>true</taxable>
        <taxRate>9</taxRate>
        <taxablePercent>10</taxablePercent>
        <lineSubTotal>11.1</lineSubTotal>
        <taxableLineSubTotal>12.1</taxableLineSubTotal>
        <calculatedTaxAmount>13.1</calculatedTaxAmount>
        <surtaxCapLimit>1.1</surtaxCapLimit>
        <surtaxCapApplied>true</surtaxCapApplied>
      </TaxItemDetail>
      <TaxItemDetail>
        <itemId>sample string 1</itemId>
        <invoiceId>2</invoiceId>
        <invoiceNumber>sample string 3</invoiceNumber>
        <invoiceLineItemId>4</invoiceLineItemId>
        <objectId>5</objectId>
        <objectType>sample string 6</objectType>
        <taxCode>sample string 7</taxCode>
        <taxSurtaxCap>1.1</taxSurtaxCap>
        <taxable>true</taxable>
        <taxRate>9</taxRate>
        <taxablePercent>10</taxablePercent>
        <lineSubTotal>11.1</lineSubTotal>
        <taxableLineSubTotal>12.1</taxableLineSubTotal>
        <calculatedTaxAmount>13.1</calculatedTaxAmount>
        <surtaxCapLimit>1.1</surtaxCapLimit>
        <surtaxCapApplied>true</surtaxCapApplied>
      </TaxItemDetail>
    </itemDetails>
  </InvoiceTaxAdvanceDetail>
</InvoiceSelectResponse>