GET api/Invoice/Detail/{UserGUID}/{InvoiceNumber}

Retrieve the details for an invoice including file data

Request Information

URI Parameters

Name	Description	Type	Additional information
UserGUID	Unique user authorization token	string	Required
InvoiceNumber	Invoice identifier	integer	Required

Body Parameters

None.

Response Information

Resource Description

InvoiceResp

Name	Description	Type	Additional information
IsSuccessful	Used to determine if method call was successful (true) or failure (false)	boolean	None.
ErrorMessage	The error message if method call was not successful	string	None.
Invoices	List of invoice	Collection of InvoiceItem	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "Invoices": [
    {
      "InvoiceGUID": "sample string 1",
      "InvoiceNumber": 2,
      "InvoicePostDate": "2024-09-19T09:17:37.3185963+00:00",
      "InvoiceDueDate": "2024-09-19T09:17:37.3185963+00:00",
      "Amount": 5.0,
      "TaxAmount": 6.0,
      "TotalAmount": 7.0,
      "Balance": 8.0,
      "PayoffDate": "2024-09-19T09:17:37.3185963+00:00",
      "CurrencyID": "sample string 9",
      "InvoiceFormID": 10,
      "FileData": "sample string 11",
      "FileName": "sample string 12"
    },
    {
      "InvoiceGUID": "sample string 1",
      "InvoiceNumber": 2,
      "InvoicePostDate": "2024-09-19T09:17:37.3185963+00:00",
      "InvoiceDueDate": "2024-09-19T09:17:37.3185963+00:00",
      "Amount": 5.0,
      "TaxAmount": 6.0,
      "TotalAmount": 7.0,
      "Balance": 8.0,
      "PayoffDate": "2024-09-19T09:17:37.3185963+00:00",
      "CurrencyID": "sample string 9",
      "InvoiceFormID": 10,
      "FileData": "sample string 11",
      "FileName": "sample string 12"
    }
  ]
}

application/xml, text/xml

Sample:

<InvoiceResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Shipper1.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Invoices>
    <InvoiceItem>
      <Amount>5</Amount>
      <Balance>8</Balance>
      <CurrencyID>sample string 9</CurrencyID>
      <FileData>sample string 11</FileData>
      <FileName>sample string 12</FileName>
      <InvoiceDueDate>2024-09-19T09:17:37.3185963+00:00</InvoiceDueDate>
      <InvoiceFormID>10</InvoiceFormID>
      <InvoiceGUID>sample string 1</InvoiceGUID>
      <InvoiceNumber>2</InvoiceNumber>
      <InvoicePostDate>2024-09-19T09:17:37.3185963+00:00</InvoicePostDate>
      <PayoffDate>2024-09-19T09:17:37.3185963+00:00</PayoffDate>
      <TaxAmount>6</TaxAmount>
      <TotalAmount>7</TotalAmount>
    </InvoiceItem>
    <InvoiceItem>
      <Amount>5</Amount>
      <Balance>8</Balance>
      <CurrencyID>sample string 9</CurrencyID>
      <FileData>sample string 11</FileData>
      <FileName>sample string 12</FileName>
      <InvoiceDueDate>2024-09-19T09:17:37.3185963+00:00</InvoiceDueDate>
      <InvoiceFormID>10</InvoiceFormID>
      <InvoiceGUID>sample string 1</InvoiceGUID>
      <InvoiceNumber>2</InvoiceNumber>
      <InvoicePostDate>2024-09-19T09:17:37.3185963+00:00</InvoicePostDate>
      <PayoffDate>2024-09-19T09:17:37.3185963+00:00</PayoffDate>
      <TaxAmount>6</TaxAmount>
      <TotalAmount>7</TotalAmount>
    </InvoiceItem>
  </Invoices>
  <IsSuccessful>true</IsSuccessful>
</InvoiceResp>