Update a company
Updates the company and the child collections present in the body, then returns the stored header. Collections the body leaves out are untouched. Requires `Permissions.Companies.Update`.
BearerAuthorizationBearer <token>OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.
companyId*integerint32application/json- body
account?|Domestic bank account number, without the bank code.
length <= 50address1?|First line of the company's main (registered) address, typically street and number.
length <= 80address2?|Second line of the company's main address.
length <= 80address3?|Third line of the company's main address.
length <= 80alias?|Alternative name the company is also known and searchable by.
length <= 200allocatedVolumeOfReceivables?|Maximum amount of outstanding receivables allowed for the company (credit invoicing limit).
decimalallowOnlyItemsFromCustomerPriceList?|When true, only items on the company's customer price list may be sold to it.
automaticOrder?|Whether orders for the company may be generated automatically.
availableVolumeOfReceivables?|Receivables amount still available under the allocated limit.
decimalbank?|Name of the company's bank.
length <= 50bankCode?|Four-digit domestic bank code that follows the account number.
length <= 4bankConnectionCode?|int32bankConstantSymbol?|Default constant symbol (Czech/Slovak payment type code) used on the company's bank payments.
length <= 50bankSpecificSymbol?|Default specific symbol (Czech/Slovak payment reference) used on the company's bank payments.
length <= 50birthCertificateNumber?|National personal identification (birth) number of a natural person.
length <= 50brokerId?|Id of another company acting as broker (intermediary) for this company.
int32businessRegister?|Free-text business register entry of the company (registering court and file number).
businessSalesCenter?|length <= 10changeOriginId?|int32citizenship?|Citizenship, used when the company is a natural person.
length <= 50city?|City of the company's main address.
length <= 80claims?|Total outstanding receivables owed by the company.
decimalcommunicationLanguage?|Language code used for documents and communication with the company.
length <= 10companyCreationDate?|User-entered date the company was established; the server-set record timestamp is CreatedAt.
date-timecompanyIdentificationNumber?|Company registration number as issued by the national business register.
length <= 50companyTypeId?|Classification id from the company types item list; independent of the customer/supplier type flags.
int32connectedUserId?|Id of the user account linked to this company.
int32contactAddressAddress1?|First line of the contact (correspondence) address, when it differs from the main address.
length <= 80contactAddressAddress2?|Second line of the contact (correspondence) address.
length <= 80contactAddressAddress3?|Third line of the contact (correspondence) address.
length <= 80contactAddressCity?|City of the contact (correspondence) address.
length <= 80contactAddressCountry?|Country of the contact (correspondence) address, as free text.
length <= 80contactAddressEmail?|E-mail address associated with the contact address.
length <= 80contactAddressFax?|Fax number associated with the contact address.
length <= 20contactAddressIcq?|ICQ number associated with the contact address (legacy).
length <= 20contactAddressPhone?|Phone number associated with the contact address.
length <= 20contactAddressWebsiteUrl?|Website URL associated with the contact address.
length <= 80contactAddressZipCode?|Postal code of the contact (correspondence) address.
length <= 50contactUserId?|int32country?|Country of the company's main address as free text; see CountryId for the VAT country.
length <= 80countryId?|Id from the VAT countries item list; the company's country for VAT purposes.
int32createdAt?|Timestamp when the record was created in the server's local time; read-only, set automatically.
date-timecreatedAtBranch?|Branch at which the company record was created; read-only.
credit?|Credit amount assigned to the customer.
decimalcreditBalance?|Remaining credit balance available to the customer.
decimalcreditDrawing?|Amount of the assigned credit already drawn.
decimalcreditPaymentDiscountPercent?|Discount in percent applied when the customer pays using their credit.
decimalcreditWorthinessId?|Id from the company credit worthiness item list.
int32currencyId?|Id from the currencies item list; the currency the company is invoiced in.
int32currentTurnover?|Total retail turnover accumulated from the customer's purchases; maintained by sales rather than edited directly.
decimalcustomerAuthorizedPersonId?|Id of the company's authorized person used by default when the company acts as a customer.
int32customerId?|Free-text external customer identifier (up to 20 characters), e.g. the number used by the customer's own system.
length <= 20customerPriceListId?|Id of the individual customer price list assigned to the company.
int32customerSalesCenter?|length <= 10dateOfBirth?|Date of birth, used when the company is a natural person.
date-timedateOfLastAresControl?|Date the company's details were last verified against the national (ARES) business register.
date-timedateOfLastPurchase?|Date of the company's most recent purchase.
date-timedefaultCurrencyId?|int32defaultWarehouseId?|Id from the warehouses item list; the default warehouse for the company's documents.
int32deliveryDays?|Weekdays the company receives deliveries, as a bitmask: Mon 1, Tue 2, Wed 4, Thu 8, Fri 16, Sat 32, Sun 64.
int32directionOfDeliveryId?|Id from the delivery directions item list.
int32discount?|Fixed discount in percent (0–100); allowed only with price types 26 and 31–45.
decimaldiscountDrawing?|Discount amount already drawn against the discount limit.
decimaldiscountGroupDeliveryRouteId?|Id from the company discount groups item list applied to delivery-route (distribution) sales.
int32discountGroupId?|Id from the company discount groups item list; allowed only with price types 1–15 and 25.
int32discountLimit?|Maximum discount amount the customer may draw within the renewal period.
decimaldistrictId?|Id from the districts item list.
int32dueDate?|Default payment due period for the company's invoices, in days.
int32dueDateCode?|length <= 2ediGln?|Company's GLN (Global Location Number) used in EDI messages.
length <= 17ediGlnBranch?|GLN of the company's branch (site) used in EDI messages.
length <= 17ediNorm?|EDI message standard used when exchanging documents with the company.
length <= 10ediPairing?|int32ekokomTypeId?|Id from the EKO-KOM types item list; the company's packaging-waste reporting category.
int32emailReminderEmailAddress?|E-mail address that reminder notifications are sent to.
length <= 50eshopCustomerId?|Identifier of the company in the connected e-shop, used to match e-shop customers.
eshopLogin?|Login name of the company's e-shop account.
length <= 50eshopPassword?|Password of the company's e-shop account.
length <= 50feedLink?string|nullfeedPassword?|length <= 80feedPath?string|nullfeedType?|int32foreignCurrencyId?|Id from the currencies item list; the foreign currency the company trades in.
int32formForCreditNote?|Name of the print form (template) used for the company's credit notes.
formForDeliveryNote?|Name of the print form (template) used for the company's delivery notes.
formForForeignInvoice?|Name of the print form (template) used for the company's foreign-currency invoices.
formForGoodsIssue?|Name of the print form (template) used for the company's goods issue documents.
formForInvoice?|Name of the print form (template) used for the company's invoices.
frameworkOrder?|Reference of the framework order agreed with the company.
length <= 80gdprValidConsent?|Whether the company has given valid GDPR consent to personal data processing.
guid?|Globally unique identifier of the record, assigned by the server; read-only.
guidhomelandAbroadOwn?|Territorial VAT classification: 1 domestic, 2 domestic group, 3 EU, 4 non-EU, 5 foreign group, 6–9 own entities, 10 domestic in foreign currency.
int32ibanCode?|IBAN of the company's bank account.
length <= 34id?|Server-assigned unique id of the company; read-only.
int32identifyCustomerWhenUsingCustomerCard?|Whether presenting one of the company's customer cards at the POS identifies the customer on the sale.
identityCardIssuanceDate?|Date the identity card was issued.
date-timeidentityCardIssuancePlace?|Authority that issued the identity card.
length <= 50identityCardNumber?|Identity card number, used when the company is a natural person.
length <= 50incompleteData?|Flags the record as having incomplete details that still need to be filled in.
incotermsCodeId?|Id of the Incoterms delivery term applied to the company by default.
int32incotermsText?|Free-text Incoterms detail such as the named place (up to 35 characters).
length <= 35initialTurnover?|Turnover carried over from a previous system, counted towards the company's total turnover.
decimalintrastatCountryOfOriginId?|Id of the default Intrastat country of origin used on the company's Intrastat reports.
int32intrastatMovementCodeId?|Id of the default Intrastat movement code used on the company's Intrastat reports.
int32intrastatSenderCountryId?|Id of the default Intrastat country of dispatch used on the company's Intrastat reports.
int32intrastatTermsOfDeliveryId?|Id of the default Intrastat delivery terms used on the company's Intrastat reports.
int32intrastatTransactionId?|Id of the default Intrastat nature of transaction used on the company's Intrastat reports.
int32intrastatTransportTypeId?|Id of the default Intrastat mode of transport used on the company's Intrastat reports.
int32invoicingAddress1?|First line of the billing address used on invoices.
length <= 80invoicingAddress2?|Second line of the billing address used on invoices.
length <= 80invoicingAddress3?|Third line of the billing address used on invoices.
length <= 80invoicingCity?|City of the billing address used on invoices.
length <= 80invoicingCountry?|Country of the billing address used on invoices, as free text.
length <= 80invoicingName?|Name printed on invoices when it differs from the company name.
length <= 80invoicingZipCode?|Postal code of the billing address used on invoices.
length <= 50isCustomsWarehouse?|Whether the company operates as a customs (bonded) warehouse.
isDeliveryNoteOnPOSDisabled?|When true, delivery notes cannot be issued to the company at the POS.
isDiscountGroupFixed?|When true the company is not moved between discount groups automatically based on turnover.
isEmailReminderEnabled?|Whether reminder notifications are sent by e-mail: 0 as set in the system, 1 always, 2 never.
int32isInDecline?|Whether the company has been declared bankrupt.
isInInsolvency?|Whether the company is in insolvency proceedings.
isInactive?|Marks the company as inactive (archived); false or null means active.
isInvoicingDisabled?|When true, invoices cannot be issued to the company.
isNaturalPerson?|True when the partner is a natural person rather than a legal entity.
isPaymentOnCreditDisabled?|When true the company may not pay on credit (deferred payment).
isSignotecSignatureDeliveryNoteEnabled?|Whether delivery notes for the company are signed on a Signotec signature pad.
isSmsReminderEnabled?|Whether reminder notifications are sent by SMS: 0 as set in the system, 1 always, 2 never.
int32isSummaryBillingEnabled?|Whether several deliveries to the company may be billed together on one summary invoice.
isTaxWarehouse?|Whether the company operates as an excise (tax) warehouse.
kindOfOperationId?|Id from the company kinds of operations item list.
int32labelId?|int32lastLoginDate?|date-timelastModify?|Timestamp of the last change to the record in the server's local time; read-only, set automatically.
date-timemaximumDelayOfMaturity?|Maximum tolerated payment delay in days beyond the invoice due date.
int32minimalOrderAmount?|Minimum order value accepted from the company, in the instance's base currency.
decimalname?|Full company name; required when creating a company.
length <= 255nameAbbreviated?|Abbreviated company name (up to 80 characters) for places where the full name is too long.
length <= 80nameValidOnlyTillLogout?boolean|nullnameWithoutDiacritics?|Company name with diacritics stripped, used for searching; server-maintained and read-only.
length <= 255note?|Free-text internal note about the company.
noteForPrinting1?|Id from the company notes item list; predefined note printed on the company's documents (slot 1 of 5).
int32noteForPrinting2?|Id from the company notes item list; predefined note printed on the company's documents (slot 2 of 5).
int32noteForPrinting3?|Id from the company notes item list; predefined note printed on the company's documents (slot 3 of 5).
int32noteForPrinting4?|Id from the company notes item list; predefined note printed on the company's documents (slot 4 of 5).
int32noteForPrinting5?|Id from the company notes item list; predefined note printed on the company's documents (slot 5 of 5).
int32number?|Company number (up to 8 characters); auto-generated or required on create depending on instance settings, never changeable afterwards.
length <= 8optional1Id?|Id from the instance-defined Optional 1 company classification item list.
int32optional2Id?|Id from the instance-defined Optional 2 company classification item list.
int32optional3Id?|Id from the instance-defined Optional 3 company classification item list.
int32overdueReceivables?|Amount of the company's receivables that are past their due date.
decimalpackagingLabelId?|Id of the packaging label type used for shipments to the company.
int32payToBankAccountNumber?|Bank account number that payments to the company are sent to, when it differs from Account.
length <= 50paymentTypeId?|Id from the payment types item list; the default payment method on the company's documents.
int32photo?|Company photo or logo as raw image bytes.
placeOfBirth?|Place of birth, used when the company is a natural person.
length <= 50priceId?|Price type code deciding how sale prices are derived; it determines whether DiscountGroupId (1–15, 25), Discount (26, 31–45) or Surcharge (27, 28) applies.
int32primaryContactEmail?|E-mail address of the primary contact person.
length <= 80primaryContactFax?|Fax number of the primary contact person.
length <= 20primaryContactFunctionId?|Id from the functions of representatives item list; the primary contact's job function.
int32primaryContactIcq?|ICQ number of the primary contact person (legacy).
length <= 20primaryContactMobilePhone?|Mobile phone number of the primary contact person.
length <= 20primaryContactName?|First name of the primary contact person.
length <= 80primaryContactPhone?|Landline phone number of the primary contact person.
length <= 20primaryContactShouldSendMailTo?|Whether the primary contact wants to receive informational e-mails.
primaryContactSmsEnabled?|Whether SMS messages may be sent to the primary contact.
primaryContactSurname?|Surname of the primary contact person.
length <= 80primaryContactTitle?|Academic or honorific title of the primary contact person.
length <= 20priorityOfCoveringSalesOrder?|Priority used when allocating stock to cover the company's sales orders.
int32purchaseContractNumber?|Number of the purchase contract agreed with the company.
length <= 80regionId?|Id from the regions item list.
int32routeId?|Id from the delivery routes item list; the route the company is delivered on.
int32routeOrder?|Stop order of the company on its delivery route.
int32sapCustomerNumber?|Customer number of the company in SAP, for integrations.
length <= 50sellerId?|Id from the sales representatives item list; the representative responsible for the company.
int32serviceDescription?|length <= 50sex?|int32shippingTerminalOrder?|Sort position of the company in the shipping terminal's selection.
int32shouldContactCustomerCenter?|When true, staff are prompted to ask the customer to visit the customer centre.
showOnPackingTerminal?|Whether the company is offered in the packing terminal's company selection.
showOnShippingTerminal?|Whether the company is offered in the shipping terminal's company selection.
smsReminderPhoneNumber?|Phone number that reminder SMS notifications are sent to.
length <= 30specializationId?|Id from the company specializations item list.
int32surcharge?|Fixed surcharge in percent (0–100) on the purchase or stock price; allowed only with price types 27 and 28.
decimalswiftCode?|SWIFT/BIC code of the company's bank.
length <= 11totalPoints?|Loyalty points balance accumulated from the customer's purchases; maintained by sales rather than edited directly.
int32transportDriverId?|Id from the drivers item list; the default driver for deliveries to the company.
int32transportTypeId?|Id from the transport types item list; the default transport for deliveries to the company.
int32typeOfCreditAutomaticRenewal?|How often the assigned credit is renewed automatically: 0 never, 1 daily, 2 weekly, 3 monthly, 4 annually.
int32typeOfDiscountAutomaticRenewal?|How often the discount limit is renewed automatically: 0 never, 1 daily, 2 weekly, 3 monthly, 4 annually.
int32userId?|int32usesSSCC?|Whether the company uses SSCC (Serial Shipping Container Code) pallet labels.
vatCode?|length <= 5vatIdentificationNumber?|VAT identification number kept separately from the tax number where the country issues both (e.g. Slovakia).
length <= 50vatPayer?|Whether the company is registered as a VAT payer.
vatRegistrationNumber?|VAT identification (tax) number including the country prefix, e.g. CZ12345678.
length <= 50websiteUrl?|Company website URL.
length <= 80zipCode?|Postal code of the company's main address.
length <= 50authorizedPersons?array<>|People authorised to act for the company. Loaded only with the AuthorizedPersons sub-query.
branches?array<>|The company's delivery and billing sites. Loaded only with the Branches sub-query.
cards?array<>|Loyalty and customer cards issued to the company. Loaded only with the Cards sub-query.
representatives?array<>|Sales representatives assigned to the company. Loaded only with the Representatives sub-query.
types?array<>|What the company is to this instance — customer, supplier, or both. Loaded only with the All sub-query.
application/json- response
account?|Domestic bank account number, without the bank code.
length <= 50address1?|First line of the company's main (registered) address, typically street and number.
length <= 80address2?|Second line of the company's main address.
length <= 80address3?|Third line of the company's main address.
length <= 80alias?|Alternative name the company is also known and searchable by.
length <= 200allocatedVolumeOfReceivables?|Maximum amount of outstanding receivables allowed for the company (credit invoicing limit).
decimalallowOnlyItemsFromCustomerPriceList?|When true, only items on the company's customer price list may be sold to it.
automaticOrder?|Whether orders for the company may be generated automatically.
availableVolumeOfReceivables?|Receivables amount still available under the allocated limit.
decimalbank?|Name of the company's bank.
length <= 50bankCode?|Four-digit domestic bank code that follows the account number.
length <= 4bankConnectionCode?|int32bankConstantSymbol?|Default constant symbol (Czech/Slovak payment type code) used on the company's bank payments.
length <= 50bankSpecificSymbol?|Default specific symbol (Czech/Slovak payment reference) used on the company's bank payments.
length <= 50birthCertificateNumber?|National personal identification (birth) number of a natural person.
length <= 50brokerId?|Id of another company acting as broker (intermediary) for this company.
int32businessRegister?|Free-text business register entry of the company (registering court and file number).
businessSalesCenter?|length <= 10changeOriginId?|int32citizenship?|Citizenship, used when the company is a natural person.
length <= 50city?|City of the company's main address.
length <= 80claims?|Total outstanding receivables owed by the company.
decimalcommunicationLanguage?|Language code used for documents and communication with the company.
length <= 10companyCreationDate?|User-entered date the company was established; the server-set record timestamp is CreatedAt.
date-timecompanyIdentificationNumber?|Company registration number as issued by the national business register.
length <= 50companyTypeId?|Classification id from the company types item list; independent of the customer/supplier type flags.
int32connectedUserId?|Id of the user account linked to this company.
int32contactAddressAddress1?|First line of the contact (correspondence) address, when it differs from the main address.
length <= 80contactAddressAddress2?|Second line of the contact (correspondence) address.
length <= 80contactAddressAddress3?|Third line of the contact (correspondence) address.
length <= 80contactAddressCity?|City of the contact (correspondence) address.
length <= 80contactAddressCountry?|Country of the contact (correspondence) address, as free text.
length <= 80contactAddressEmail?|E-mail address associated with the contact address.
length <= 80contactAddressFax?|Fax number associated with the contact address.
length <= 20contactAddressIcq?|ICQ number associated with the contact address (legacy).
length <= 20contactAddressPhone?|Phone number associated with the contact address.
length <= 20contactAddressWebsiteUrl?|Website URL associated with the contact address.
length <= 80contactAddressZipCode?|Postal code of the contact (correspondence) address.
length <= 50contactUserId?|int32country?|Country of the company's main address as free text; see CountryId for the VAT country.
length <= 80countryId?|Id from the VAT countries item list; the company's country for VAT purposes.
int32createdAt?|Timestamp when the record was created in the server's local time; read-only, set automatically.
date-timecreatedAtBranch?|Branch at which the company record was created; read-only.
credit?|Credit amount assigned to the customer.
decimalcreditBalance?|Remaining credit balance available to the customer.
decimalcreditDrawing?|Amount of the assigned credit already drawn.
decimalcreditPaymentDiscountPercent?|Discount in percent applied when the customer pays using their credit.
decimalcreditWorthinessId?|Id from the company credit worthiness item list.
int32currencyId?|Id from the currencies item list; the currency the company is invoiced in.
int32currentTurnover?|Total retail turnover accumulated from the customer's purchases; maintained by sales rather than edited directly.
decimalcustomerAuthorizedPersonId?|Id of the company's authorized person used by default when the company acts as a customer.
int32customerId?|Free-text external customer identifier (up to 20 characters), e.g. the number used by the customer's own system.
length <= 20customerPriceListId?|Id of the individual customer price list assigned to the company.
int32customerSalesCenter?|length <= 10dateOfBirth?|Date of birth, used when the company is a natural person.
date-timedateOfLastAresControl?|Date the company's details were last verified against the national (ARES) business register.
date-timedateOfLastPurchase?|Date of the company's most recent purchase.
date-timedefaultCurrencyId?|int32defaultWarehouseId?|Id from the warehouses item list; the default warehouse for the company's documents.
int32deliveryDays?|Weekdays the company receives deliveries, as a bitmask: Mon 1, Tue 2, Wed 4, Thu 8, Fri 16, Sat 32, Sun 64.
int32directionOfDeliveryId?|Id from the delivery directions item list.
int32discount?|Fixed discount in percent (0–100); allowed only with price types 26 and 31–45.
decimaldiscountDrawing?|Discount amount already drawn against the discount limit.
decimaldiscountGroupDeliveryRouteId?|Id from the company discount groups item list applied to delivery-route (distribution) sales.
int32discountGroupId?|Id from the company discount groups item list; allowed only with price types 1–15 and 25.
int32discountLimit?|Maximum discount amount the customer may draw within the renewal period.
decimaldistrictId?|Id from the districts item list.
int32dueDate?|Default payment due period for the company's invoices, in days.
int32dueDateCode?|length <= 2ediGln?|Company's GLN (Global Location Number) used in EDI messages.
length <= 17ediGlnBranch?|GLN of the company's branch (site) used in EDI messages.
length <= 17ediNorm?|EDI message standard used when exchanging documents with the company.
length <= 10ediPairing?|int32ekokomTypeId?|Id from the EKO-KOM types item list; the company's packaging-waste reporting category.
int32emailReminderEmailAddress?|E-mail address that reminder notifications are sent to.
length <= 50eshopCustomerId?|Identifier of the company in the connected e-shop, used to match e-shop customers.
eshopLogin?|Login name of the company's e-shop account.
length <= 50eshopPassword?|Password of the company's e-shop account.
length <= 50feedLink?string|nullfeedPassword?|length <= 80feedPath?string|nullfeedType?|int32foreignCurrencyId?|Id from the currencies item list; the foreign currency the company trades in.
int32formForCreditNote?|Name of the print form (template) used for the company's credit notes.
formForDeliveryNote?|Name of the print form (template) used for the company's delivery notes.
formForForeignInvoice?|Name of the print form (template) used for the company's foreign-currency invoices.
formForGoodsIssue?|Name of the print form (template) used for the company's goods issue documents.
formForInvoice?|Name of the print form (template) used for the company's invoices.
frameworkOrder?|Reference of the framework order agreed with the company.
length <= 80gdprValidConsent?|Whether the company has given valid GDPR consent to personal data processing.
guid?|Globally unique identifier of the record, assigned by the server; read-only.
guidhomelandAbroadOwn?|Territorial VAT classification: 1 domestic, 2 domestic group, 3 EU, 4 non-EU, 5 foreign group, 6–9 own entities, 10 domestic in foreign currency.
int32ibanCode?|IBAN of the company's bank account.
length <= 34id?|Server-assigned unique id of the company; read-only.
int32identifyCustomerWhenUsingCustomerCard?|Whether presenting one of the company's customer cards at the POS identifies the customer on the sale.
identityCardIssuanceDate?|Date the identity card was issued.
date-timeidentityCardIssuancePlace?|Authority that issued the identity card.
length <= 50identityCardNumber?|Identity card number, used when the company is a natural person.
length <= 50incompleteData?|Flags the record as having incomplete details that still need to be filled in.
incotermsCodeId?|Id of the Incoterms delivery term applied to the company by default.
int32incotermsText?|Free-text Incoterms detail such as the named place (up to 35 characters).
length <= 35initialTurnover?|Turnover carried over from a previous system, counted towards the company's total turnover.
decimalintrastatCountryOfOriginId?|Id of the default Intrastat country of origin used on the company's Intrastat reports.
int32intrastatMovementCodeId?|Id of the default Intrastat movement code used on the company's Intrastat reports.
int32intrastatSenderCountryId?|Id of the default Intrastat country of dispatch used on the company's Intrastat reports.
int32intrastatTermsOfDeliveryId?|Id of the default Intrastat delivery terms used on the company's Intrastat reports.
int32intrastatTransactionId?|Id of the default Intrastat nature of transaction used on the company's Intrastat reports.
int32intrastatTransportTypeId?|Id of the default Intrastat mode of transport used on the company's Intrastat reports.
int32invoicingAddress1?|First line of the billing address used on invoices.
length <= 80invoicingAddress2?|Second line of the billing address used on invoices.
length <= 80invoicingAddress3?|Third line of the billing address used on invoices.
length <= 80invoicingCity?|City of the billing address used on invoices.
length <= 80invoicingCountry?|Country of the billing address used on invoices, as free text.
length <= 80invoicingName?|Name printed on invoices when it differs from the company name.
length <= 80invoicingZipCode?|Postal code of the billing address used on invoices.
length <= 50isCustomsWarehouse?|Whether the company operates as a customs (bonded) warehouse.
isDeliveryNoteOnPOSDisabled?|When true, delivery notes cannot be issued to the company at the POS.
isDiscountGroupFixed?|When true the company is not moved between discount groups automatically based on turnover.
isEmailReminderEnabled?|Whether reminder notifications are sent by e-mail: 0 as set in the system, 1 always, 2 never.
int32isInDecline?|Whether the company has been declared bankrupt.
isInInsolvency?|Whether the company is in insolvency proceedings.
isInactive?|Marks the company as inactive (archived); false or null means active.
isInvoicingDisabled?|When true, invoices cannot be issued to the company.
isNaturalPerson?|True when the partner is a natural person rather than a legal entity.
isPaymentOnCreditDisabled?|When true the company may not pay on credit (deferred payment).
isSignotecSignatureDeliveryNoteEnabled?|Whether delivery notes for the company are signed on a Signotec signature pad.
isSmsReminderEnabled?|Whether reminder notifications are sent by SMS: 0 as set in the system, 1 always, 2 never.
int32isSummaryBillingEnabled?|Whether several deliveries to the company may be billed together on one summary invoice.
isTaxWarehouse?|Whether the company operates as an excise (tax) warehouse.
kindOfOperationId?|Id from the company kinds of operations item list.
int32labelId?|int32lastLoginDate?|date-timelastModify?|Timestamp of the last change to the record in the server's local time; read-only, set automatically.
date-timemaximumDelayOfMaturity?|Maximum tolerated payment delay in days beyond the invoice due date.
int32minimalOrderAmount?|Minimum order value accepted from the company, in the instance's base currency.
decimalname?|Full company name; required when creating a company.
length <= 255nameAbbreviated?|Abbreviated company name (up to 80 characters) for places where the full name is too long.
length <= 80nameValidOnlyTillLogout?boolean|nullnameWithoutDiacritics?|Company name with diacritics stripped, used for searching; server-maintained and read-only.
length <= 255note?|Free-text internal note about the company.
noteForPrinting1?|Id from the company notes item list; predefined note printed on the company's documents (slot 1 of 5).
int32noteForPrinting2?|Id from the company notes item list; predefined note printed on the company's documents (slot 2 of 5).
int32noteForPrinting3?|Id from the company notes item list; predefined note printed on the company's documents (slot 3 of 5).
int32noteForPrinting4?|Id from the company notes item list; predefined note printed on the company's documents (slot 4 of 5).
int32noteForPrinting5?|Id from the company notes item list; predefined note printed on the company's documents (slot 5 of 5).
int32number?|Company number (up to 8 characters); auto-generated or required on create depending on instance settings, never changeable afterwards.
length <= 8optional1Id?|Id from the instance-defined Optional 1 company classification item list.
int32optional2Id?|Id from the instance-defined Optional 2 company classification item list.
int32optional3Id?|Id from the instance-defined Optional 3 company classification item list.
int32overdueReceivables?|Amount of the company's receivables that are past their due date.
decimalpackagingLabelId?|Id of the packaging label type used for shipments to the company.
int32payToBankAccountNumber?|Bank account number that payments to the company are sent to, when it differs from Account.
length <= 50paymentTypeId?|Id from the payment types item list; the default payment method on the company's documents.
int32photo?|Company photo or logo as raw image bytes.
placeOfBirth?|Place of birth, used when the company is a natural person.
length <= 50priceId?|Price type code deciding how sale prices are derived; it determines whether DiscountGroupId (1–15, 25), Discount (26, 31–45) or Surcharge (27, 28) applies.
int32primaryContactEmail?|E-mail address of the primary contact person.
length <= 80primaryContactFax?|Fax number of the primary contact person.
length <= 20primaryContactFunctionId?|Id from the functions of representatives item list; the primary contact's job function.
int32primaryContactIcq?|ICQ number of the primary contact person (legacy).
length <= 20primaryContactMobilePhone?|Mobile phone number of the primary contact person.
length <= 20primaryContactName?|First name of the primary contact person.
length <= 80primaryContactPhone?|Landline phone number of the primary contact person.
length <= 20primaryContactShouldSendMailTo?|Whether the primary contact wants to receive informational e-mails.
primaryContactSmsEnabled?|Whether SMS messages may be sent to the primary contact.
primaryContactSurname?|Surname of the primary contact person.
length <= 80primaryContactTitle?|Academic or honorific title of the primary contact person.
length <= 20priorityOfCoveringSalesOrder?|Priority used when allocating stock to cover the company's sales orders.
int32purchaseContractNumber?|Number of the purchase contract agreed with the company.
length <= 80regionId?|Id from the regions item list.
int32routeId?|Id from the delivery routes item list; the route the company is delivered on.
int32routeOrder?|Stop order of the company on its delivery route.
int32sapCustomerNumber?|Customer number of the company in SAP, for integrations.
length <= 50sellerId?|Id from the sales representatives item list; the representative responsible for the company.
int32serviceDescription?|length <= 50sex?|int32shippingTerminalOrder?|Sort position of the company in the shipping terminal's selection.
int32shouldContactCustomerCenter?|When true, staff are prompted to ask the customer to visit the customer centre.
showOnPackingTerminal?|Whether the company is offered in the packing terminal's company selection.
showOnShippingTerminal?|Whether the company is offered in the shipping terminal's company selection.
smsReminderPhoneNumber?|Phone number that reminder SMS notifications are sent to.
length <= 30specializationId?|Id from the company specializations item list.
int32surcharge?|Fixed surcharge in percent (0–100) on the purchase or stock price; allowed only with price types 27 and 28.
decimalswiftCode?|SWIFT/BIC code of the company's bank.
length <= 11totalPoints?|Loyalty points balance accumulated from the customer's purchases; maintained by sales rather than edited directly.
int32transportDriverId?|Id from the drivers item list; the default driver for deliveries to the company.
int32transportTypeId?|Id from the transport types item list; the default transport for deliveries to the company.
int32typeOfCreditAutomaticRenewal?|How often the assigned credit is renewed automatically: 0 never, 1 daily, 2 weekly, 3 monthly, 4 annually.
int32typeOfDiscountAutomaticRenewal?|How often the discount limit is renewed automatically: 0 never, 1 daily, 2 weekly, 3 monthly, 4 annually.
int32userId?|int32usesSSCC?|Whether the company uses SSCC (Serial Shipping Container Code) pallet labels.
vatCode?|length <= 5vatIdentificationNumber?|VAT identification number kept separately from the tax number where the country issues both (e.g. Slovakia).
length <= 50vatPayer?|Whether the company is registered as a VAT payer.
vatRegistrationNumber?|VAT identification (tax) number including the country prefix, e.g. CZ12345678.
length <= 50websiteUrl?|Company website URL.
length <= 80zipCode?|Postal code of the company's main address.
length <= 50curl -X PUT 'https://<your-instance>/api/companies/0' \ -H 'Authorization: Bearer <access-token>' \ -H 'Content-Type: application/json' \ -d '{ "address1": "U koně 13", "city": "Brno", "companyIdentificationNumber": "12345555", "country": "Czech Republic", "id": 12, "isInactive": false, "name": "LineTech s.r.o.", "note": "Company relocated to new address.", "primaryContactEmail": "[email protected]", "primaryContactName": "Karla", "primaryContactPhone": "+420987654321", "primaryContactSurname": "Nováková", "types": [ "supplier", "retailCustomer", "wholeSaleCustomer" ], "vatRegistrationNumber": "CZ12345555", "websiteUrl": "https://www.linetech.cz", "zipCode": "21000"}'{ "account": "string", "address1": "string", "address2": "string", "address3": "string", "alias": "string", "allocatedVolumeOfReceivables": 0, "allowOnlyItemsFromCustomerPriceList": true, "automaticOrder": true, "availableVolumeOfReceivables": 0, "bank": "string", "bankCode": "stri", "bankConnectionCode": 0, "bankConstantSymbol": "string", "bankSpecificSymbol": "string", "birthCertificateNumber": "string", "brokerId": 0, "businessRegister": "string", "businessSalesCenter": "string", "changeOriginId": 0, "citizenship": "string", "city": "string", "claims": 0, "communicationLanguage": "string", "companyCreationDate": "2019-08-24T14:15:22Z", "companyIdentificationNumber": "string", "companyTypeId": 0, "connectedUserId": 0, "contactAddressAddress1": "string", "contactAddressAddress2": "string", "contactAddressAddress3": "string", "contactAddressCity": "string", "contactAddressCountry": "string", "contactAddressEmail": "string", "contactAddressFax": "string", "contactAddressIcq": "string", "contactAddressPhone": "string", "contactAddressWebsiteUrl": "string", "contactAddressZipCode": "string", "contactUserId": 0, "country": "string", "countryId": 0, "createdAt": "2019-08-24T14:15:22Z", "createdAtBranch": "string", "credit": 0, "creditBalance": 0, "creditDrawing": 0, "creditPaymentDiscountPercent": 0, "creditWorthinessId": 0, "currencyId": 0, "currentTurnover": 0, "customerAuthorizedPersonId": 0, "customerId": "string", "customerPriceListId": 0, "customerSalesCenter": "string", "dateOfBirth": "2019-08-24T14:15:22Z", "dateOfLastAresControl": "2019-08-24T14:15:22Z", "dateOfLastPurchase": "2019-08-24T14:15:22Z", "defaultCurrencyId": 0, "defaultWarehouseId": 0, "deliveryDays": 0, "directionOfDeliveryId": 0, "discount": 0, "discountDrawing": 0, "discountGroupDeliveryRouteId": 0, "discountGroupId": 0, "discountLimit": 0, "districtId": 0, "dueDate": 0, "dueDateCode": "st", "ediGln": "string", "ediGlnBranch": "string", "ediNorm": "string", "ediPairing": 0, "ekokomTypeId": 0, "emailReminderEmailAddress": "string", "eshopCustomerId": "string", "eshopLogin": "string", "eshopPassword": "string", "feedLink": "string", "feedPassword": "string", "feedPath": "string", "feedType": 0, "foreignCurrencyId": 0, "formForCreditNote": "string", "formForDeliveryNote": "string", "formForForeignInvoice": "string", "formForGoodsIssue": "string", "formForInvoice": "string", "frameworkOrder": "string", "gdprValidConsent": true, "guid": "string", "homelandAbroadOwn": 0, "ibanCode": "string", "id": 0, "identifyCustomerWhenUsingCustomerCard": true, "identityCardIssuanceDate": "2019-08-24T14:15:22Z", "identityCardIssuancePlace": "string", "identityCardNumber": "string", "incompleteData": true, "incotermsCodeId": 0, "incotermsText": "string", "initialTurnover": 0, "intrastatCountryOfOriginId": 0, "intrastatMovementCodeId": 0, "intrastatSenderCountryId": 0, "intrastatTermsOfDeliveryId": 0, "intrastatTransactionId": 0, "intrastatTransportTypeId": 0, "invoicingAddress1": "string", "invoicingAddress2": "string", "invoicingAddress3": "string", "invoicingCity": "string", "invoicingCountry": "string", "invoicingName": "string", "invoicingZipCode": "string", "isCustomsWarehouse": true, "isDeliveryNoteOnPOSDisabled": true, "isDiscountGroupFixed": true, "isEmailReminderEnabled": 0, "isInDecline": true, "isInInsolvency": true, "isInactive": true, "isInvoicingDisabled": true, "isNaturalPerson": true, "isPaymentOnCreditDisabled": true, "isSignotecSignatureDeliveryNoteEnabled": true, "isSmsReminderEnabled": 0, "isSummaryBillingEnabled": true, "isTaxWarehouse": true, "kindOfOperationId": 0, "labelId": 0, "lastLoginDate": "2019-08-24T14:15:22Z", "lastModify": "2019-08-24T14:15:22Z", "maximumDelayOfMaturity": 0, "minimalOrderAmount": 0, "name": "string", "nameAbbreviated": "string", "nameValidOnlyTillLogout": true, "nameWithoutDiacritics": "string", "note": "string", "noteForPrinting1": 0, "noteForPrinting2": 0, "noteForPrinting3": 0, "noteForPrinting4": 0, "noteForPrinting5": 0, "number": "string", "optional1Id": 0, "optional2Id": 0, "optional3Id": 0, "overdueReceivables": 0, "packagingLabelId": 0, "payToBankAccountNumber": "string", "paymentTypeId": 0, "photo": "string", "placeOfBirth": "string", "priceId": 0, "primaryContactEmail": "string", "primaryContactFax": "string", "primaryContactFunctionId": 0, "primaryContactIcq": "string", "primaryContactMobilePhone": "string", "primaryContactName": "string", "primaryContactPhone": "string", "primaryContactShouldSendMailTo": true, "primaryContactSmsEnabled": true, "primaryContactSurname": "string", "primaryContactTitle": "string", "priorityOfCoveringSalesOrder": 0, "purchaseContractNumber": "string", "regionId": 0, "routeId": 0, "routeOrder": 0, "sapCustomerNumber": "string", "sellerId": 0, "serviceDescription": "string", "sex": 0, "shippingTerminalOrder": 0, "shouldContactCustomerCenter": true, "showOnPackingTerminal": true, "showOnShippingTerminal": true, "smsReminderPhoneNumber": "string", "specializationId": 0, "surcharge": 0, "swiftCode": "string", "totalPoints": 0, "transportDriverId": 0, "transportTypeId": 0, "typeOfCreditAutomaticRenewal": 0, "typeOfDiscountAutomaticRenewal": 0, "userId": 0, "usesSSCC": true, "vatCode": "strin", "vatIdentificationNumber": "string", "vatPayer": true, "vatRegistrationNumber": "string", "websiteUrl": "string", "zipCode": "string"}Get a company GET
Returns one company by `companyId`. Use `details` to pick which sub-collections (branches, cards, representatives, …) are loaded; omit it for the header only. Requires `Permissions.Companies.View`.
List authorised persons GET
Returns the people authorised to act for this company. Requires `Permissions.Companies.View`.