Create business partners

The POST /pic/link/business-partners/create endpoint allows you to create new business partners that will interact with the AppliQloud platform. 👔💼🤝

Authorization

This endpoint requires authentication through Basic Auth with the username and password of the backend that will consume it. To create and configure a backend, follow the backends tutorial

Request parameters

👣 Path

This request does not contain parameters of type Path

🔍 Query

This request does not contain parameters of type Query

💪 Body

JSON Body

{
   "inputs": [
      BusinessPartner
   ]
}

Name	Type	Default	Description
inputs	Array[BusinessPartner]	Required	List of business partners to create

BusinessPartner

{
   "externalId": string,
   "name": string,
   "email": string,
   "identification": BusinessPartnerIdentification,
   "businessPartnerTypeIds": [
      string
   ],
   "contacts":[
      BusinessPartnerContact
   ]
}

Name	Type	Default	Description
externalId	string	Required	Identifier in the external system
name	string	Required	Business partner name
identification	BusinessPartnerIdentification	Required	Identification of the business partner
businessPartnerTypeIds	Array[BusinessPartnerType]	Required	Business partner types
contacts	Array[BusinessPartnerContact]	[]	Contacts of the business partner

---

BusinessPartnerIdentification

Possible values: [COMPANY, PERSON]

---

BusinessPartnerType

Possible values: [VENDOR]

---

BusinessPartnerContact

{
  "firstName": string,
  "lastName": string,
  "email": string
}

Name	Type	Default	Description
firstName	string	Required	Name of the new user
lastName	string	Required	New user's last name
email	string	Required	New user email

info

This object is used to register a new user as a business partner contact. The request will return a status of 400 Bad Request if the email is already associated with an existing user on the AppliQloud platform. Business partner contacts will have access to the transactional data of the business partner.

Examples

🖥️ cURL

curl --location 'https://<identifier>.api.appliqloud.com/pic/link/business-partners/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <token>' \
--data '{
   "inputs": [
      {
         "externalId": "1245",
         "name": "AppliQloud",
         "email": "contact@appliqloud.com",
         "identification": "COMPANY",
         "businessPartnerTypeIds": [
            "VENDOR"
         ],
         "contacts":[
            {
               "firstName": "Juan",
               "lastName": "Pérez",
               "email": "juan.perez@mail.com"
            }
         ]
      }
   ]
}'

caution

Make sure to modify the <identifier> and <token> fields with your company identifier and authentication token respectively.

Responses

✅ 201

The business partners were created successfully

{
   "success": [
      {
         "id": "32",
         "name": "AppliQloud",
         "email": "contact@appliqloud.com",
         "status": "PENDING_COMPLETION",
         "identification": "COMPANY"
         "businessPartnerTypeIds": [
             "VENDOR"
         ],
         "contacts": [
             {
                "userId": "perezj12",
                "notificationChannels": [
                   "EMAIL"
                ]
             }
         ],
         "backendMappings": [
           {
             "backendId": "SAP",
             "externalId": "1245"
           }
         ]
      }
   ],
   "errors": []
}

⚠️ 201 (with errors)

There is an error in the request

{
   "success": [],
   "errors": [
      {
         "traceId": "3095a0a77f80436ba104eb2fc24ba343"
         "cause": "BusinessPartnerAlreadyExistsException",
         "message": "Business partner with external identifier 1246 already exists for backend SAP",
         "context": {
            "backendId": "1246",
            "externalId": "SAP"
         }
      }
   ]
}

🔒 401

Authorization required or credentials are not correct

{
    "traceId": "3095a0a77f80436ba104eb2fc24ba343"
    "request": "POST /pic/business-partners",
    "cause": "UnauthorizedException",
    "message": "Authorization required"
}

🚧 500

Internal application error (contact support@appliqloud.com or open a support ticket)

{
    "traceId": "3095a0a77f80436ba104eb2fc24ba343"
    "request": "POST /pic/business-partners",
    "cause": "InternalServerError",
    "message": "Internal Server Error"
}