POST api/Invoice

Retrieve a list of invoices for user

Request Information

URI Parameters

None.

Body Parameters

InvoiceParm
NameDescriptionTypeAdditional information
auth

Authorization token

 string

None.
PostDate

Retrieve invoices after this posting date (yyyy-MM-dd)

 string

None.
OrderNumber

Retrieve invoice for this order number (shipment number or tracking number)

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "OrderNumber": "sample string 3",
  "PostDate": "sample string 2",
  "auth": "sample string 1"
}

application/xml, text/xml

Sample: 
<InvoiceParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
  <OrderNumber>sample string 3</OrderNumber>
  <PostDate>sample string 2</PostDate>
  <auth>sample string 1</auth>
</InvoiceParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

InvoiceResp
NameDescriptionTypeAdditional 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: 
{
  "ErrorMessage": "sample string 2",
  "Invoices": [
    {
      "Amount": 5,
      "Balance": 8,
      "CurrencyID": "sample string 9",
      "FileData": "sample string 11",
      "FileName": "sample string 12",
      "InvoiceDueDate": "2024-09-21T18:57:40.121-07:00",
      "InvoiceFormID": 10,
      "InvoiceGUID": "sample string 1",
      "InvoiceNumber": 2,
      "InvoicePostDate": "2024-09-21T18:57:40.121-07:00",
      "PayoffDate": "2024-09-21T18:57:40.121-07:00",
      "TaxAmount": 6,
      "TotalAmount": 7
    },
    {
      "Amount": 5,
      "Balance": 8,
      "CurrencyID": "sample string 9",
      "FileData": "sample string 11",
      "FileName": "sample string 12",
      "InvoiceDueDate": "2024-09-21T18:57:40.121-07:00",
      "InvoiceFormID": 10,
      "InvoiceGUID": "sample string 1",
      "InvoiceNumber": 2,
      "InvoicePostDate": "2024-09-21T18:57:40.121-07:00",
      "PayoffDate": "2024-09-21T18:57:40.121-07:00",
      "TaxAmount": 6,
      "TotalAmount": 7
    }
  ],
  "IsSuccessful": true
}

application/xml, text/xml

Sample: 
<InvoiceResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.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-21T18:57:40.1217234-07:00</InvoiceDueDate>
      <InvoiceFormID>10</InvoiceFormID>
      <InvoiceGUID>sample string 1</InvoiceGUID>
      <InvoiceNumber>2</InvoiceNumber>
      <InvoicePostDate>2024-09-21T18:57:40.1217234-07:00</InvoicePostDate>
      <PayoffDate>2024-09-21T18:57:40.1217234-07: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-21T18:57:40.1217234-07:00</InvoiceDueDate>
      <InvoiceFormID>10</InvoiceFormID>
      <InvoiceGUID>sample string 1</InvoiceGUID>
      <InvoiceNumber>2</InvoiceNumber>
      <InvoicePostDate>2024-09-21T18:57:40.1217234-07:00</InvoicePostDate>
      <PayoffDate>2024-09-21T18:57:40.1217234-07:00</PayoffDate>
      <TaxAmount>6</TaxAmount>
      <TotalAmount>7</TotalAmount>
    </InvoiceItem>
  </Invoices>
  <IsSuccessful>true</IsSuccessful>
</InvoiceResp>