Skip to content

updateCompany

Request

Bodyapplication/jsonrequired
namestring, [ 0 .. 200 ] charactersrequired
cifstring, [ 0 .. 20 ] characters
emailAddressstring, [ 0 .. 255 ] characters
emailHoststring, [ 0 .. 255 ] characters
emailPortinteger, (int32)
emailUsernamestring, [ 0 .. 255 ] characters
emailPasswordKeystring, [ 0 .. 255 ] characters
emailReplyToAddressstring, [ 0 .. 255 ] characters
emailSignaturestring, [ 0 .. 255 ] characters
emailEnableTlsboolean
additionalInfoobject(ApiCompanyInfoWriteDto)required
PUT
/api/v1/company
curl -i -X PUT \
  https://api.prana.software/api/v1/company \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "cif": "string",
    "emailAddress": "string",
    "emailHost": "string",
    "emailPort": 0,
    "emailUsername": "string",
    "emailPasswordKey": "string",
    "emailReplyToAddress": "string",
    "emailSignature": "string",
    "emailEnableTls": true,
    "additionalInfo": {
      "code": "string",
      "commercialName": "string",
      "address": "string",
      "countryIsoCode": "AD",
      "stateIsoCode": "strin",
      "postalCode": "string",
      "city": "string",
      "phone1": "string",
      "phone2": "string",
      "email": "string",
      "website": "string",
      "commercialRegistry": "string",
      "observations": "string",
      "logo": "string",
      "activeB2B": true,
      "backgroundImage": "string",
      "blockchainAccount": "string",
      "blockchainPrivateKey": "string",
      "ropoCode": "string",
      "customerVatType": 0,
      "paymentMethod": 0,
      "unitType": 0,
      "warehouse": 0,
      "rateCode": 0,
      "articleVatType": "string",
      "bank": 0,
      "billingSeriesSale": 0,
      "billingSeriesSaleTicket": 0,
      "billingSeriesPurchase": 0,
      "billingSeriesPurchaseTicket": 0,
      "billingSeriesInvoiceDraft": 0,
      "currency": 0,
      "shippingTerm": 0,
      "secondaryCurrency": 0,
      "customersAccount": 0,
      "suppliersAccount": 0,
      "creditorVatAccount": 0,
      "debtorVatAccount": 0,
      "salesAccount": 0,
      "purchasingAccount": 0,
      "supInternalOpAccount": 0,
      "supRecAccount": 0,
      "supAssetsAccount": 0,
      "supServicesAccount": 0,
      "supImportsAccount": 0,
      "supIrpfLeasesAccount": 0,
      "supIrpfProfessionalAccount": 0,
      "supIrpfAgroAccount": 0,
      "outInternalOpAccount": 0,
      "outRecAccount": 0,
      "outAssetsAccount": 0,
      "outServicesAccount": 0,
      "outImportsAccount": 0,
      "outReverseChargeAccount": 0,
      "outWithholdingAccount": 0,
      "salesConcept": 0,
      "purchasingConcept": 0,
      "igic": true,
      "companyType": "LEGAL_PERSON",
      "ticketbaiTaxAuthority": "ALAVA",
      "underEquivalenceSurchargeRegime": true,
      "numericFormatStyle": "US_WITH_GROUPING",
      "ticketbaiActive": true,
      "ticketbaiConditionDate": "2019-08-24",
      "ticketbaiConditionName": "string",
      "ticketbaiConditionVatId": "string",
      "ticketbaiConditionAddress": "string",
      "defaultInvoiceDescription": "string",
      "vatOperationType": "string",
      "verifactuActive": true,
      "verifactuTest": true,
      "verifactuStartDate": "2019-08-24",
      "verifactuEndDate": "2019-08-24",
      "receiptConcept": 0,
      "purchaseReceiptConcept": 0,
      "modeVerifactu": true,
      "verifactuExemptCause": "SII",
      "verifactuExemptDate": "2019-08-24",
      "openingConcept": 0,
      "closingConcept": 0,
      "operatingClosingConcept": 0,
      "amortizationConcept": 0,
      "welcomeSurvey": "string",
      "verifactuTrial": true,
      "accountingExportDateTo": "2019-08-24",
      "renewVerifactu": true,
      "renewVerifactuMode": "VERIFACTU",
      "reportLanguage": "EN",
      "siiActive": true,
      "siiStartDate": "2019-08-24",
      "defaultPurchaseInvoiceDescription": "string",
      "defaultChargedVatPercentage": 0,
      "defaultChargedRecPercentage": 0,
      "defaultSupportedVatPercentage": 0,
      "defaultSupportedRecPercentage": 0,
      "disposalLossAccount": 0,
      "disposalProfitAccount": 0,
      "disposalConcept": 0
    }
  }'

Responses

OK

Bodyapplication/json
idinteger, (int32)required

Unique identifier of the object

Default:""
namestring

Company name.

Default:""
Example:"CLAVEi"
cifstring

Company tax identification code.

Default:""
Example:"B12345678"
managementCompanyTypestring(ApiManagementCompanyTypeEnum)
Enum:"SELF_EMPLOYED""COMPANY""CONSULTANT_COMPANY"
emailAddressstring

Main company email address.

Default:""
Example:"info@clavei.es"
emailHoststring

SMTP email host.

Default:""
Example:"smtp.clavei.es"
emailPortinteger, (int32)

SMTP email server port.

Default:""
Example:587
emailUsernamestring

SMTP username for outgoing email.

Default:""
Example:"user@clavei.es"
emailPasswordKeystring

Encrypted key for the email password.

Default:""
Example:"ENCRYPTED_KEY_123"
emailReplyToAddressstring

Reply-to email address used in communications.

Default:""
Example:"support@clavei.es"
emailSignaturestring

Email signature in HTML or plain text.

Default:""
emailEnableTlsboolean

If true, TLS is enabled for outgoing emails.

Default:false
Example:true
createdBystring

User who created the record.

Default:""
Example:"admin"
modifiedBystring

User who last modified the record.

Default:""
Example:"johndoe"
createdOnstring, (date-time)

Timestamp when the record was created. Format: yyyy-MM-dd'T'HH:mm:ss

Default:""
Example:"2024-01-03T08:15:45"
modifiedOnstring, (date-time)

Timestamp when the record was last modified. Format: yyyy-MM-dd'T'HH:mm:ss

Default:""
Example:"2024-08-07T17:35:00"
additionalInfoobject(ApiCompanyInfoReadDto)

Additional information of the company. See CompanyInfoReadDto.java for structure.

Default:""
posModuleActiveboolean

Indicates if the POS module is active for the company.

Default:false
Example:true
posModuleTrialboolean

Indicates if the POS module is in trial mode for the company.

Default:false
Example:false
Response
{ "id": "", "name": "CLAVEi", "cif": "B12345678", "managementCompanyType": "SELF_EMPLOYED", "emailAddress": "info@clavei.es", "emailHost": "smtp.clavei.es", "emailPort": 587, "emailUsername": "user@clavei.es", "emailPasswordKey": "ENCRYPTED_KEY_123", "emailReplyToAddress": "support@clavei.es", "emailSignature": "", "emailEnableTls": true, "createdBy": "admin", "modifiedBy": "johndoe", "createdOn": "2024-01-03T08:15:45", "modifiedOn": "2024-08-07T17:35:00", "additionalInfo": { "id": "", "code": "C100", "commercialName": "Clavei", "name": "Clavei S.L.", "address": "Avda. Salamanca 7", "country": null, "state": { … }, "postalCode": "03203", "city": "Elche", "phone1": "+34 966 610 442", "phone2": "+34 966 610 443", "email": "info@clavei.es", "website": "https://www.clavei.es", "commercialRegistry": "Volume 1234, Sheet 56, Inscription 1", "observations": "Leading software provider in Alicante", "logo": "logo.png", "logoToken": "token-1a2b3c", "activeB2B": true, "backgroundImage": "background.jpg", "backgroundImageToken": "token-bg", "blockchainAccount": "0x342acbd88491ca", "blockchainPrivateKey": "PRIVKEY123", "ropoCode": "ROPOCODE456", "customerVatType": { … }, "paymentMethod": null, "unitType": { … }, "warehouse": { … }, "rateCode": null, "salesAccount": { … }, "purchasingAccount": { … }, "bank": null, "billingSeriesSale": { … }, "billingSeriesSaleTicket": { … }, "billingSeriesPurchase": { … }, "billingSeriesPurchaseTicket": { … }, "billingSeriesInvoiceDraft": { … }, "currency": null, "shippingTerm": null, "secondaryCurrency": null, "customersAccount": { … }, "suppliersAccount": { … }, "creditorVatAccount": { … }, "debtorVatAccount": { … }, "supInternalOpAccount": { … }, "supRecAccount": { … }, "supAssetsAccount": { … }, "supServicesAccount": { … }, "supImportsAccount": { … }, "supIrpfLeasesAccount": { … }, "supIrpfProfessionalAccount": { … }, "supIrpfAgroAccount": { … }, "outInternalOpAccount": { … }, "outRecAccount": { … }, "outAssetsAccount": { … }, "outServicesAccount": { … }, "outImportsAccount": { … }, "outReverseChargeAccount": { … }, "outWithholdingAccount": { … }, "salesConcept": { … }, "purchasingConcept": { … }, "igic": false, "companyType": "LEGAL_PERSON", "ticketbaiTaxAuthority": "ALAVA", "underEquivalenceSurchargeRegime": true, "numericFormatStyle": "US_WITH_GROUPING", "ticketbaiActive": true, "ticketbaiConditionDate": "2025-01-01", "ticketbaiConditionName": "Clavei S.L.", "ticketbaiConditionVatId": "B12345678", "ticketbaiConditionAddress": "Avda. Salamanca 7, Elche", "defaultInvoiceDescription": "Software development services", "ticketbaiTest": false, "vatOperationType": { … }, "verifactuActive": true, "verifactuTest": false, "verifactuStartDate": "2025-06-01", "verifactuEndDate": "2025-12-31", "receiptConcept": { … }, "purchaseReceiptConcept": { … }, "modeVerifactu": false, "verifactuExemptCause": "SII", "verifactuExemptDate": "2025-07-01", "openingConcept": { … }, "closingConcept": { … }, "operatingClosingConcept": { … }, "amortizationConcept": { … }, "payrollConcept": { … }, "welcomeSurvey": "", "verifactuTrial": false, "accountingExportDateTo": "", "renewVerifactu": false, "renewVerifactuMode": "VERIFACTU", "reportLanguage": "EN", "siiActive": false, "siiStartDate": "", "defaultPurchaseInvoiceDescription": "", "defaultChargedVatPercentage": "", "defaultChargedRecPercentage": "", "defaultSupportedVatPercentage": "", "defaultSupportedRecPercentage": "", "payrollSalaryAccount": { … }, "payrollSsCompanyAccount": { … }, "payrollMealsAccount": { … }, "payrollTransportAccount": { … }, "payrollOvertimeAccount": { … }, "payrollSeveranceAccount": { … }, "payrollSsPayableAccount": { … }, "payrollIrpfAccount": { … }, "payrollPendingRemunerationAccount": { … }, "payrollGarnishmentAccount": { … }, "payrollBankAccount": { … }, "payrollEntryMode": "DETAILED", "defaultPayrollIrpfEpigraph": "01", "subtractPendingToSend": true, "addPendingToReceive": false, "disposalLossAccount": { … }, "disposalProfitAccount": { … }, "disposalConcept": { … } }, "posModuleActive": true, "posModuleTrial": false }