Request Information
Update contact. Partial update is also possible.
Example URL:
v2.0/Contacts/{id}
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Contact Id |
integer |
Required |
| id |
Contact Id |
integer |
Required |
Contact entity for update
ContactPatchApiModel| Name | Description | Type | Additional information |
|---|---|---|---|
| City | string |
Length: between 0 and 50 inclusive |
|
| CompanyName | string |
Required Length: between 0 and 200 inclusive |
|
| CountryId | integer |
None. |
|
| DefaultBankAccount | BankAccountPutApiModel |
None. |
|
| DefaultInvoiceMaturity | integer |
None. |
|
| DiscountPercentage | decimal number |
None. |
|
| string |
Data type: EmailAddress Length: between 0 and 254 inclusive |
||
| Fax | string |
Length: between 0 and 20 inclusive |
|
| Firstname | string |
Length: between 0 and 50 inclusive |
|
| Id |
Resource identifier |
integer |
Readonly |
| IdentificationNumber | string |
Length: between 0 and 20 inclusive |
|
| IsSendReminder | boolean |
None. |
|
| Mobile | string |
Length: between 0 and 20 inclusive |
|
| Phone | string |
Data type: PhoneNumber Length: between 0 and 20 inclusive |
|
| PostalCode | string |
Length: between 0 and 11 inclusive |
|
| Street | string |
Length: between 0 and 100 inclusive |
|
| Surname | string |
Length: between 0 and 50 inclusive |
|
| Title | string |
Length: between 0 and 50 inclusive |
|
| VatIdentificationNumber | string |
Length: between 0 and 20 inclusive |
|
| VatIdentificationNumberSk | string |
Length: between 0 and 20 inclusive Used in Sk legislation. |
|
| Www | string |
Length: between 0 and 50 inclusive |
{
"DefaultInvoiceMaturity": 1,
"City": "sample string 1",
"CompanyName": "sample string 2",
"CountryId": 3,
"DefaultBankAccount": {
"AccountNumber": "sample string 1",
"BankId": 1,
"CurrencyId": 1,
"Iban": "sample string 2",
"Name": "sample string 3",
"Swift": "sample string 4",
"Id": 5
},
"DiscountPercentage": 1.0,
"Email": "sample string 4",
"Fax": "sample string 5",
"Firstname": "sample string 6",
"IdentificationNumber": "sample string 7",
"IsSendReminder": true,
"Mobile": "sample string 8",
"Phone": "sample string 9",
"PostalCode": "sample string 10",
"Street": "sample string 11",
"Surname": "sample string 12",
"Title": "sample string 13",
"VatIdentificationNumber": "sample string 14",
"VatIdentificationNumberSk": "sample string 15",
"Www": "sample string 16",
"Id": 17
}
<ContactPatchApiModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.PatchModels">
<Id xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">17</Id>
<Links xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Links>
<City xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">sample string 1</City>
<CompanyName xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">sample string 2</CompanyName>
<CountryId xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">3</CountryId>
<DefaultBankAccount xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">
<Id xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">5</Id>
<Links xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 1</d3p1:Key>
<d3p1:Value>sample string 2</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</Links>
<AccountNumber>sample string 1</AccountNumber>
<BankId>1</BankId>
<CurrencyId>1</CurrencyId>
<Iban>sample string 2</Iban>
<Name>sample string 3</Name>
<Swift>sample string 4</Swift>
</DefaultBankAccount>
<DiscountPercentage xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">1</DiscountPercentage>
<Email xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">sample string 4</Email>
<Fax xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">sample string 5</Fax>
<Firstname xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">sample string 6</Firstname>
<IdentificationNumber xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">sample string 7</IdentificationNumber>
<IsSendReminder xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">true</IsSendReminder>
<Mobile xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">sample string 8</Mobile>
<Phone xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">sample string 9</Phone>
<PostalCode xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">sample string 10</PostalCode>
<Street xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">sample string 11</Street>
<Surname xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">sample string 12</Surname>
<Title xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">sample string 13</Title>
<VatIdentificationNumber xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">sample string 14</VatIdentificationNumber>
<VatIdentificationNumberSk xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">sample string 15</VatIdentificationNumberSk>
<Www xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">sample string 16</Www>
<DefaultInvoiceMaturity>1</DefaultInvoiceMaturity>
</ContactPatchApiModel>
Response Information
| Name | Description | Type | Additional information |
|---|---|---|---|
| AddressIdg |
Identification of the contact for Money software |
globally unique identifier |
Only used in the Money system. Readonly |
| City | string |
Length: between 0 and 50 inclusive |
|
| CompanyName | string |
Required Length: between 0 and 200 inclusive |
|
| CountryId | integer |
Required |
|
| CreditCheck | CreditCheckStatusDoklad |
iDoklad does not use CreditCheck anymore. The returned value is not up to date. Readonly |
|
| DateLastChange | date |
Data type: DateTime Readonly |
|
| DefaultBankAccount | BankAccountApiModel |
Readonly |
|
| DefaultInvoiceMaturity | integer |
None. |
|
| DiscountPercentage | decimal number |
None. |
|
| string |
Data type: EmailAddress Length: between 0 and 254 inclusive |
||
| Fax | string |
Length: between 0 and 20 inclusive |
|
| Firstname | string |
Length: between 0 and 50 inclusive |
|
| Id | integer |
Readonly |
|
| IdentificationNumber | string |
Length: between 0 and 20 inclusive |
|
| IsRegisteredForVatOnPay |
Attribute for application of VAT based on payments |
boolean |
Used in Sk legislation. |
| IsSendReminder | boolean |
None. |
|
| Mobile | string |
Length: between 0 and 20 inclusive |
|
| Phone | string |
Data type: PhoneNumber Length: between 0 and 20 inclusive |
|
| PostalCode | string |
Length: between 0 and 11 inclusive |
|
| Street | string |
Length: between 0 and 100 inclusive |
|
| Surname | string |
Length: between 0 and 50 inclusive |
|
| Title | string |
Length: between 0 and 50 inclusive |
|
| VatIdentificationNumber | string |
Length: between 0 and 20 inclusive |
|
| VatIdentificationNumberSk | string |
Length: between 0 and 20 inclusive Used in Sk legislation. |
|
| Www | string |
Length: between 0 and 50 inclusive |
{
"AddressIdg": "13c666e9-2eac-4624-a4a0-ae73fbce71e5",
"CreditCheck": 0,
"DateLastChange": "2025-11-14T02:38:19.4798118+00:00",
"DefaultBankAccount": {
"Bank": {
"Code": "sample string 1",
"Country": {
"Code": "sample string 1",
"Currency": {
"Code": "sample string 1",
"Country": "sample string 2",
"Name": "sample string 3",
"Priority": 4,
"Symbol": "sample string 5",
"Id": 6
},
"CurrencyId": 2,
"DateLastChange": "2025-11-14T02:38:19.4798118+00:00",
"Name": "sample string 4",
"NameEnglish": "sample string 5",
"IsEuMember": true,
"Id": 7
},
"CountryId": 2,
"DateLastChange": "2025-11-14T02:38:19.4798118+00:00",
"Name": "sample string 4",
"NumberCode": "sample string 5",
"Swift": "sample string 6",
"IsOutOfDate": true,
"Id": 8
},
"Currency": {
"Code": "sample string 1",
"Country": "sample string 2",
"Name": "sample string 3",
"Priority": 4,
"Symbol": "sample string 5",
"Id": 6
},
"DateLastChange": "2025-11-14T02:38:19.4798118+00:00",
"IsDefault": true,
"CurrencyId": 3,
"AccountNumber": "sample string 4",
"BankId": 1,
"Iban": "sample string 5",
"Name": "sample string 6",
"Swift": "sample string 7",
"Id": 8
},
"Id": 3,
"CompanyName": "sample string 4",
"CountryId": 5,
"IsRegisteredForVatOnPay": true,
"DefaultInvoiceMaturity": 1,
"City": "sample string 7",
"DiscountPercentage": 1.0,
"Email": "sample string 8",
"Fax": "sample string 9",
"Firstname": "sample string 10",
"IdentificationNumber": "sample string 11",
"IsSendReminder": true,
"Mobile": "sample string 12",
"Phone": "sample string 13",
"PostalCode": "sample string 14",
"Street": "sample string 15",
"Surname": "sample string 16",
"Title": "sample string 17",
"VatIdentificationNumber": "sample string 18",
"VatIdentificationNumberSk": "sample string 19",
"Www": "sample string 20"
}
Sample not available.
Sample not available.