POST {culture}/api/ExAddressBook

IMPORTANT NOTE: Depending on your integration strategy, you may choose to map some of ID-s to your system ID-s (e.g. car categories, offices, equipment, pricelists). If you do that, please note that ID-s WILL BE DIFFERENT ON PRODUCTION AND TEST ENVIRONMENTS, so you should make it easily configurable on your side.

Adds new address book entry to the system

Request Information

URI Parameters

Name	Description	Type	Additional information
culture		string	None.

Body Parameters

ExAddressBookInModel

Name	Description	Type	Additional information
AddressBook_CompanyTypes	Address book company types entry constents	Collection of ExAddressBook_CompanyTypeModel	None.
AddressBook_Consents	Address book entry constents	Collection of ExAddressBook_ConsentModel	None.
AddressBook_Pricelists	Address book entry car pricelists	Collection of ExAddressBook_PricelistModel	None.
AddressBookAddresses	Address book entry addresses	Collection of ExAddressBookAddressModel	None.
AddressBookOriginId	Address book origin identifier	integer	None.
AddressBookPhones	Address book entry phone numbers	Collection of ExAddressBookPhoneModel	None.
AddressBookTypeId	Address book type identifier	integer	Required
AgencyFleetAvailabilityLimit	Agency fleet availability limit	decimal number	None.
AgencyPaysTruePeriod	Agency pays true period	boolean	None.
AgencyReservationTimeAdvanceInHours	Agency reservation time advance in hours	integer	None.
AllowB2CAccess	Has access to B2C portal	boolean	Required
BillingCurrencyId	Billing currency identifier	integer	None.
BillingDelayInDays	Billing delay in days	integer	Required
BlackListReason	Black list reason	string	None.
Code	Code	string	None.
Commission	Commission	decimal number	None.
CompanyTypeId	Company type identifier	integer	None.
CreateInvoiceUponCarIssue	Automatically create an invoice for agency on open contracts	boolean	None.
DateOfBirth	Date of birth. UTC representation in ISO 8601 format.	date	None.
DoNotFiscalizeFinanceDocuments	Do not fiscalize finance documents	boolean	None.
EInvoiceTypeId	E-invoice type identifier	integer	None.
Email	Email	string	None.
Email2	Email 2	string	None.
EmployeeOfficeId	Employee office identifier	integer	None.
GenderId	Gender identifier	integer	None.
IBAN	IBAN	string	None.
IdentificationNumber	Identification number	string	None.
IdVersionNumber	Identifier version number	string	None.
InternalRevenueServiceCode	Internal revenue service code	string	None.
IsActive	Is active or not	boolean	None.
IsAgency	Is agency or not	boolean	Required
IsAgent	Is agent or not	boolean	Required
IsAnonymized	Is anonymized or not	boolean	None.
IsArtisan	Is artisan or not	boolean	Required
IsEmployee	Is employee or not	boolean	Required
IsForeigner	Is foreigner or not	boolean	Required
IsOnBlackList	Is on black list	boolean	None.
IsOrderReferenceRequired	Is order reference required or not	boolean	None.
IsVatPayer	Is vat payer or not	boolean	Required
Name	Name	string	Required
NameShort	Name short	string	None.
NationalityId	Nationality identifier	integer	None.
PaymentTypeId	Payment type identifier	integer	None.
PersonIdentifications	Address book entry identifications	Collection of ExPersonIdentificationModel	None.
Remark	Remark	string	None.
Surname	Surname	string	None.
SurveyDoNotEmail	Survey do not email	boolean	Required
Title	Title	string	None.
Town	Town	string	None.
TownOfBirth	Town of birth	string	None.
VatFreeArticleId	Vat free article identifier	integer	None.
VatId	VAT identifier	string	None.
WorkingCompanyId	Working company identifier	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "IsActive": true,
  "AddressBookOriginId": 1,
  "AddressBookTypeId": 1,
  "Code": "sample string 1",
  "VatId": "sample string 2",
  "IdentificationNumber": "sample string 3",
  "IsVatPayer": true,
  "IsForeigner": true,
  "IsAgency": true,
  "AllowB2CAccess": true,
  "IsOnBlackList": true,
  "BlackListReason": "sample string 8",
  "AgencyPaysTruePeriod": true,
  "CreateInvoiceUponCarIssue": true,
  "AgencyReservationTimeAdvanceInHours": 1,
  "AgencyFleetAvailabilityLimit": 1.0,
  "Remark": "sample string 9",
  "Email": "sample string 10",
  "Email2": "sample string 11",
  "IsArtisan": true,
  "IsEmployee": true,
  "IsAgent": true,
  "Commission": 1.0,
  "Name": "sample string 15",
  "NameShort": "sample string 16",
  "IBAN": "sample string 17",
  "CompanyTypeId": 1,
  "Surname": "sample string 18",
  "Title": "sample string 19",
  "DateOfBirth": "2026-05-15T11:05:46.8119752+02:00",
  "TownOfBirth": "sample string 20",
  "GenderId": 1,
  "WorkingCompanyId": 1,
  "Town": "sample string 21",
  "BillingCurrencyId": 1,
  "BillingDelayInDays": 22,
  "VatFreeArticleId": 1,
  "EmployeeOfficeId": 1,
  "DoNotFiscalizeFinanceDocuments": true,
  "IsAnonymized": true,
  "InternalRevenueServiceCode": "sample string 23",
  "EInvoiceTypeId": 1,
  "IsOrderReferenceRequired": true,
  "PaymentTypeId": 1,
  "SurveyDoNotEmail": true,
  "NationalityId": 1,
  "IdVersionNumber": "sample string 25",
  "AddressBook_Consents": [
    {
      "RowVersion": "QEA=",
      "Id": 1,
      "IsActive": true,
      "ConsentId": 1,
      "ConsentName": "sample string 3",
      "ConsentSourceId": 1,
      "ConsentSourceName": "sample string 4",
      "ValidFrom": "2026-05-15T11:05:46.8119752+02:00",
      "ValidTo": "2026-05-15T11:05:46.8119752+02:00",
      "CreatorUser": "sample string 5",
      "ModifierUser": "sample string 6",
      "Remark": "sample string 7",
      "CreationTime": "2026-05-15T11:05:46.8119752+02:00",
      "ModificationTime": "2026-05-15T11:05:46.8119752+02:00"
    },
    {
      "RowVersion": "QEA=",
      "Id": 1,
      "IsActive": true,
      "ConsentId": 1,
      "ConsentName": "sample string 3",
      "ConsentSourceId": 1,
      "ConsentSourceName": "sample string 4",
      "ValidFrom": "2026-05-15T11:05:46.8119752+02:00",
      "ValidTo": "2026-05-15T11:05:46.8119752+02:00",
      "CreatorUser": "sample string 5",
      "ModifierUser": "sample string 6",
      "Remark": "sample string 7",
      "CreationTime": "2026-05-15T11:05:46.8119752+02:00",
      "ModificationTime": "2026-05-15T11:05:46.8119752+02:00"
    }
  ],
  "AddressBook_CompanyTypes": [
    {
      "AddressBookId": 1,
      "CompanyTypeId": 2,
      "CompanyTypeName": "sample string 3"
    },
    {
      "AddressBookId": 1,
      "CompanyTypeId": 2,
      "CompanyTypeName": "sample string 3"
    }
  ],
  "AddressBook_Pricelists": [
    {
      "RowVersion": "QEA=",
      "Id": 1,
      "PricelistId": 1,
      "ModifierUser": "sample string 2",
      "ModificationTime": "2026-05-15T11:05:46.8119752+02:00"
    },
    {
      "RowVersion": "QEA=",
      "Id": 1,
      "PricelistId": 1,
      "ModifierUser": "sample string 2",
      "ModificationTime": "2026-05-15T11:05:46.8119752+02:00"
    }
  ],
  "AddressBookAddresses": [
    {
      "RowVersion": "QEA=",
      "AddressBookId": 1,
      "Id": 1,
      "Street": "sample string 2",
      "TownId": 1,
      "TownName": "sample string 3",
      "ProvinceId": 1,
      "ProvinceName": "sample string 4",
      "PostalCode": "sample string 5",
      "CountryId": 1,
      "IsDefault": true,
      "CountryCode": "sample string 7",
      "CountryName": "sample string 8"
    },
    {
      "RowVersion": "QEA=",
      "AddressBookId": 1,
      "Id": 1,
      "Street": "sample string 2",
      "TownId": 1,
      "TownName": "sample string 3",
      "ProvinceId": 1,
      "ProvinceName": "sample string 4",
      "PostalCode": "sample string 5",
      "CountryId": 1,
      "IsDefault": true,
      "CountryCode": "sample string 7",
      "CountryName": "sample string 8"
    }
  ],
  "AddressBookPhones": [
    {
      "RowVersion": "QEA=",
      "AddressBookId": 1,
      "Id": 1,
      "Number": "sample string 2",
      "PhoneTypeId": 1
    },
    {
      "RowVersion": "QEA=",
      "AddressBookId": 1,
      "Id": 1,
      "Number": "sample string 2",
      "PhoneTypeId": 1
    }
  ],
  "PersonIdentifications": [
    {
      "RowVersion": "QEA=",
      "Id": 1,
      "PersonIdentificationTypeId": 1,
      "PersonalIdentificationTypeName": "sample string 2",
      "Number": "sample string 3",
      "IssuedIn": "sample string 4",
      "IssueDate": "2026-05-15T11:05:46.8119752+02:00",
      "ValidUntil": "2026-05-15T11:05:46.8119752+02:00",
      "ValidUnlimited": true,
      "DocumentFrontImageFileItemId": 1,
      "DocumentBackImageFileItemId": 1,
      "SignatureImageFileItemId": 1
    },
    {
      "RowVersion": "QEA=",
      "Id": 1,
      "PersonIdentificationTypeId": 1,
      "PersonalIdentificationTypeName": "sample string 2",
      "Number": "sample string 3",
      "IssuedIn": "sample string 4",
      "IssueDate": "2026-05-15T11:05:46.8119752+02:00",
      "ValidUntil": "2026-05-15T11:05:46.8119752+02:00",
      "ValidUnlimited": true,
      "DocumentFrontImageFileItemId": 1,
      "DocumentBackImageFileItemId": 1,
      "SignatureImageFileItemId": 1
    }
  ]
}

Response Information

Resource Description

Adds new address book entry to the system

ExAddressBookModel

Name	Description	Type	Additional information
AddressBook_CompanyTypes	Address book company types entry	Collection of ExAddressBook_CompanyTypeModel	None.
AddressBook_Consents	Address book entry constents	Collection of ExAddressBook_ConsentModel	None.
AddressBook_Pricelists	Address book entry car pricelists	Collection of ExAddressBook_PricelistModel	None.
AddressBookAddresses	Address book entry addresses	Collection of ExAddressBookAddressModel	None.
AddressBookPhones	Address book entry phone numbers	Collection of ExAddressBookPhoneModel	None.
AddressBookTypeId	Address book entry type identifier	integer	None.
AgencyFleetAvailabilityLimit	Agency fleet availability limit percentage	decimal number	None.
AgencyPaysTruePeriod	Does agency pay for true period or not	boolean	None.
AgencyReservationTimeAdvanceInHours	Agency reservation time advance in hours	integer	None.
AllowB2CAccess	Can address book entry access B2C portal	boolean	None.
AllowOnRequestReservations	Is address book entry allowed to create on request reservations or not	boolean	None.
BillingCurrencyId	Address book entry billing currency identifier	integer	None.
BillingDelayInDays	Address book entry billing delay in days	integer	None.
BlackListReason	Address book entry black list reason	string	None.
Code	Address book entry code	string	None.
Commission	Amount of address book entry comission	decimal number	None.
CompanyTypeId	Identifier of address book entry company type	integer	None.
CreateInvoiceUponCarIssue	Automatically create an invoice for agency on open contracts	boolean	None.
DateOfBirth	Address book entry date of birth. UTC representation in ISO 8601 format.	date	None.
DoNotFiscalizeFinanceDocuments	Should finance documents be fiscalized for the address book entry or not	boolean	None.
EInvoiceTypeId	E-invoice type identifier	integer	None.
Email	Address book entry email address	string	None.
Email2	Address book entry additional email address	string	None.
EmployeeOfficeId	Office identifier for the internal drivers	integer	None.
FullName	Address book entry full name	string	None.
GenderId	Address book entry gender identifier	integer	None.
IBAN	Address book entry IBAN	string	None.
Id	Address book entry identifier	integer	None.
IdentificationNumber	Address book entry identification number	string	None.
IdVersionNumber	Identifier version number	string	None.
InternalRevenueServiceCode	Internal revenue service code	string	None.
IsActive	Is address book entry active or not	boolean	None.
IsAgency	Is address book entry agency or not	boolean	None.
IsAgent	Is address book entry agent or not	boolean	None.
IsAnonymized	Is address book entry anonymized or not	boolean	None.
IsArtisan	Is address book entry artisan or not	boolean	None.
IsEmployee	Is address book entry employee or not	boolean	None.
IsForeigner	Is address book entry foreigner or not	boolean	None.
IsOnBlackList	Is address book entry on black list or not	boolean	None.
IsOrderReferenceRequired	Is order reference required for address book entry or not	boolean	None.
IsVatPayer	Is address book entry obligated to pay VAT or not	boolean	None.
JobTitle	Address book job title	string	None.
Name	Address book entry name	string	None.
NameShort	Address book entry short name	string	None.
NationalityId	Nationality identifier	integer	None.
PaymentTypeId	Address book entry payment type identifier	integer	None.
PersonIdentifications	Address book entry identifications	Collection of ExPersonIdentificationModel	None.
Remark	Address book entry remarsk	string	None.
Surname	Address book entry last name	string	None.
SurveyDoNotEmail	Should address book entry be included in surveys via e-mmail or not	boolean	None.
Title	Address book entry title	string	None.
Town	Address book entry town	string	None.
TownOfBirth	Address book entry place of birth	string	None.
VatFreeArticleId	Address book entry VAT-free article identifier	integer	None.
VatId	Address book entry VAT identifier	string	None.
WorkCompany	Address book work company name	string	None.
WorkingCompanyId	Address book entry working company identifier	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "IsActive": true,
  "AddressBookTypeId": 1,
  "Code": "sample string 2",
  "VatId": "sample string 3",
  "IdentificationNumber": "sample string 4",
  "IsVatPayer": true,
  "IsForeigner": true,
  "IsAgency": true,
  "AllowB2CAccess": true,
  "IsOnBlackList": true,
  "BlackListReason": "sample string 9",
  "AgencyPaysTruePeriod": true,
  "CreateInvoiceUponCarIssue": true,
  "AgencyReservationTimeAdvanceInHours": 1,
  "AgencyFleetAvailabilityLimit": 1.0,
  "Remark": "sample string 10",
  "Email": "sample string 11",
  "Email2": "sample string 12",
  "IsArtisan": true,
  "IsEmployee": true,
  "IsAgent": true,
  "Commission": 1.0,
  "Name": "sample string 16",
  "NameShort": "sample string 17",
  "IBAN": "sample string 18",
  "CompanyTypeId": 1,
  "Surname": "sample string 19",
  "Title": "sample string 20",
  "JobTitle": "sample string 21",
  "DateOfBirth": "2026-05-15T11:05:46.8119752+02:00",
  "TownOfBirth": "sample string 22",
  "GenderId": 1,
  "WorkCompany": "sample string 23",
  "WorkingCompanyId": 1,
  "Town": "sample string 24",
  "FullName": "sample string 25",
  "BillingCurrencyId": 1,
  "BillingDelayInDays": 26,
  "VatFreeArticleId": 1,
  "EmployeeOfficeId": 1,
  "DoNotFiscalizeFinanceDocuments": true,
  "IsAnonymized": true,
  "InternalRevenueServiceCode": "sample string 27",
  "EInvoiceTypeId": 1,
  "IsOrderReferenceRequired": true,
  "PaymentTypeId": 1,
  "AllowOnRequestReservations": true,
  "SurveyDoNotEmail": true,
  "NationalityId": 1,
  "IdVersionNumber": "sample string 29",
  "AddressBook_Consents": [
    {
      "RowVersion": "QEA=",
      "Id": 1,
      "IsActive": true,
      "ConsentId": 1,
      "ConsentName": "sample string 3",
      "ConsentSourceId": 1,
      "ConsentSourceName": "sample string 4",
      "ValidFrom": "2026-05-15T11:05:46.8119752+02:00",
      "ValidTo": "2026-05-15T11:05:46.8119752+02:00",
      "CreatorUser": "sample string 5",
      "ModifierUser": "sample string 6",
      "Remark": "sample string 7",
      "CreationTime": "2026-05-15T11:05:46.8119752+02:00",
      "ModificationTime": "2026-05-15T11:05:46.8119752+02:00"
    },
    {
      "RowVersion": "QEA=",
      "Id": 1,
      "IsActive": true,
      "ConsentId": 1,
      "ConsentName": "sample string 3",
      "ConsentSourceId": 1,
      "ConsentSourceName": "sample string 4",
      "ValidFrom": "2026-05-15T11:05:46.8119752+02:00",
      "ValidTo": "2026-05-15T11:05:46.8119752+02:00",
      "CreatorUser": "sample string 5",
      "ModifierUser": "sample string 6",
      "Remark": "sample string 7",
      "CreationTime": "2026-05-15T11:05:46.8119752+02:00",
      "ModificationTime": "2026-05-15T11:05:46.8119752+02:00"
    }
  ],
  "AddressBook_CompanyTypes": [
    {
      "AddressBookId": 1,
      "CompanyTypeId": 2,
      "CompanyTypeName": "sample string 3"
    },
    {
      "AddressBookId": 1,
      "CompanyTypeId": 2,
      "CompanyTypeName": "sample string 3"
    }
  ],
  "AddressBook_Pricelists": [
    {
      "RowVersion": "QEA=",
      "Id": 1,
      "PricelistId": 1,
      "ModifierUser": "sample string 2",
      "ModificationTime": "2026-05-15T11:05:46.8119752+02:00"
    },
    {
      "RowVersion": "QEA=",
      "Id": 1,
      "PricelistId": 1,
      "ModifierUser": "sample string 2",
      "ModificationTime": "2026-05-15T11:05:46.8119752+02:00"
    }
  ],
  "AddressBookAddresses": [
    {
      "RowVersion": "QEA=",
      "AddressBookId": 1,
      "Id": 1,
      "Street": "sample string 2",
      "TownId": 1,
      "TownName": "sample string 3",
      "ProvinceId": 1,
      "ProvinceName": "sample string 4",
      "PostalCode": "sample string 5",
      "CountryId": 1,
      "IsDefault": true,
      "CountryCode": "sample string 7",
      "CountryName": "sample string 8"
    },
    {
      "RowVersion": "QEA=",
      "AddressBookId": 1,
      "Id": 1,
      "Street": "sample string 2",
      "TownId": 1,
      "TownName": "sample string 3",
      "ProvinceId": 1,
      "ProvinceName": "sample string 4",
      "PostalCode": "sample string 5",
      "CountryId": 1,
      "IsDefault": true,
      "CountryCode": "sample string 7",
      "CountryName": "sample string 8"
    }
  ],
  "AddressBookPhones": [
    {
      "RowVersion": "QEA=",
      "AddressBookId": 1,
      "Id": 1,
      "Number": "sample string 2",
      "PhoneTypeId": 1
    },
    {
      "RowVersion": "QEA=",
      "AddressBookId": 1,
      "Id": 1,
      "Number": "sample string 2",
      "PhoneTypeId": 1
    }
  ],
  "PersonIdentifications": [
    {
      "RowVersion": "QEA=",
      "Id": 1,
      "PersonIdentificationTypeId": 1,
      "PersonalIdentificationTypeName": "sample string 2",
      "Number": "sample string 3",
      "IssuedIn": "sample string 4",
      "IssueDate": "2026-05-15T11:05:46.8119752+02:00",
      "ValidUntil": "2026-05-15T11:05:46.8119752+02:00",
      "ValidUnlimited": true,
      "DocumentFrontImageFileItemId": 1,
      "DocumentBackImageFileItemId": 1,
      "SignatureImageFileItemId": 1
    },
    {
      "RowVersion": "QEA=",
      "Id": 1,
      "PersonIdentificationTypeId": 1,
      "PersonalIdentificationTypeName": "sample string 2",
      "Number": "sample string 3",
      "IssuedIn": "sample string 4",
      "IssueDate": "2026-05-15T11:05:46.8119752+02:00",
      "ValidUntil": "2026-05-15T11:05:46.8119752+02:00",
      "ValidUnlimited": true,
      "DocumentFrontImageFileItemId": 1,
      "DocumentBackImageFileItemId": 1,
      "SignatureImageFileItemId": 1
    }
  ]
}