Create buyer

Creates a new Buyer object for the client account.

post

Body

multipart/form-dataapplication/json

logostring · binaryOptional

Responses

201

Created

application/json

idstringOptional

namestringOptional

iconstring · nullableOptional

revisioninteger · int32Optional

statusstring · enumOptionalPossible values:

taxIdstring · nullableOptional

400

Bad Request

application/json

post/public/v1/accounts/buyers

HTTPcURLJavaScriptPython

POST /public/v1/accounts/buyers HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 12240

{
  "buyer": {
    "ExternalIds.ErpCompanyContact": "text",
    "ExternalIds.ErpCustomer": "text",
    "ExternalIds.AccountExternalId": "text",
    "Status": "Active",
    "Address.AddressLine1": "text",
    "Address.AddressLine2": "text",
    "Address.PostCode": "text",
    "Address.City": "text",
    "Address.State": "text",
    "Address.Country": "text",
    "TaxId": "text",
    "Account.ExternalIds.PyraTenantId": "123e4567-e89b-12d3-a456-426614174000",
    "Account.ExternalId": "text",
    "Account.ExternalName": "text",
    "Account.Address.AddressLine1": "text",
    "Account.Address.AddressLine2": "text",
    "Account.Address.PostCode": "text",
    "Account.Address.City": "text",
    "Account.Address.State": "text",
    "Account.Address.Country": "text",
    "Account.TechnicalSupportEmail": "text",
    "Account.Website": "text",
    "Account.Description": "text",
    "Account.Groups": [
      {
        "id": "text",
        "audit": {
          "created": {
            "at": "2026-08-07T19:11:13.291Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "updated": {
            "at": "2026-08-07T19:11:13.291Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "revision": 1,
        "description": "text",
        "account": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1,
          "type": "Client",
          "status": "Active"
        },
        "modules": [
          {
            "id": "text",
            "name": "text",
            "revision": 1,
            "description": "text",
            "filters": {
              "group.buyers": [
                "text"
              ]
            },
            "settings": {
              "configurable": true,
              "default": true,
              "paid": true,
              "type": [
                "text"
              ],
              "obsolete": true,
              "eligibility": {
                "multi": true,
                "single": true
              }
            }
          }
        ],
        "logo": "text",
        "isDefault": true,
        "users": [
          {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        ],
        "extensions": [
          {
            "id": "text",
            "audit": {
              "created": {
                "at": "2026-08-07T19:11:13.291Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "updated": {
                "at": "2026-08-07T19:11:13.291Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              }
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "name": "text",
            "icon": "text",
            "revision": 1,
            "status": "Draft"
          }
        ],
        "buyers": [
          {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        ]
      }
    ],
    "Account.Eligibility.Client": true,
    "Account.Eligibility.Partner": true,
    "Account.DefaultLanguageCode": "text",
    "Account.Type": "Client",
    "Account.Status": "Active",
    "Account.Metadata.OmittedProperties": [
      "text"
    ],
    "Account.Name": "text",
    "Account.Icon": "text",
    "Account.Revision": 1,
    "Account.Audit.Created.At": "2026-08-07T19:11:13.291Z",
    "Account.Audit.Created.ById": "text",
    "Account.Audit.Created.By.Type": "User",
    "Account.Audit.Created.By.Metadata.OmittedProperties": [
      "text"
    ],
    "Account.Audit.Created.By.Name": "text",
    "Account.Audit.Created.By.Icon": "text",
    "Account.Audit.Created.By.Revision": 1,
    "Account.Audit.Created.By.Audit.Created": {
      "at": "2026-08-07T19:11:13.291Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "Account.Audit.Created.By.Audit.Updated.At": "2026-08-07T19:11:13.291Z",
    "Account.Audit.Created.By.Audit.Updated.ById": "text",
    "Account.Audit.Created.By.Audit.Updated.By": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-08-07T19:11:13.291Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-08-07T19:11:13.291Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1
    },
    "Account.Audit.Created.By.Id": "text",
    "Account.Audit.Updated.At": "2026-08-07T19:11:13.291Z",
    "Account.Audit.Updated.ById": "text",
    "Account.Audit.Updated.By.Type": "User",
    "Account.Audit.Updated.By.Metadata.OmittedProperties": [
      "text"
    ],
    "Account.Audit.Updated.By.Name": "text",
    "Account.Audit.Updated.By.Icon": "text",
    "Account.Audit.Updated.By.Revision": 1,
    "Account.Audit.Updated.By.Audit.Created.At": "2026-08-07T19:11:13.291Z",
    "Account.Audit.Updated.By.Audit.Created.ById": "text",
    "Account.Audit.Updated.By.Audit.Created.By": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-08-07T19:11:13.291Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-08-07T19:11:13.291Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1
    },
    "Account.Audit.Updated.By.Audit.Updated": {
      "at": "2026-08-07T19:11:13.291Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "Account.Audit.Updated.By.Id": "text",
    "Account.Id": "text",
    "Errors": [
      {
        "id": "text",
        "message": "text",
        "parameters": null
      }
    ],
    "Sellers": [
      {
        "id": "text",
        "audit": {
          "created": {
            "at": "2026-08-07T19:11:13.291Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "updated": {
            "at": "2026-08-07T19:11:13.291Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "icon": "text",
        "revision": 1,
        "externalId": "text",
        "status": "Active",
        "currencies": [
          {
            "value": "text",
            "billingEnabled": true,
            "isDefault": true
          }
        ],
        "address": {
          "addressLine1": "text",
          "addressLine2": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "erpLink": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1,
          "companyName": "text",
          "status": "Active"
        },
        "attributes": {
          "navision": null
        }
      }
    ],
    "ErpLinks": [
      {
        "id": "text",
        "audit": {
          "created": {
            "at": "2026-08-07T19:11:13.291Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "updated": {
            "at": "2026-08-07T19:11:13.291Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "blocked": {
            "at": "2026-08-07T19:11:13.291Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "unblocked": {
            "at": "2026-08-07T19:11:13.291Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "disabled": {
            "at": "2026-08-07T19:11:13.291Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "icon": "text",
        "revision": 1,
        "buyer": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        },
        "seller": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1,
          "externalId": "text"
        },
        "companyName": "text",
        "status": "Active",
        "note": "text",
        "externalIds": {
          "erpCompanyContact": "text",
          "erpCustomer": "text",
          "accountExternalId": "text"
        },
        "address": {
          "addressLine1": "text",
          "addressLine2": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "shipTo": [
          {
            "addressLine1": "text",
            "addressLine2": "text",
            "postCode": "text",
            "city": "text",
            "state": "text",
            "country": "text",
            "externalId": "text",
            "name": "text"
          }
        ],
        "billTo": [
          {
            "addressLine1": "text",
            "addressLine2": "text",
            "postCode": "text",
            "city": "text",
            "state": "text",
            "country": "text",
            "externalId": "text",
            "name": "text"
          }
        ]
      }
    ],
    "Metadata.OmittedProperties": [
      "text"
    ],
    "Name": "text",
    "Icon": "text",
    "Revision": 1,
    "Audit.Activated.At": "2026-08-07T19:11:13.291Z",
    "Audit.Activated.ById": "text",
    "Audit.Activated.By.Type": "User",
    "Audit.Activated.By.Metadata.OmittedProperties": [
      "text"
    ],
    "Audit.Activated.By.Name": "text",
    "Audit.Activated.By.Icon": "text",
    "Audit.Activated.By.Revision": 1,
    "Audit.Activated.By.Audit.Created.At": "2026-08-07T19:11:13.291Z",
    "Audit.Activated.By.Audit.Created.ById": "text",
    "Audit.Activated.By.Audit.Created.By": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-08-07T19:11:13.291Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-08-07T19:11:13.291Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1
    },
    "Audit.Activated.By.Audit.Updated.At": "2026-08-07T19:11:13.291Z",
    "Audit.Activated.By.Audit.Updated.ById": "text",
    "Audit.Activated.By.Audit.Updated.By": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-08-07T19:11:13.291Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-08-07T19:11:13.291Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1
    },
    "Audit.Activated.By.Id": "text",
    "Audit.Unassigned.At": "2026-08-07T19:11:13.291Z",
    "Audit.Unassigned.ById": "text",
    "Audit.Unassigned.By.Type": "User",
    "Audit.Unassigned.By.Metadata.OmittedProperties": [
      "text"
    ],
    "Audit.Unassigned.By.Name": "text",
    "Audit.Unassigned.By.Icon": "text",
    "Audit.Unassigned.By.Revision": 1,
    "Audit.Unassigned.By.Audit.Created.At": "2026-08-07T19:11:13.291Z",
    "Audit.Unassigned.By.Audit.Created.ById": "text",
    "Audit.Unassigned.By.Audit.Created.By": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-08-07T19:11:13.291Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-08-07T19:11:13.291Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1
    },
    "Audit.Unassigned.By.Audit.Updated.At": "2026-08-07T19:11:13.291Z",
    "Audit.Unassigned.By.Audit.Updated.ById": "text",
    "Audit.Unassigned.By.Audit.Updated.By": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-08-07T19:11:13.291Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-08-07T19:11:13.291Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1
    },
    "Audit.Unassigned.By.Id": "text",
    "Audit.Disabled.At": "2026-08-07T19:11:13.291Z",
    "Audit.Disabled.ById": "text",
    "Audit.Disabled.By.Type": "User",
    "Audit.Disabled.By.Metadata.OmittedProperties": [
      "text"
    ],
    "Audit.Disabled.By.Name": "text",
    "Audit.Disabled.By.Icon": "text",
    "Audit.Disabled.By.Revision": 1,
    "Audit.Disabled.By.Audit.Created.At": "2026-08-07T19:11:13.291Z",
    "Audit.Disabled.By.Audit.Created.ById": "text",
    "Audit.Disabled.By.Audit.Created.By": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-08-07T19:11:13.291Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-08-07T19:11:13.291Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1
    },
    "Audit.Disabled.By.Audit.Updated.At": "2026-08-07T19:11:13.291Z",
    "Audit.Disabled.By.Audit.Updated.ById": "text",
    "Audit.Disabled.By.Audit.Updated.By": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-08-07T19:11:13.291Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-08-07T19:11:13.291Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1
    },
    "Audit.Disabled.By.Id": "text",
    "Audit.Created.At": "2026-08-07T19:11:13.291Z",
    "Audit.Created.ById": "text",
    "Audit.Created.By.Type": "User",
    "Audit.Created.By.Metadata.OmittedProperties": [
      "text"
    ],
    "Audit.Created.By.Name": "text",
    "Audit.Created.By.Icon": "text",
    "Audit.Created.By.Revision": 1,
    "Audit.Created.By.Audit.Created.At": "2026-08-07T19:11:13.291Z",
    "Audit.Created.By.Audit.Created.ById": "text",
    "Audit.Created.By.Audit.Created.By": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-08-07T19:11:13.291Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-08-07T19:11:13.291Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1
    },
    "Audit.Created.By.Audit.Updated.At": "2026-08-07T19:11:13.291Z",
    "Audit.Created.By.Audit.Updated.ById": "text",
    "Audit.Created.By.Audit.Updated.By": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-08-07T19:11:13.291Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-08-07T19:11:13.291Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1
    },
    "Audit.Created.By.Id": "text",
    "Audit.Updated.At": "2026-08-07T19:11:13.291Z",
    "Audit.Updated.ById": "text",
    "Audit.Updated.By.Type": "User",
    "Audit.Updated.By.Metadata.OmittedProperties": [
      "text"
    ],
    "Audit.Updated.By.Name": "text",
    "Audit.Updated.By.Icon": "text",
    "Audit.Updated.By.Revision": 1,
    "Audit.Updated.By.Audit.Created.At": "2026-08-07T19:11:13.291Z",
    "Audit.Updated.By.Audit.Created.ById": "text",
    "Audit.Updated.By.Audit.Created.By": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-08-07T19:11:13.291Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-08-07T19:11:13.291Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1
    },
    "Audit.Updated.By.Audit.Updated.At": "2026-08-07T19:11:13.291Z",
    "Audit.Updated.By.Audit.Updated.ById": "text",
    "Audit.Updated.By.Audit.Updated.By": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-08-07T19:11:13.291Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-08-07T19:11:13.291Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1
    },
    "Audit.Updated.By.Id": "text",
    "Id": "text"
  },
  "logo": "binary"
}

multipart/form-dataapplication/json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-08-07T19:11:13.291Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-08-07T19:11:13.291Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "activated": {
      "at": "2026-08-07T19:11:13.291Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "unassigned": {
      "at": "2026-08-07T19:11:13.291Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "disabled": {
      "at": "2026-08-07T19:11:13.291Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "icon": "text",
  "revision": 1,
  "externalIds": {
    "erpCompanyContact": "text",
    "erpCustomer": "text",
    "accountExternalId": "text"
  },
  "status": "Active",
  "address": {
    "addressLine1": "text",
    "addressLine2": "text",
    "postCode": "text",
    "city": "text",
    "state": "text",
    "country": "text"
  },
  "taxId": "text",
  "account": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  },
  "errors": [
    {
      "id": "text",
      "message": "text",
      "parameters": null
    }
  ],
  "sellers": [
    {
      "id": "text",
      "name": "text",
      "icon": "text",
      "revision": 1,
      "externalId": "text"
    }
  ]
}