SOAP API – GetInvoices

GetInvoices( username ) : ViewInvoice[]

Since: EngageIP v25.2

Returns the list of a user's invoices, or throws an exception if the user does not exist.

This method returns an array of ViewInvoice objects. An invoice object consists of the following properties:

ID (Integer) - The unique ID for the invoice
UserID (Integer) - The ID of the user for whom the invoices belong
Name (String) - Invoice name as defined by invoice numbering rules, otherwise identical to ID. For more details see Invoice Numbering
Date (DateTime) - Signifies the beginning of the billing period for which the invoice applies
InvoiceDate (DateTime) -Signifies the beginning of the billing period for which the invoice applies
DueDate (DateTime) -The date payment for the invoice is expected by. See Configuring the Due Date on Invoices
LastCheckedDate (DateTime) - Field used for payment terms checking
ProcessedDate (DateTime) - The date the invoice was rendered
User (String) - Username of the invoicer
UserStatus (String) - The text representation of the user's current status
BillGroupID (Double) - The ID of the bill group for which this invoice belongs
BillGroup (String) - The name of the bill group associated with the BillGroupID
Balance (Double) - Total of any unpaid charges from previous invoices in addition to the charges on this invoice
Total (Double) - The total value of the invoice
InvoiceStatusTypeID (Integer) - The ID associated with the invoice status type
InvoiceStatusType (String) - The name of the status associated with the InvoiceStatusTypeID
InvoiceID (Integer) - The unique ID for the invoice
BillRunHistoryID (Integer) - The unique ID indicating which bill run created the invoice
SentDate (DateTime) - Date the invoice was sent to the recipient
PreviousAccountBalance (Double) - Any unpaid balance from previous invoices
AccountBalance (Double) - Amount currently held in this account
CreatedDate (DateTime) - The date this invoice was created
ClosedDate (DateTime) - The date the invoice was closed
Voiding_InvoiceID (Integer) - The invoice that contains the reversals for the chargers if the invocie was voided, otherwise null
Void (String) - The message indicating if the invoice is void or the voiding invoice, otherwise null. See Invoices - Closing, Voiding, Emailing, Rendering
Invoice (String) - The invoice name
Charge (Double) - Total of any unpaid charges from previous invoices in addition to the charges on this invoice
Tax (Double) - Total of taxes for the invoice
Discount (Double) - Total of any discounts offered on services
PaymentDisbursement (Double) - Total payments disbursed during the invoice's billing period
StatementDetailsCredit (Double) -Total of any credits applied to the account balance (dispersed) during the invoice's billing period
CreditsIssued (Double) - Total credits issued to the account during the billing period
StatusTypeID (Integer) - The ID associated with this invoice's status type
PaymentIssued (Double) - The total of payment's issued during the billing period

Parameters:

username (String) - The user for whom to retrieve the list of invoices. An exception will be thrown if the user name does not exist.

Returns:

An array of ViewInvoice objects representing invoices for the specified user

Possible Exceptions:

INVALID USERNAME

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /adminportal/webservice.asmx HTTP/1.1
Host: demo.logisense.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap12:Header>
  <soap12:Body>
    <GetInvoices xmlns="Logisense_EngageIP">
      <username>string</username>
    </GetInvoices>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetInvoicesResponse xmlns="Logisense_EngageIP">
      <GetInvoicesResult>
        <ViewInvoice>
          <ID>int</ID>
          <UserID>int</UserID>
          <Name>string</Name>
          <Date>dateTime</Date>
          <InvoiceDate>dateTime</InvoiceDate>
          <DueDate>dateTime</DueDate>
          <LastCheckedDate>dateTime</LastCheckedDate>
          <User>string</User>
          <UserStatus>string</UserStatus>
          <BillGroup>string</BillGroup>
          <Balance>double</Balance>
          <Total>double</Total>
          <InvoiceStatusTypeID>int</InvoiceStatusTypeID>
          <ProcessedDate>dateTime</ProcessedDate>
          <InvoiceStatusType>string</InvoiceStatusType>
          <InvoiceID>int</InvoiceID>
          <BillRunHistoryID>int</BillRunHistoryID>
          <SentDate>dateTime</SentDate>
          <PreviousAccountBalance>double</PreviousAccountBalance>
          <AccountBalance>double</AccountBalance>
          <CreatedDate>dateTime</CreatedDate>
          <ClosedDate>dateTime</ClosedDate>
          <Voiding_InvoiceID>int</Voiding_InvoiceID>
          <Voided_InvoiceID>int</Voided_InvoiceID>
          <Void>string</Void>
          <Invoice>string</Invoice>
          <Charge>double</Charge>
          <Tax>double</Tax>
          <Discount>double</Discount>
          <PaymentDisbursement>double</PaymentDisbursement>
          <StatementDetailsCredit>double</StatementDetailsCredit>
          <CreditsIssued>double</CreditsIssued>
          <BillGroupID>int</BillGroupID>
          <StatusTypeID>int</StatusTypeID>
          <PaymentIssued>double</PaymentIssued>
        </ViewInvoice>
        <ViewInvoice>
          <ID>int</ID>
          <UserID>int</UserID>
          <Name>string</Name>
          <Date>dateTime</Date>
          <InvoiceDate>dateTime</InvoiceDate>
          <DueDate>dateTime</DueDate>
          <LastCheckedDate>dateTime</LastCheckedDate>
          <User>string</User>
          <UserStatus>string</UserStatus>
          <BillGroup>string</BillGroup>
          <Balance>double</Balance>
          <Total>double</Total>
          <InvoiceStatusTypeID>int</InvoiceStatusTypeID>
          <ProcessedDate>dateTime</ProcessedDate>
          <InvoiceStatusType>string</InvoiceStatusType>
          <InvoiceID>int</InvoiceID>
          <BillRunHistoryID>int</BillRunHistoryID>
          <SentDate>dateTime</SentDate>
          <PreviousAccountBalance>double</PreviousAccountBalance>
          <AccountBalance>double</AccountBalance>
          <CreatedDate>dateTime</CreatedDate>
          <ClosedDate>dateTime</ClosedDate>
          <Voiding_InvoiceID>int</Voiding_InvoiceID>
          <Voided_InvoiceID>int</Voided_InvoiceID>
          <Void>string</Void>
          <Invoice>string</Invoice>
          <Charge>double</Charge>
          <Tax>double</Tax>
          <Discount>double</Discount>
          <PaymentDisbursement>double</PaymentDisbursement>
          <StatementDetailsCredit>double</StatementDetailsCredit>
          <CreditsIssued>double</CreditsIssued>
          <BillGroupID>int</BillGroupID>
          <StatusTypeID>int</StatusTypeID>
          <PaymentIssued>double</PaymentIssued>
        </ViewInvoice>
      </GetInvoicesResult>
    </GetInvoicesResponse>
  </soap12:Body>
</soap12:Envelope>

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /adminportal/webservice.asmx HTTP/1.1
Host: demo.logisense.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Logisense_EngageIP/GetInvoices"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap:Header>
  <soap:Body>
    <GetInvoices xmlns="Logisense_EngageIP">
      <username>string</username>
    </GetInvoices>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetInvoicesResponse xmlns="Logisense_EngageIP">
      <GetInvoicesResult>
        <ViewInvoice>
          <ID>int</ID>
          <UserID>int</UserID>
          <Name>string</Name>
          <Date>dateTime</Date>
          <InvoiceDate>dateTime</InvoiceDate>
          <DueDate>dateTime</DueDate>
          <LastCheckedDate>dateTime</LastCheckedDate>
          <User>string</User>
          <UserStatus>string</UserStatus>
          <BillGroup>string</BillGroup>
          <Balance>double</Balance>
          <Total>double</Total>
          <InvoiceStatusTypeID>int</InvoiceStatusTypeID>
          <ProcessedDate>dateTime</ProcessedDate>
          <InvoiceStatusType>string</InvoiceStatusType>
          <InvoiceID>int</InvoiceID>
          <BillRunHistoryID>int</BillRunHistoryID>
          <SentDate>dateTime</SentDate>
          <PreviousAccountBalance>double</PreviousAccountBalance>
          <AccountBalance>double</AccountBalance>
          <CreatedDate>dateTime</CreatedDate>
          <ClosedDate>dateTime</ClosedDate>
          <Voiding_InvoiceID>int</Voiding_InvoiceID>
          <Voided_InvoiceID>int</Voided_InvoiceID>
          <Void>string</Void>
          <Invoice>string</Invoice>
          <Charge>double</Charge>
          <Tax>double</Tax>
          <Discount>double</Discount>
          <PaymentDisbursement>double</PaymentDisbursement>
          <StatementDetailsCredit>double</StatementDetailsCredit>
          <CreditsIssued>double</CreditsIssued>
          <BillGroupID>int</BillGroupID>
          <StatusTypeID>int</StatusTypeID>
          <PaymentIssued>double</PaymentIssued>
        </ViewInvoice>
        <ViewInvoice>
          <ID>int</ID>
          <UserID>int</UserID>
          <Name>string</Name>
          <Date>dateTime</Date>
          <InvoiceDate>dateTime</InvoiceDate>
          <DueDate>dateTime</DueDate>
          <LastCheckedDate>dateTime</LastCheckedDate>
          <User>string</User>
          <UserStatus>string</UserStatus>
          <BillGroup>string</BillGroup>
          <Balance>double</Balance>
          <Total>double</Total>
          <InvoiceStatusTypeID>int</InvoiceStatusTypeID>
          <ProcessedDate>dateTime</ProcessedDate>
          <InvoiceStatusType>string</InvoiceStatusType>
          <InvoiceID>int</InvoiceID>
          <BillRunHistoryID>int</BillRunHistoryID>
          <SentDate>dateTime</SentDate>
          <PreviousAccountBalance>double</PreviousAccountBalance>
          <AccountBalance>double</AccountBalance>
          <CreatedDate>dateTime</CreatedDate>
          <ClosedDate>dateTime</ClosedDate>
          <Voiding_InvoiceID>int</Voiding_InvoiceID>
          <Voided_InvoiceID>int</Voided_InvoiceID>
          <Void>string</Void>
          <Invoice>string</Invoice>
          <Charge>double</Charge>
          <Tax>double</Tax>
          <Discount>double</Discount>
          <PaymentDisbursement>double</PaymentDisbursement>
          <StatementDetailsCredit>double</StatementDetailsCredit>
          <CreditsIssued>double</CreditsIssued>
          <BillGroupID>int</BillGroupID>
          <StatusTypeID>int</StatusTypeID>
          <PaymentIssued>double</PaymentIssued>
        </ViewInvoice>
      </GetInvoicesResult>
    </GetInvoicesResponse>
  </soap:Body>
</soap:Envelope>