GET api/vendors/{vendorId}/entities
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| vendorId |
|
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of EntityOpenInvoiceResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Id |
integer |
None. |
| Name |
Name |
string |
None. |
| EntityNumber |
Entity Number |
string |
None. |
| SuperEntityNumber |
Super Entity Number |
integer |
None. |
| Active |
Is Active |
boolean |
None. |
| HasOpenInvoices |
Entity has open invoice with Vendor |
boolean |
None. |
| ManagementCompanyDetail |
ManagementCompany |
ManagementCompanyResponse |
None. |
| DefaultMemberConfig |
|
IMemberConfiguration |
None. |
| ConstructorMappingEnabled |
|
boolean |
None. |
| ProfileName |
|
string |
None. |
| AllowNullDestinationValues |
|
boolean |
None. |
| AllowNullCollections |
|
boolean |
None. |
| EnableNullPropagationForQueryMapping |
|
boolean |
None. |
| ShouldMapProperty |
|
FuncOfPropertyInfoAndBoolean |
None. |
| ShouldMapField |
|
FuncOfFieldInfoAndBoolean |
None. |
| ShouldMapMethod |
|
FuncOfMethodInfoAndBoolean |
None. |
| ShouldUseConstructor |
|
FuncOfConstructorInfoAndBoolean |
None. |
| SourceMemberNamingConvention |
|
INamingConvention |
None. |
| DestinationMemberNamingConvention |
|
INamingConvention |
None. |
| ValueTransformers |
|
Collection of ValueTransformerConfiguration |
None. |
Response Formats
application/json, text/json
[
{
"id": 1,
"name": "sample string 2",
"entityNumber": "sample string 3",
"superEntityNumber": 4,
"active": true,
"hasOpenInvoices": true,
"managementCompanyDetail": {
"managementCompanyId": 1,
"companyName": "sample string 2",
"companyDescription": "sample string 3"
},
"defaultMemberConfig": {
"nameMapper": {
"getMembers": {},
"namedMappers": [
{
"methodCaseSensitive": false
},
{},
{
"prefixes": [
"Get"
],
"postfixes": [],
"destinationPrefixes": [],
"destinationPostfixes": []
}
]
},
"memberMappers": [
{
"nameMapper": {
"getMembers": {},
"namedMappers": [
{
"methodCaseSensitive": false
},
{},
{
"prefixes": [
"Get"
],
"postfixes": [],
"destinationPrefixes": [],
"destinationPostfixes": []
}
]
}
},
{
"sourceMemberNamingConvention": {
"splittingExpression": {
"pattern": "(\\p{Lu}+(?=$|\\p{Lu}[\\p{Ll}0-9])|\\p{Lu}?[\\p{Ll}0-9]+)",
"options": 0
},
"separatorCharacter": ""
},
"destinationMemberNamingConvention": {
"splittingExpression": {
"pattern": "(\\p{Lu}+(?=$|\\p{Lu}[\\p{Ll}0-9])|\\p{Lu}?[\\p{Ll}0-9]+)",
"options": 0
},
"separatorCharacter": ""
}
}
]
},
"constructorMappingEnabled": null,
"profileName": "CamAcctApi.Controllers.Vendors.Models.EntityOpenInvoiceResponse",
"allowNullDestinationValues": true,
"allowNullCollections": true,
"enableNullPropagationForQueryMapping": true,
"shouldMapProperty": null,
"shouldMapField": null,
"shouldMapMethod": null,
"shouldUseConstructor": null,
"sourceMemberNamingConvention": null,
"destinationMemberNamingConvention": null,
"valueTransformers": []
},
{
"id": 1,
"name": "sample string 2",
"entityNumber": "sample string 3",
"superEntityNumber": 4,
"active": true,
"hasOpenInvoices": true,
"managementCompanyDetail": {
"managementCompanyId": 1,
"companyName": "sample string 2",
"companyDescription": "sample string 3"
},
"defaultMemberConfig": {
"nameMapper": {
"getMembers": {},
"namedMappers": [
{
"methodCaseSensitive": false
},
{},
{
"prefixes": [
"Get"
],
"postfixes": [],
"destinationPrefixes": [],
"destinationPostfixes": []
}
]
},
"memberMappers": [
{
"nameMapper": {
"getMembers": {},
"namedMappers": [
{
"methodCaseSensitive": false
},
{},
{
"prefixes": [
"Get"
],
"postfixes": [],
"destinationPrefixes": [],
"destinationPostfixes": []
}
]
}
},
{
"sourceMemberNamingConvention": {
"splittingExpression": {
"pattern": "(\\p{Lu}+(?=$|\\p{Lu}[\\p{Ll}0-9])|\\p{Lu}?[\\p{Ll}0-9]+)",
"options": 0
},
"separatorCharacter": ""
},
"destinationMemberNamingConvention": {
"splittingExpression": {
"pattern": "(\\p{Lu}+(?=$|\\p{Lu}[\\p{Ll}0-9])|\\p{Lu}?[\\p{Ll}0-9]+)",
"options": 0
},
"separatorCharacter": ""
}
}
]
},
"constructorMappingEnabled": null,
"profileName": "CamAcctApi.Controllers.Vendors.Models.EntityOpenInvoiceResponse",
"allowNullDestinationValues": true,
"allowNullCollections": true,
"enableNullPropagationForQueryMapping": true,
"shouldMapProperty": null,
"shouldMapField": null,
"shouldMapMethod": null,
"shouldUseConstructor": null,
"sourceMemberNamingConvention": null,
"destinationMemberNamingConvention": null,
"valueTransformers": []
}
]
application/xml, text/xml
<ArrayOfEntityOpenInvoiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.Controllers.Vendors.Models">
<EntityOpenInvoiceResponse>
<AllowNullCollections xmlns="http://schemas.datacontract.org/2004/07/AutoMapper">true</AllowNullCollections>
<AllowNullDestinationValues xmlns="http://schemas.datacontract.org/2004/07/AutoMapper">true</AllowNullDestinationValues>
<DestinationMemberNamingConvention i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/AutoMapper" />
<EnableNullPropagationForQueryMapping xmlns="http://schemas.datacontract.org/2004/07/AutoMapper">true</EnableNullPropagationForQueryMapping>
<ShouldMapField xmlns:d3p1="http://schemas.datacontract.org/2004/07/System" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/AutoMapper" />
<ShouldMapMethod xmlns:d3p1="http://schemas.datacontract.org/2004/07/System" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/AutoMapper" />
<ShouldMapProperty xmlns:d3p1="http://schemas.datacontract.org/2004/07/System" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/AutoMapper" />
<ShouldUseConstructor xmlns:d3p1="http://schemas.datacontract.org/2004/07/System" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/AutoMapper" />
<SourceMemberNamingConvention i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/AutoMapper" />
<ValueTransformers xmlns="http://schemas.datacontract.org/2004/07/AutoMapper" />
<Active>true</Active>
<EntityNumber>sample string 3</EntityNumber>
<HasOpenInvoices>true</HasOpenInvoices>
<Id>1</Id>
<ManagementCompanyDetail>
<CompanyDescription>sample string 3</CompanyDescription>
<CompanyName>sample string 2</CompanyName>
<ManagementCompanyId>1</ManagementCompanyId>
</ManagementCompanyDetail>
<Name>sample string 2</Name>
<SuperEntityNumber>4</SuperEntityNumber>
</EntityOpenInvoiceResponse>
<EntityOpenInvoiceResponse>
<AllowNullCollections xmlns="http://schemas.datacontract.org/2004/07/AutoMapper">true</AllowNullCollections>
<AllowNullDestinationValues xmlns="http://schemas.datacontract.org/2004/07/AutoMapper">true</AllowNullDestinationValues>
<DestinationMemberNamingConvention i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/AutoMapper" />
<EnableNullPropagationForQueryMapping xmlns="http://schemas.datacontract.org/2004/07/AutoMapper">true</EnableNullPropagationForQueryMapping>
<ShouldMapField xmlns:d3p1="http://schemas.datacontract.org/2004/07/System" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/AutoMapper" />
<ShouldMapMethod xmlns:d3p1="http://schemas.datacontract.org/2004/07/System" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/AutoMapper" />
<ShouldMapProperty xmlns:d3p1="http://schemas.datacontract.org/2004/07/System" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/AutoMapper" />
<ShouldUseConstructor xmlns:d3p1="http://schemas.datacontract.org/2004/07/System" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/AutoMapper" />
<SourceMemberNamingConvention i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/AutoMapper" />
<ValueTransformers xmlns="http://schemas.datacontract.org/2004/07/AutoMapper" />
<Active>true</Active>
<EntityNumber>sample string 3</EntityNumber>
<HasOpenInvoices>true</HasOpenInvoices>
<Id>1</Id>
<ManagementCompanyDetail>
<CompanyDescription>sample string 3</CompanyDescription>
<CompanyName>sample string 2</CompanyName>
<ManagementCompanyId>1</ManagementCompanyId>
</ManagementCompanyDetail>
<Name>sample string 2</Name>
<SuperEntityNumber>4</SuperEntityNumber>
</EntityOpenInvoiceResponse>
</ArrayOfEntityOpenInvoiceResponse>