Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name

Data Type

Required?

Default Value

Discussion

StartDate

date

no


Search for invoices issued on or after this date

EndDate

date

no


Search for invoices issued on or before this date

SearchString

string(100)

no


Searches for all or part of invoice number, client name, client code, engagement name, engagement code, project name, project code.

InvoiceNumber

string(100)

no


Enter one or more invoice numbers, separated by commas

IncludeDraftInvoicesFlag

boolean

no

false

Set to true to include invoices currently in the Draft state

IncludeApprovedInvoicesFlag

boolean

no

false

Set to true to include invoices currently in the Approved (but not issued) state

IncludeIssuedInvoicesFlagbooleannotrueSet to true to include invoices currently in the Issued state.
IncludePostFailedInvoicesFlagbooleannotrueSet to true to include invoices currently in the Post Failed state.
IncludeSentInvoicesFlagbooleannotrueSet to true to include invoices currently in the Sent state.
IncludeSendFailedInvoicesFlagbooleannotrueSet to true to include invoices currently in the Send Failed state.
IncludePaidInvoicesFlagbooleannotrueSet to true to include invoices currently in the Paid state.
IncludeOverdueInvoicesFlagbooleannotrueSet to true to include invoices currently in the overdue state.
SuppressInvoiceDetailsFlagbooleannofalseSet to true to include suppress invoice detail information. This can reduce the execution time and payload size dramatically in situations where you don't need the full details of each invoice.


Response

If the invoice exists, then the following data is returned:

...