GET Invoices/Invoice
Get Invoice from criteria
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| IncludeItems | boolean |
None. |
|
| Invoices | Collection of integer |
None. |
|
| InvoicesToExclude | Collection of integer |
None. |
|
| InvoiceBatchID | integer |
None. |
|
| InvoiceBatches | Collection of integer |
None. |
|
| BusinessUnits | Collection of integer |
None. |
|
| BusinessUnitNames | Collection of string |
None. |
|
| Entities | Collection of integer |
None. |
|
| EntityName | string |
None. |
|
| Clients | Collection of integer |
None. |
|
| ClientName | NameDTO |
None. |
|
| Funders | Collection of integer |
None. |
|
| FundersToExclude | Collection of integer |
None. |
|
| FunderNames | Collection of string |
None. |
|
| ClientOrders | Collection of integer |
None. |
|
| ClientOrderBillingRateIDs | Collection of integer |
None. |
|
| Groups | Collection of integer |
None. |
|
| GroupNames | Collection of string |
None. |
|
| Fields | Collection of FindExtensionCriteria |
None. |
|
| InvoiceNumbers | Collection of string |
None. |
|
| InvoiceDateMin | date |
None. |
|
| InvoiceDateMax | date |
None. |
|
| DueDateMin | date |
None. |
|
| DueDateMax | date |
None. |
|
| InvoiceStatuses | Collection of InvoiceStatus |
None. |
|
| TotalAmountMin | decimal number |
None. |
|
| TotalAmountMax | decimal number |
None. |
|
| ExpectedAmountMin | decimal number |
None. |
|
| ExpectedAmountMax | decimal number |
None. |
|
| OutstandingAmountMin | decimal number |
None. |
|
| OutstandingAmountMax | decimal number |
None. |
|
| OutstandingOnly | boolean |
None. |
|
| OutstandingItemsOnly | boolean |
None. |
|
| InvoiceStartDateMin | date |
None. |
|
| InvoiceStartDateMax | date |
None. |
|
| InvoiceStopDateMin | date |
None. |
|
| InvoiceStopDateMax | date |
None. |
|
| AuthorizationNumber | string |
None. |
|
| InvoiceHash | string |
None. |
|
| BillingCodes | Collection of string |
None. |
|
| BillingRateIDs | Collection of integer |
None. |
|
| SubTypes | Collection of integer |
None. |
|
| Props | Collection of Object |
None. |
|
| Skip | integer |
None. |
|
| Limit | integer |
None. |
|
| Sort | Collection of FindSortByCriteria |
None. |
|
| ExcludeDischargedDeceased | boolean |
None. |
|
| InvoiceCreationType | InvoiceCreationType |
None. |
|
| IncludeInvoiceItemDetails | boolean |
None. |
|
| IncludeJournalItemProperties | boolean |
None. |
|
| IncludeResidentNumber | boolean |
None. |
|
| IncludeActive |
Include records where RecordState == RecordState.Active |
boolean |
None. |
| IncludeInactive |
Include records where RecordState == RecordState.Inactive |
boolean |
None. |
| IncludeDeleted |
Include records where RecordState == RecordState.Deleted |
boolean |
None. |
| IncludeError |
Include records where RecordState == RecordState.CreatedInError |
boolean |
None. |
| CreatedDateUtcMin |
Filter by CreatedDateUtcMin |
date |
None. |
| CreatedDateUtcMax |
Filter by CreatedDateUtcMax |
date |
None. |
| LastUpdatedDateUtcMin |
Filter by LastUpdatedDateUtcMin |
date |
None. |
| LastUpdatedDateUtcMax |
Filter by LastUpdatedDateUtcMax |
date |
None. |
| Match |
When searching by string, include records based on match type |
MatchCriteriaStringType |
None. |
Body Parameters
None.
Response Information
Resource Description
List of InvoiceDTOs
IHttpActionResultNone.