v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

Create Counterparty

Create a new counterparty.

post/counterparties

Request body

namestring required

A human friendly name for this counterparty.

emailstring

An optional email to assign to the counterparty.

metadatastring json

Metadata to be added to the counterparty. Must be a JSON object.

send_remittance_adviceboolean

taxpayer_identifierstring

Valid tax payer ID for counterparty's region.

accountingobject

An object of references to auto-sync the counterparty to your accounting system. Can send type which is either customer or vendor.

legal_entity_idstring

external_idstring

An optional user-defined 180 character unique identifier

Response

201

idstring

objectstring

namestring

emailstring

metadataobject

created_atstring

updated_atstring

Example response

{
  "id": "928db55e-6552-4aaf-96d7-10c693922b1f",
  "object": "counterparty",
  "name": "John Smith",
  "email": "abby@marquardtschuppe.net",
  "accounts": [
    {
      "id": "c8d059bc-e781-4528-9359-d46eaaa7f953",
      "party_name": "John Smith",
      "party_type": "business",
      "account_details": [
        {
          "id": "3036a533-53ad-4e58-ba30-33c4d75c0c57",
          "account_number_safe": "1291"
        }
      ],
      "routing_details": [
        {
          "id": "e8626e0b-2687-4b0d-9f2c-68a4c29ee5f1",
          "routing_number": "121141822",
          "routing_number_type": "aba"
        }
      ]
    }
  ],
  "created_at": "2019-11-09T00:11:07Z",
  "updated_at": "2019-11-09T00:11:07Z"
}