Buyer Transfer

Transfers a Buyer object with all its dependencies between Accounts sharing the same External ID.

post

Path parameters

idstringRequired

Body

application/jsontext/jsonapplication/*+json

idstringOptional

auditall ofOptional

$metaall ofOptional

iconstring | nullableOptional

contactall ofOptional

externalIdsall ofOptional

statusall ofOptional

string · enumOptionalPossible values:

addressall ofOptional

taxIdstring | nullableOptional

accountall ofRequired

namestring | nullableOptional

Responses

200

OK

application/json

400

Bad Request

application/json

404

Not Found

application/json

post

HTTPcURLJavaScriptPython

POST /public/v1/accounts/buyers/{id}/transfer HTTP/1.1
Host: api.s1.today
Content-Type: application/json
Accept: */*
Content-Length: 1526

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-08-12T20:50:29.652Z",
      "by": "[Circular Reference]"
    },
    "updated": {
      "at": "2025-08-12T20:50:29.652Z",
      "by": "[Circular Reference]"
    },
    "activated": {
      "at": "2025-08-12T20:50:29.652Z",
      "by": "[Circular Reference]"
    },
    "unassigned": {
      "at": "2025-08-12T20:50:29.652Z",
      "by": "[Circular Reference]"
    },
    "disabled": {
      "at": "2025-08-12T20:50:29.652Z",
      "by": "[Circular Reference]"
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "icon": "text",
  "contact": {
    "name": "text",
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "phone": {
      "prefix": "text",
      "number": "text"
    },
    "user": {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "email": "text",
      "status": "text",
      "phone": {
        "prefix": "text",
        "number": "text"
      },
      "firstName": "text",
      "lastName": "text",
      "icon": "text",
      "lastLoginAt": "2025-08-12T20:50:29.652Z",
      "settings": {
        "cultureCode": "text",
        "languageCode": "text"
      },
      "name": "text",
      "accounts": [
        {
          "id": "text",
          "icon": "text",
          "type": "Client",
          "status": "Active",
          "name": "text"
        }
      ],
      "currentAccount": {
        "id": "text",
        "icon": "text",
        "type": "Client",
        "status": "Active",
        "name": "text"
      }
    }
  },
  "externalIds": {
    "erpCompanyContact": "text",
    "erpCustomer": "text",
    "accountExternalId": "text"
  },
  "status": "text",
  "address": {
    "addressLine1": "text",
    "addressLine2": "text",
    "postCode": "text",
    "city": "text",
    "state": "text",
    "country": "text"
  },
  "taxId": "text",
  "account": {
    "id": "text",
    "icon": "text",
    "type": "Client",
    "status": "Active",
    "name": "text"
  },
  "name": "text",
  "errors": [
    {
      "id": "text",
      "message": "text",
      "parameters": null
    }
  ],
  "sellers": [
    {
      "id": "text",
      "icon": "text",
      "externalId": "text",
      "name": "text"
    }
  ]
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-08-12T20:50:29.652Z",
      "by": "[Circular Reference]"
    },
    "updated": {
      "at": "2025-08-12T20:50:29.652Z",
      "by": "[Circular Reference]"
    },
    "activated": {
      "at": "2025-08-12T20:50:29.652Z",
      "by": "[Circular Reference]"
    },
    "unassigned": {
      "at": "2025-08-12T20:50:29.652Z",
      "by": "[Circular Reference]"
    },
    "disabled": {
      "at": "2025-08-12T20:50:29.652Z",
      "by": "[Circular Reference]"
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "icon": "text",
  "contact": {
    "name": "text",
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "phone": {
      "prefix": "text",
      "number": "text"
    },
    "user": {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "email": "text",
      "status": "text",
      "phone": {
        "prefix": "text",
        "number": "text"
      },
      "firstName": "text",
      "lastName": "text",
      "icon": "text",
      "lastLoginAt": "2025-08-12T20:50:29.652Z",
      "settings": {
        "cultureCode": "text",
        "languageCode": "text"
      },
      "name": "text",
      "accounts": [
        {
          "id": "text",
          "icon": "text",
          "type": "Client",
          "status": "Active",
          "name": "text"
        }
      ],
      "currentAccount": {
        "id": "text",
        "icon": "text",
        "type": "Client",
        "status": "Active",
        "name": "text"
      }
    }
  },
  "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",
    "icon": "text",
    "type": "Client",
    "status": "Active",
    "name": "text"
  },
  "name": "text",
  "errors": [
    {
      "id": "text",
      "message": "text",
      "parameters": null
    }
  ],
  "sellers": [
    {
      "id": "text",
      "icon": "text",
      "externalId": "text",
      "name": "text"
    }
  ]
}