Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Operation

Creates a new company in the system.

Rw ui textbox macro
typewarning

Only accessible with permission of pms.integration.profile


Style
table {
width: 100%;
}
body.page-gadget {
padding-top: 20px;
}
.separator{
margin: 5px 0;
}



Div
style background-color: cornflowerblue; color: white; display: inline-block; padding: 5px; border-radius: 3px;

POST



Div
stylebackground-color: #0a2b1d; padding: 10px 1em; display: inline-block; color: white; border-radius: 3px;

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



Request

PropertyTypeRequiredType parameterDefault valueDescription
chainIdIntegertruepath parameter


Example request

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



Body

The body that will be sent in the operation

Insert excerpt
Company
Company
nopaneltrue

Example Body

The body that will be sent in the operation

Code Block
themeDJango
{
      "id": 1022,
      "name": "Gabtype",
 
    "code": "GABTY1",
      "taxId": "844031000",
      "companyEmailList": [
        {
          "id": 1022,           "primary": true,
            "emailAddressType": {
                "id": 1,
                "code": "1",
                "name": "Personal",
                "nameI18n": "Personal"
            },
            "email": "irobinsonrr@etsy.com",
            "remark": null
        }
 
    ],
 
    "companyAddressList": [
        {
 
        "id": 1022,
          "primary": true,
            "communicationLocationType": {
                "id": 1,
                "code": "1",
                "name": "Home",
                "nameI18n": "Home"
            },
            "street": "70 Sage Way",
            "city": "Ogden",
            "stateProvName": "La Coruña",
            "stateProvCode": "ES-C",
            "postalCode": "84403",
            "countryCode": "ES",
            "remark": "Address Remark"
        }
 
    ],
 
    "companyPhoneList": [
        {
          "id": 1022,           "primary": true,
            "phoneLocationType": {
                "id": 6,
                "code": "6",
                "name": "Home",
                "nameI18n": "Home"
            },
            "phoneTechType": {
                "id": 1,
                "code": "1",
                "name": "Voice",
                "nameI18n": "Voice"
            },
            "countryAccessCode": "+34",
            "areaCityCode": "B",
            "phoneNumber": "1-(801)295-4667",
            "extension": "1",
            "remark": "Phone Remark"
        }
 
    ],
      "companyTaxAddress": {
        "id": 1003,
        "communicationLocationType": null,
        "street": "70 Sage Way",
        "city": "Ogden",
        "stateProvName": "Jaén",
        "stateProvCode": "ES-J",
        "municipalityName": null,
        "municipalityCode": null,
        "postalCode": "84403",
        "countryCode": "ES",
        "remark": "Address Remark"
      },
      "remark": "Company Remarks",
 
    "assignedUser": null,
      "profileType": {
        "id": 2,
        "code": "2",
        "name": "Company",
        "nameI18n": "Company",
        "colorCode": "#00ACC1"
 
    },
 
    "companyCustomFieldValueList": [
        {
            "id": null,
            "code": "NATIONAL",
            "name": "National",
            "customFieldId": 5,
            "booleanValue": null,
            "numberValue": null,
            "stringValue": null,
            "dateValue": null,
            "selectValue": null,
            "multiSelectValueList": null
        }

     ],
      "customerProfileList": null,
      "extendedName": null,
 
    "paymentType": {
        "id": 5,
        "code": "AG",
        "name": "Pay Agency Guest"
      },
 
    "payment": null,
 
    "paymentMode": null,
 
    "taxDocumentType": {
        "id": 1,
        "code": "00",
        "name": "National Id Document",
        "nameI18n": "National Id Document"
 
    },
      "chainSource": null,
      "chainSegment": null,
      "chainChannel": null,

     "language": null,
      "chainProfileGroup": null,
 
    "reservationPriceModelType": null
   
}


Response

PropertyTypeRequiredDescription
ResponseApiMessageResponseApiMessagetrueDescription of the response of the success operation


Example response

Code Block
themeDJango
{
  "httpStatus": "201",
  "userMessage": "Success",
  "technicalMessage": "Success company created",
  "errorCode": "0",
  "id": 1
}