GET Clients/Order/Initialize
Get empty clientOrder
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientID | integer |
None. |
|
| ClientName | NameDTO |
None. |
|
| FunderID | integer |
None. |
|
| FunderName | string |
None. |
|
| BusinessUnitID | integer |
None. |
|
| BusinessUnitName | string |
None. |
|
| IncludeBinaries | boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
Empty ClientOrderDTO
ClientOrderDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientOrderID |
Client Order ID |
integer |
None. |
| ClientID |
Client ID |
integer |
None. |
| FunderID |
Funder ID |
integer |
None. |
| Funder |
Funder |
FunderDTO |
None. |
| BUID |
BUID |
integer |
None. |
| GLCode |
GL Code |
string |
None. |
| IsClientOrderDemographicsEnabled |
Is Client Order Demographics Enabled |
boolean |
None. |
| SortOrder |
Sort Order |
integer |
None. |
| StartDate |
Start Date |
date |
None. |
| StopDate |
Stop Date |
date |
None. |
| Description |
Description |
string |
None. |
| Comments |
Comments |
string |
None. |
| ReceivedDate |
Received Date |
date |
None. |
| ContractEndDate |
Contract Date |
date |
None. |
| RecordState |
Record State |
RecordState |
None. |
| Created |
Created |
AuditDataDTO |
None. |
| LastUpdated |
Last Updated |
AuditDataDTO |
None. |
| FunderBusinessUnit |
Funder |
FunderBusinessUnitDTO |
None. |
| EntityUserChangeEntityID |
Entity User Change Entity ID |
integer |
None. |
| Extensions |
Extensions attached to client order |
Collection of FormDataExtensionDto |
None. |
| Frequencies |
Client Order Frequencies |
Collection of ClientOrderFrequencyDTO |
None. |
| BusinessUnitName |
Business Unit Name |
string |
None. |
| ClientName |
Client Name |
NameDTO |
None. |
| ClientBirthDate |
Client Birth Date |
date |
None. |
| SettleAmount |
Settle Amount |
decimal number |
None. |
| Invoices |
list of client order invoices |
Collection of ClientOrderInvoiceDTO |
None. |
| AnyClientOrderBillingRates |
Has Client Order Billing Rate |
boolean |
None. |
| EntryDate |
Entry Date |
date |
None. |
| DepartureWeekEndingDate |
Departure Week Ending Date |
date |
None. |
| GroupStartDateUTC |
Group start Date UTC to convert to BU Time |
date |
None. |
| SumInvoiceOutstandingAmount |
Outstanding amount for reviewed invoices |
decimal number |
None. |