GET V3/odata/Company({key})
Gets Company entity by key
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| key |
CompanyId from Company entity |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
QicsUnity.Api.Areas.V3.Models.Company| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyId |
Gets or sets CompanyId |
integer |
Required 64-bit signed integer |
| Name |
Gets or sets name |
string |
Required |
| Code |
Gets or sets code |
string |
Required |
| CurrencyId |
Gets or sets CurrencyId |
integer |
Required 64-bit signed integer |
| InvoiceLanguage |
Gets or sets InvoiceLanguage |
QicsUnity.Api.Areas.V3.Models.LanguageType |
Required |
| InvoiceLayoutId |
Gets or sets InvoiceLayoutId |
integer |
64-bit signed integer Nullable |
| InvoiceNumberLength |
Gets or sets the length of generated part of invoice number for invoices being processed for this company |
integer | |
| InvoiceNumberPrefix |
Gets or sets the prefix for invoice number of invoices being processed for this company |
string | |
| PriceIndex |
Gets or sets price index |
decimal number |
Required |
| InvoiceNumberCounter |
Gets or sets the value of invoice number that will be assigned to next invoice processed for this company |
integer | |
| XsltInvoiceProcessingBatchContent |
Gets or sets the content of a invoice processing batch XSLT file |
Collection of byte | |
| VatAmountSumMode |
Gets or sets mode of VAT amount calculation of invoices for current company |
QicsUnity.Api.Areas.V3.Models.VatAmountSumMode |
Nullable |
| DefaultInvoiceSendMethod |
Gets or sets default invoice send method type |
QicsUnity.Api.Areas.V3.Models.InvoiceSendMethodType |
Nullable |
| ContactPerson |
Gets or sets ContactPerson |
string | |
| Address1 |
Gets or sets Address1 |
string | |
| Address2 |
Gets or sets Address2 |
string | |
| Address3 |
Gets or sets Address3 |
string | |
| ZipCode |
Gets or sets ZipCode |
string | |
| City |
Gets or sets City |
string | |
| County |
Gets or sets County |
string | |
| Country |
Gets or sets Country |
string | |
| CountryCode |
Gets or sets CountryCode |
string | |
| EmailAddress |
Gets or sets EmailAddress |
string | |
| PhoneNumber1 |
Gets or sets PhoneNumber1 |
string | |
| PhoneNumber2 |
Gets or sets PhoneNumber2 |
string | |
| BankAccount |
Gets or sets BankAccount |
string | |
| BankIdentificationCode |
Gets or sets BankIdentificationCode |
string | |
| ChamberOfCommerceNumber |
Gets or sets ChamberOfCommerceNumber |
string | |
| Identification |
Gets or sets Identification |
string | |
| LegalEntityCode |
Gets or sets LegalEntityCode (supported values: any 4 digit number) |
string | |
| LegalEntity |
Gets or sets LegalEntity (supported values: NL:KVK, NL:OIN, NL:BTW, 0106-NL:KVK, 9954-NL:OIN, 0190-NL:OIN, 9944-NL:BTW, Other) |
string | |
| VatNumber |
Gets or sets VatNumber |
string | |
| IsMutationReasonMandatoryOnInvoice |
Gets or sets a value indicating whether mutation reason is mandatory on invoice |
boolean | |
| OnlinePaymentProvider |
Gets or sets online payment provider |
QicsUnity.Api.Areas.V3.Models.OnlinePaymentProvider |
Nullable |
| MollieOAuthUserId |
Gets or sets MollieOAuthUserId |
integer |
64-bit signed integer Nullable |
| MollieProfileId |
Gets or sets MollieProfileId |
string | |
| MollieProfileName |
Gets or sets MollieProfileName |
string | |
| MolliePaymentExpiresAfterDays |
Gets or sets MolliePaymentExpiresAfterDays |
integer |
Nullable |
Response Formats
application/json, text/json, application/scim+json
{
"CompanyId": "1",
"Name": "sample 2",
"Code": "sample 3",
"CurrencyId": "4",
"InvoiceLanguage": "English",
"InvoiceLayoutId": "1",
"InvoiceNumberLength": "5",
"InvoiceNumberPrefix": "sample 6",
"PriceIndex": "7",
"InvoiceNumberCounter": "8",
"XsltInvoiceProcessingBatchContent": "QEA=",
"VatAmountSumMode": "RoundInvoiceLines",
"DefaultInvoiceSendMethod": "Manual",
"ContactPerson": "sample 9",
"Address1": "sample 10",
"Address2": "sample 11",
"Address3": "sample 12",
"ZipCode": "sample 13",
"City": "sample 14",
"County": "sample 15",
"Country": "sample 16",
"CountryCode": "sample 17",
"EmailAddress": "sample 18",
"PhoneNumber1": "sample 19",
"PhoneNumber2": "sample 20",
"BankAccount": "sample 21",
"BankIdentificationCode": "sample 22",
"ChamberOfCommerceNumber": "sample 23",
"Identification": "sample 24",
"LegalEntityCode": "sample 25",
"LegalEntity": "sample 26",
"VatNumber": "sample 27",
"IsMutationReasonMandatoryOnInvoice": true,
"OnlinePaymentProvider": "None",
"MollieOAuthUserId": "1",
"MollieProfileId": "sample 29",
"MollieProfileName": "sample 30",
"MolliePaymentExpiresAfterDays": "1"
}
application/xml, text/xml
<Company xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QicsUnity.Api.Areas.V3.Models"> <Address1>sample 10</Address1> <Address2>sample 11</Address2> <Address3>sample 12</Address3> <BankAccount>sample 21</BankAccount> <BankIdentificationCode>sample 22</BankIdentificationCode> <ChamberOfCommerceNumber>sample 23</ChamberOfCommerceNumber> <City>sample 14</City> <Code>sample 3</Code> <CompanyId>1</CompanyId> <ContactPerson>sample 9</ContactPerson> <Country>sample 16</Country> <CountryCode>sample 17</CountryCode> <County>sample 15</County> <CurrencyId>4</CurrencyId> <DefaultInvoiceSendMethod>Manual</DefaultInvoiceSendMethod> <EmailAddress>sample 18</EmailAddress> <Identification>sample 24</Identification> <InvoiceLanguage>English</InvoiceLanguage> <InvoiceLayoutId>1</InvoiceLayoutId> <InvoiceNumberCounter>8</InvoiceNumberCounter> <InvoiceNumberLength>5</InvoiceNumberLength> <InvoiceNumberPrefix>sample 6</InvoiceNumberPrefix> <IsMutationReasonMandatoryOnInvoice>true</IsMutationReasonMandatoryOnInvoice> <LegalEntity>sample 26</LegalEntity> <LegalEntityCode>sample 25</LegalEntityCode> <MollieOAuthUserId>1</MollieOAuthUserId> <MolliePaymentExpiresAfterDays>1</MolliePaymentExpiresAfterDays> <MollieProfileId>sample 29</MollieProfileId> <MollieProfileName>sample 30</MollieProfileName> <Name>sample 2</Name> <OnlinePaymentProvider>None</OnlinePaymentProvider> <PhoneNumber1>sample 19</PhoneNumber1> <PhoneNumber2>sample 20</PhoneNumber2> <PriceIndex>7</PriceIndex> <VatAmountSumMode>RoundInvoiceLines</VatAmountSumMode> <VatNumber>sample 27</VatNumber> <XsltInvoiceProcessingBatchContent>QEA=</XsltInvoiceProcessingBatchContent> <ZipCode>sample 13</ZipCode> </Company>