Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

Operation

Creates a new company in the system.

POST
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/company


Request

PropertyTypeRequiredDefault valueDescription
chainIdIntegertrue

Example request

POST https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/company


Body

The body that will be sent in the operation


FieldTypeRequiredDescription
idinttrue (only in UPDATE proccess)Id of the Company.
namestringtrueName of the Company.
codestringtrueGenerated code from the name of the company.
taxIdstringtrueTaxId of the Company.

companyEmailList

List of CompanyEmailfalse

companyAddressList

List of CompanyAddressfalse

companyPhoneList

List of CompanyPhonefalse

companyTaxAddress

CompanyTaxAddressfalse
remarkStringfalse
assignedUserUserfalseonly show: userName
profileTypeprofileTypefalse
companyCustomFieldValueListList of CompanyCustomFieldValuefalse
customerProfileListList of CustomerProfile

false


extendedNameStringfalse
paymentTypePaymentTypefalse
paymentPaymentfalse
paymentModePaymentModefalse
taxDocumentTypeTaxDocumentTypefalse
chainSourceChainSourcefalse
chainSegmentChainSegmentfalse
chainChannelChainSegmentfalse
languageLanguagefalse
chainProfileGroupChainProfileGroupfalse
reservationPriceModelTypeReservationPriceModelTypefalse

Example Body

The body that will be sent in the operation

{
  "name": "Tesipro",
  "code": null,
  "taxId": "1234",
  "iataId": null,
  "companyEmailList": [
    {
      "primary": true,
      "emailAddressType": {
        "id": 1,
        "code": "1",
        "name": "Personal"
      },
      "email": "lrossre@microsoft.com",
      "remark": null
    }
  ],
  "companyAddressList": [
    {
      "primary": true,
      "communicationLocationType": {
        "id": 1,
        "code": "1",
        "name": "Home"
      },
      "street": "9 Colorado Junction",
      "city": "Sacramento",
      "stateProvName": "Ciudad Real",
      "stateProvCode": "ES-CR",
      "postalCode": "95818",
      "countryCode": "ES",
      "remark": "Address Remark"
    }
  ],
  "companyPhoneList": [
    {
      "primary": true,
      "phoneLocationType": {
        "id": 6,
        "code": "6",
        "name": "Home"
      },
      "phoneTechType": {
        "id": 1,
        "code": "1",
        "name": "Voice"
      },
      "countryAccessCode": "+34",
      "areaCityCode": "B",
      "phoneNumber": "1-(530)311-9303",
      "extension": "1",
      "remark": "Phone Remark"
    }
  ],
  "companyTaxAddress": {
    "communicationLocationType": null,
    "street": "9 Colorado Junction",
    "city": "Sacramento",
    "stateProvName": "Orense",
    "stateProvCode": "ES-OR",
    "postalCode": "95818",
    "countryCode": "ES",
    "remark": "Address Remark"
  },
  "remark": "Company Remarks"
}

Response

PropertyTypeRequiredDescription
ResponseApiMessageResponseApiMessagetrueDescription of the response of the success operation

Example response

{
  "httpStatus": "201",
  "userMessage": "Success",
  "technicalMessage": "Success company created",
  "errorCode": "0",
  "id": 1
}
  • No labels