company-controller

Operations

getCompanyInfoCompany

Request

No request data

GET

/api/v1/company

curl -i -X GET \
  https://api.prana.software/api/v1/company

Responses

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
}