# The purpose of this API is to add a new partner

Permissions needed - organizations.billing.admin (This is for backward compatibility and will be deprecated soon) ,partners.create (This is the required permission to create a partner)

Endpoint: POST /api/v2/partners
Version: 1.0
Security: bearer

## Query parameters:

  - `createApptivoAccount` (string)
    Enum: "true", "false"

  - `createBillDotComProfile` (string)
    Enum: "true", "false"

## Request fields (application/json):

  - `organization` (object, required)

  - `organization.legacyIdentifier` (string)
    Example: "ae23fba4-f740-4d74-bbd6-80beee24f8f2"

  - `organization.parentId` (string)
    Example: "5a1bc4c5-520f-4637-acac-99412fd97509"

  - `organization.type` (string)
    Enum: "1", "2"

  - `organization.hcoXrefId` (string)
    Example: "string"

  - `organization.businessName` (string, required)
    Example: "string"

  - `organization.displayName` (string, required)
    Example: "string"

  - `organization.integrationMetadata` (object)

  - `organization.integrationMetadata.key` (object)
    Example: {"key1":"value1","key2":"value2"}

  - `organization.addresses` (array)

  - `organization.addresses.addressLine1` (string)
    Example: "252 Lomas Santa Fe Dr Suite 290"

  - `organization.addresses.addressLine2` (string)
    Example: "Behind times square garden"

  - `organization.addresses.stateProvinceCode` (string)
    Example: "AL"

  - `organization.addresses.city` (string)
    Example: "San Diego"

  - `organization.addresses.postalCode` (string)
    Example: "92075"

  - `organization.addresses.countryCode` (string)
    Example: "US"

  - `organization.addresses.regionCode` (string)
    Enum: "US", "EU"

  - `organization.addresses.addressType` (number, required)
    Example: 1

  - `organization.phoneNumbers` (array)

  - `organization.phoneNumbers.extension` (string)
    Example: "string"

  - `organization.phoneNumbers.phoneNumber` (string)
    Example: "string"

  - `organization.phoneNumbers.phoneType` (number, required)
    Example: 1

  - `organization.originationSource` (string, required)
    Enum: "CRM", "ADDI"

  - `organization.onBoardingStatus` (number)
    status: 1 indicates "Not Started",
        status: 2 indicates "Welcome Call",
        status: 3 indicates "Partner Education",
        status: 4 indicates "Completed",

  - `organization.organizationStatus` (number)
    status: 1 indicates "Contracted",
        status: 2 indicates "Active",
        status: 3 indicates "Suspended",
        status: 4 indicates "Separated"

  - `organization.rrmsSiteGroupId` (string)
    Example: "string"

  - `organization.signOnDate` (string)
    Example: "2026-03-04T17:27:05.253Z"

  - `organization.timezoneId` (string)
    Example: "string"

  - `organization.actionPlanCode` (string)
    Example: "11011"

  - `organization.vendorProfileIds` (array)
    Example: ["e596d9f2-0642-4575-897a-8cdb9c18c882"]

  - `organization.onBoardingPartnerId` (string)
    Example: "7bfbe222-e8db-4305-86ee-38eddc7df552"

  - `partnerCriteria` (object, required)

  - `partnerCriteria.partnerTypeId` (string, required)
    Example: "e8d2d255-3e62-413f-9275-e8929eced814"

  - `partnerCriteria.onboardingDate` (string)
    Should be of type - yyyy-MM-dd
    Example: "2026-03-04"

  - `partnerCriteria.enableCommissions` (boolean)

  - `partnerCriteria.w9Submitted` (boolean)

  - `partnerCriteria.isW2` (boolean)

  - `partnerCriteria.status` (string)
    field has been deprecated

  - `partnerCriteria.commissionPayoutStatus` (string)
    field has been deprecated
    Enum: "active", "inactive", "blocked", "pending-cutoff", "under-charge-back"

  - `partnerCriteria.deactivatedDate` (string)
    field has been deprecated
    Example: "2026-03-04"

  - `partnerCriteria.salesCutOffDate` (string)
    field has been deprecated
    Example: "2026-03-04"

  - `vendorAccount` (object)

  - `vendorAccount.currency` (string)
    Three-letter abbreviation. This field is required for enabling electronic payments to vendors. (e.g., USD, EUR).

  - `vendorAccount.accountNumber` (string)
    User account number set by the vendor. When you pay the vendor, this value appears on the check memo or electronic payment record. (optional).
    Example: "1234567890"

  - `vendorAccount.email` (string)
    The vendor's email address (optional).
    Example: "email@test.com"

  - `vendorAccount.bankAccount` (object)
    Bank account details for the vendor, including payee name, account number, and routing number.

  - `vendorAccount.bankAccount.paymentPurpose` (object)
    Details of the payment purpose (optional).

  - `vendorAccount.bankAccount.paymentPurpose.code` (object, required)
    The purpose of the payment, such as 'Invoice Payment' or 'Refund'.

  - `vendorAccount.bankAccount.paymentPurpose.code.name` (string, required)
    The name of the payment purpose, e.g., 'Invoice Payment', 'Refund', etc.
    Example: "string"

  - `vendorAccount.bankAccount.paymentPurpose.text` (string)
    An optional description or further text related to the payment purpose.
    Example: "OPTIONAL"

  - `vendorAccount.bankAccount.type` (string, required)
    The type of the vendor's bank account (e.g., 'CHECKING' or 'SAVINGS').
    Enum: "CHECKING", "SAVINGS"

  - `vendorAccount.bankAccount.payeeName` (string, required)
    The name of the payee on the bank account.
    Example: "string"

  - `vendorAccount.bankAccount.nameOnAccount` (string)
    The name on the bank account (optional).
    Example: "string"

  - `vendorAccount.bankAccount.accountNumber` (string, required)
    Vendor bank account number. This field is required for enabling electronic payments to vendors. (required).
    Example: "1234567890"

  - `vendorAccount.bankAccount.routingNumber` (string, required)
    The bank account routing number (optional).
    Example: "021000021"

  - `vendorAccount.bankAccount.regulatoryFields` (array)
    List of regulatory fields that may apply to the account, such as tax ID or SWIFT code.

  - `vendorAccount.bankAccount.regulatoryFields.name` (string, required)
    The name of the regulatory field, e.g., 'SWIFT Code', 'Tax ID'.
    Example: "string"

  - `vendorAccount.bankAccount.regulatoryFields.value` (string, required)
    The value associated with the regulatory field, e.g., 'US12345', 'ABCD1234'.
    Example: "string"

## Response 201 fields (application/json):

  - `id` (string, required)
    Example: "854e27cb-7ddd-4c0f-950d-1d60bc9e0cb9"

  - `type` (string, required)
    Example: "string"

  - `status` (string)
    Example: "string"

  - `hcoXrefId` (string)
    Example: "string"

  - `businessName` (string, required)
    Example: "string"

  - `displayName` (string, required)
    Example: "string"

  - `integrationMetadata` (object)
    Example: {"key":"value"}

  - `nodes` (array, required)
    Example: ["a60dbf9d-2963-4256-9019-94296a81cb1c"]

  - `ancestryNodes` (array, required)
    Example: ["289fe665-e0aa-4eab-9440-cdbfbd9afdee"]

  - `originationSource` (string, required)
    Example: "string"

  - `onBoardingStatus` (number, required)
    Example: 1

  - `organizationStatus` (number, required)
    Example: 1

  - `rrmsSiteGroupId` (string)
    Example: "974ad49c-2a0c-4a88-b25a-5852047b3407"

  - `timezoneId` (string)
    Example: "string"

  - `archiveInfo` (object, required)

  - `archiveInfo.archived` (boolean)

  - `archiveInfo.archivedStatusChangedAt` (string)
    Example: "2026-03-04T17:27:05.147Z"

  - `auditInfo` (object, required)

  - `auditInfo.createdAt` (string)
    Example: "2026-03-04T17:27:05.145Z"

  - `auditInfo.createdBy` (string)
    Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"

  - `auditInfo.updatedAt` (string)
    Example: "2026-03-04T17:27:05.146Z"

  - `auditInfo.updatedBy` (string)
    Example: "1372b691-af02-4b90-945a-c6351e785879"

  - `activeInfo` (object, required)

  - `activeInfo.active` (boolean, required)
    Example: true

  - `activeInfo.activeStatusChangedAt` (string, required)
    Example: "2026-03-04T17:27:05.147Z"

  - `party` (object)

  - `party.id` (string, required)
    Example: "c182ed73-7b78-4d27-a14b-e30acf7f4104"

  - `party.legacyIdentifier` (string, required)
    Example: "string"

  - `party.archiveInfo` (object, required)

  - `party.archiveInfo.archived` (boolean)

  - `party.archiveInfo.archivedStatusChangedAt` (string)
    Example: "2026-03-04T17:27:05.147Z"

  - `party.auditInfo` (object, required)

  - `party.auditInfo.createdAt` (string)
    Example: "2026-03-04T17:27:05.145Z"

  - `party.auditInfo.createdBy` (string)
    Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"

  - `party.auditInfo.updatedAt` (string)
    Example: "2026-03-04T17:27:05.146Z"

  - `party.auditInfo.updatedBy` (string)
    Example: "1372b691-af02-4b90-945a-c6351e785879"

  - `party.activeInfo` (object, required)

  - `party.activeInfo.active` (boolean, required)
    Example: true

  - `party.activeInfo.activeStatusChangedAt` (string, required)
    Example: "2026-03-04T17:27:05.147Z"

  - `party.phoneNumbers` (array, required)

  - `party.phoneNumbers.id` (string, required)
    Example: "2674269e-d3b2-4cd0-a693-20953b1818b9"

  - `party.phoneNumbers.phoneType` (number, required)
    Example: "1"

  - `party.phoneNumbers.phoneNumber` (string, required)
    Example: "string"

  - `party.phoneNumbers.extension` (string, required)
    Example: "string"

  - `party.addresses` (array, required)

  - `party.addresses.id` (string, required)
    Example: "d8036c26-3113-44be-ba4f-f60934b8eab1"

  - `party.addresses.addressType` (number, required)
    Example: 1

  - `party.addresses.addressLine1` (string)
    Example: "252 Lomas Santa Fe Dr Suite 290"

  - `party.addresses.addressLine2` (string)
    Example: "Behind times square garden"

  - `party.addresses.stateProvinceCode` (string)
    Example: "AL"

  - `party.addresses.stateProvinceName` (string)
    Example: "Alabama"

  - `party.addresses.city` (string)
    Example: "San Diego"

  - `party.addresses.postalCode` (string)
    Example: "92075"

  - `party.addresses.countryCode` (string)
    Example: "US"

  - `party.addresses.countryName` (string)
    Example: "United States"

  - `party.addresses.regionCode` (string)
    Enum: "US", "EU"

  - `party.addresses.regionName` (string)
    Example: "United States"

  - `party.addresses.auditInfo` (object, required)

  - `party.addresses.auditInfo.createdAt` (string)
    Example: "2026-03-04T17:27:05.145Z"

  - `party.addresses.auditInfo.createdBy` (string)
    Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"

  - `party.addresses.auditInfo.updatedAt` (string)
    Example: "2026-03-04T17:27:05.146Z"

  - `party.addresses.auditInfo.updatedBy` (string)
    Example: "1372b691-af02-4b90-945a-c6351e785879"

  - `signOnDate` (string)
    Example: "2026-03-04T17:27:05.269Z"

  - `actionPlanCode` (string)
    Example: "string"

  - `customerId` (string)
    Example: "string"

  - `partnerCriteria` (object)

  - `partnerCriteria.id` (string, required)
    Example: "2faa49d6-1f60-452b-a6b8-a8b3acb8f384"

  - `partnerCriteria.partnerType` (object, required)

  - `partnerCriteria.partnerType.id` (string, required)
    Example: "1e01f3be-d88a-42a0-bbd3-09fc8aa3bc4d"

  - `partnerCriteria.partnerType.name` (string, required)
    Example: "string"

  - `partnerCriteria.partnerType.code` (string, required)
    Example: "string"

  - `partnerCriteria.partnerType.description` (string)
    Example: "string"

  - `partnerCriteria.partnerType.allowSelfParenting` (boolean)

  - `partnerCriteria.partnerType.ancestryMetadata` (object)

  - `partnerCriteria.partnerType.ancestryMetadata.groups` (array, required)
    List of ancestry groups in the response

  - `partnerCriteria.partnerType.ancestryMetadata.groups.items` (array, required)
    List of ancestry nodes in this group

  - `partnerCriteria.partnerType.ancestryMetadata.groups.items.level` (number, required)
    The level of the ancestry node in the hierarchy
    Example: 1

  - `partnerCriteria.partnerType.ancestryMetadata.groups.items.id` (string, required)
    The unique identifier of the ancestry node
    Example: "c977309b-3b1f-454b-968f-38444871ef18"

  - `partnerCriteria.partnerType.ancestryMetadata.groups.totalItems` (number, required)
    The total count of nodes in this ancestry group
    Example: 4

  - `partnerCriteria.partnerType.ancestryMetadata.totalGroups` (number, required)
    Total number of ancestry groups
    Example: 2

  - `partnerCriteria.partnerType.apptivoValueId` (string)
    Example: "string"

  - `partnerCriteria.partnerType.auditInfo` (object, required)

  - `partnerCriteria.partnerType.auditInfo.createdAt` (string)
    Example: "2026-03-04T17:27:05.145Z"

  - `partnerCriteria.partnerType.auditInfo.createdBy` (string)
    Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"

  - `partnerCriteria.partnerType.auditInfo.updatedAt` (string)
    Example: "2026-03-04T17:27:05.146Z"

  - `partnerCriteria.partnerType.auditInfo.updatedBy` (string)
    Example: "1372b691-af02-4b90-945a-c6351e785879"

  - `partnerCriteria.partnerType.activeInfo` (object, required)

  - `partnerCriteria.partnerType.activeInfo.active` (boolean, required)
    Example: true

  - `partnerCriteria.partnerType.activeInfo.activeStatusChangedAt` (string, required)
    Example: "2026-03-04T17:27:05.147Z"

  - `partnerCriteria.partnerType.archiveInfo` (object, required)

  - `partnerCriteria.partnerType.archiveInfo.archived` (boolean)

  - `partnerCriteria.partnerType.archiveInfo.archivedStatusChangedAt` (string)
    Example: "2026-03-04T17:27:05.147Z"

  - `partnerCriteria.partnerType.parentPartnerTypes` (array)

  - `partnerCriteria.partnerType.parentPartnerTypes.id` (string, required)
    Example: "1e01f3be-d88a-42a0-bbd3-09fc8aa3bc4d"

  - `partnerCriteria.partnerType.parentPartnerTypes.name` (string, required)
    Example: "string"

  - `partnerCriteria.partnerType.parentPartnerTypes.code` (string, required)
    Example: "string"

  - `partnerCriteria.partnerType.parentPartnerTypes.description` (string)
    Example: "string"

  - `partnerCriteria.partnerType.parentPartnerTypes.allowSelfParenting` (boolean)

  - `partnerCriteria.partnerType.parentPartnerTypes.ancestryMetadata` (object)

  - `partnerCriteria.partnerType.parentPartnerTypes.ancestryMetadata.groups` (array, required)
    List of ancestry groups in the response

  - `partnerCriteria.partnerType.parentPartnerTypes.ancestryMetadata.groups.items` (array, required)
    List of ancestry nodes in this group

  - `partnerCriteria.partnerType.parentPartnerTypes.ancestryMetadata.groups.items.level` (number, required)
    The level of the ancestry node in the hierarchy
    Example: 1

  - `partnerCriteria.partnerType.parentPartnerTypes.ancestryMetadata.groups.items.id` (string, required)
    The unique identifier of the ancestry node
    Example: "c977309b-3b1f-454b-968f-38444871ef18"

  - `partnerCriteria.partnerType.parentPartnerTypes.ancestryMetadata.groups.totalItems` (number, required)
    The total count of nodes in this ancestry group
    Example: 4

  - `partnerCriteria.partnerType.parentPartnerTypes.ancestryMetadata.totalGroups` (number, required)
    Total number of ancestry groups
    Example: 2

  - `partnerCriteria.partnerType.parentPartnerTypes.apptivoValueId` (string)
    Example: "string"

  - `partnerCriteria.partnerType.parentPartnerTypes.auditInfo` (object, required)

  - `partnerCriteria.partnerType.parentPartnerTypes.auditInfo.createdAt` (string)
    Example: "2026-03-04T17:27:05.145Z"

  - `partnerCriteria.partnerType.parentPartnerTypes.auditInfo.createdBy` (string)
    Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"

  - `partnerCriteria.partnerType.parentPartnerTypes.auditInfo.updatedAt` (string)
    Example: "2026-03-04T17:27:05.146Z"

  - `partnerCriteria.partnerType.parentPartnerTypes.auditInfo.updatedBy` (string)
    Example: "1372b691-af02-4b90-945a-c6351e785879"

  - `partnerCriteria.partnerType.parentPartnerTypes.activeInfo` (object, required)

  - `partnerCriteria.partnerType.parentPartnerTypes.activeInfo.active` (boolean, required)
    Example: true

  - `partnerCriteria.partnerType.parentPartnerTypes.activeInfo.activeStatusChangedAt` (string, required)
    Example: "2026-03-04T17:27:05.147Z"

  - `partnerCriteria.partnerType.parentPartnerTypes.archiveInfo` (object, required)

  - `partnerCriteria.partnerType.parentPartnerTypes.archiveInfo.archived` (boolean)

  - `partnerCriteria.partnerType.parentPartnerTypes.archiveInfo.archivedStatusChangedAt` (string)
    Example: "2026-03-04T17:27:05.147Z"

  - `partnerCriteria.partnerType.childPartnerTypes` (array)

  - `partnerCriteria.partnerType.childPartnerTypes.id` (string, required)
    Example: "1e01f3be-d88a-42a0-bbd3-09fc8aa3bc4d"

  - `partnerCriteria.partnerType.childPartnerTypes.name` (string, required)
    Example: "string"

  - `partnerCriteria.partnerType.childPartnerTypes.code` (string, required)
    Example: "string"

  - `partnerCriteria.partnerType.childPartnerTypes.description` (string)
    Example: "string"

  - `partnerCriteria.partnerType.childPartnerTypes.allowSelfParenting` (boolean)

  - `partnerCriteria.partnerType.childPartnerTypes.ancestryMetadata` (object)

  - `partnerCriteria.partnerType.childPartnerTypes.ancestryMetadata.groups` (array, required)
    List of ancestry groups in the response

  - `partnerCriteria.partnerType.childPartnerTypes.ancestryMetadata.groups.items` (array, required)
    List of ancestry nodes in this group

  - `partnerCriteria.partnerType.childPartnerTypes.ancestryMetadata.groups.items.level` (number, required)
    The level of the ancestry node in the hierarchy
    Example: 1

  - `partnerCriteria.partnerType.childPartnerTypes.ancestryMetadata.groups.items.id` (string, required)
    The unique identifier of the ancestry node
    Example: "c977309b-3b1f-454b-968f-38444871ef18"

  - `partnerCriteria.partnerType.childPartnerTypes.ancestryMetadata.groups.totalItems` (number, required)
    The total count of nodes in this ancestry group
    Example: 4

  - `partnerCriteria.partnerType.childPartnerTypes.ancestryMetadata.totalGroups` (number, required)
    Total number of ancestry groups
    Example: 2

  - `partnerCriteria.partnerType.childPartnerTypes.apptivoValueId` (string)
    Example: "string"

  - `partnerCriteria.partnerType.childPartnerTypes.auditInfo` (object, required)

  - `partnerCriteria.partnerType.childPartnerTypes.auditInfo.createdAt` (string)
    Example: "2026-03-04T17:27:05.145Z"

  - `partnerCriteria.partnerType.childPartnerTypes.auditInfo.createdBy` (string)
    Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"

  - `partnerCriteria.partnerType.childPartnerTypes.auditInfo.updatedAt` (string)
    Example: "2026-03-04T17:27:05.146Z"

  - `partnerCriteria.partnerType.childPartnerTypes.auditInfo.updatedBy` (string)
    Example: "1372b691-af02-4b90-945a-c6351e785879"

  - `partnerCriteria.partnerType.childPartnerTypes.activeInfo` (object, required)

  - `partnerCriteria.partnerType.childPartnerTypes.activeInfo.active` (boolean, required)
    Example: true

  - `partnerCriteria.partnerType.childPartnerTypes.activeInfo.activeStatusChangedAt` (string, required)
    Example: "2026-03-04T17:27:05.147Z"

  - `partnerCriteria.partnerType.childPartnerTypes.archiveInfo` (object, required)

  - `partnerCriteria.partnerType.childPartnerTypes.archiveInfo.archived` (boolean)

  - `partnerCriteria.partnerType.childPartnerTypes.archiveInfo.archivedStatusChangedAt` (string)
    Example: "2026-03-04T17:27:05.147Z"

  - `partnerCriteria.status` (string)
    Enum: "on-boarded", "active", "inactive", "suspended", "on-hold"

  - `partnerCriteria.commissionPayoutStatus` (string)
    Enum: "active", "inactive", "blocked", "pending-cutoff", "under-charge-back"

  - `partnerCriteria.deactivatedDate` (string)
    Example: "2026-03-04T17:27:05.268Z"

  - `partnerCriteria.onboardingDate` (string)
    Example: "2026-03-04T17:27:05.268Z"

  - `partnerCriteria.salesCutOffDate` (string)
    Example: "2026-03-04T17:27:05.268Z"

  - `partnerCriteria.enableCommissions` (boolean)

  - `partnerCriteria.w9Submitted` (boolean)

  - `partnerCriteria.isW2` (boolean)

  - `partnerCriteria.vendorMetadata` (object)

  - `partnerCriteria.vendorMetadata.vendorId` (string, required)
    BILL-generated ID of the vendor. The value begins with 009.
    Example: "00902NCBVPYCOHO2b47k"

  - `partnerCriteria.vendorMetadata.archived` (boolean, required)
    Set as true if the vendor is archived

  - `partnerCriteria.vendorMetadata.isBankAccountLinked` (boolean, required)
    Indicates whether a bank account is linked to the vendor.
    Example: true

  - `vendorProfiles` (any)

  - `onBoardingPartner` (any)

  - `parentPartner` (any)

  - `subsidiaries` (array)
    Child Partners Details

  - `subsidiaries.id` (string, required)
    Example: "854e27cb-7ddd-4c0f-950d-1d60bc9e0cb9"

  - `subsidiaries.type` (string, required)
    Example: "string"

  - `subsidiaries.status` (string)
    Example: "string"

  - `subsidiaries.hcoXrefId` (string)
    Example: "string"

  - `subsidiaries.businessName` (string, required)
    Example: "string"

  - `subsidiaries.displayName` (string, required)
    Example: "string"

  - `subsidiaries.integrationMetadata` (object)
    Example: {"key":"value"}

  - `subsidiaries.nodes` (array, required)
    Example: ["a60dbf9d-2963-4256-9019-94296a81cb1c"]

  - `subsidiaries.ancestryNodes` (array, required)
    Example: ["289fe665-e0aa-4eab-9440-cdbfbd9afdee"]

  - `subsidiaries.originationSource` (string, required)
    Example: "string"

  - `subsidiaries.onBoardingStatus` (number, required)
    Example: 1

  - `subsidiaries.organizationStatus` (number, required)
    Example: 1

  - `subsidiaries.rrmsSiteGroupId` (string)
    Example: "974ad49c-2a0c-4a88-b25a-5852047b3407"

  - `subsidiaries.timezoneId` (string)
    Example: "string"

  - `subsidiaries.archiveInfo` (object, required)

  - `subsidiaries.archiveInfo.archived` (boolean)

  - `subsidiaries.archiveInfo.archivedStatusChangedAt` (string)
    Example: "2026-03-04T17:27:05.147Z"

  - `subsidiaries.auditInfo` (object, required)

  - `subsidiaries.auditInfo.createdAt` (string)
    Example: "2026-03-04T17:27:05.145Z"

  - `subsidiaries.auditInfo.createdBy` (string)
    Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"

  - `subsidiaries.auditInfo.updatedAt` (string)
    Example: "2026-03-04T17:27:05.146Z"

  - `subsidiaries.auditInfo.updatedBy` (string)
    Example: "1372b691-af02-4b90-945a-c6351e785879"

  - `subsidiaries.activeInfo` (object, required)

  - `subsidiaries.activeInfo.active` (boolean, required)
    Example: true

  - `subsidiaries.activeInfo.activeStatusChangedAt` (string, required)
    Example: "2026-03-04T17:27:05.147Z"

  - `subsidiaries.party` (object)

  - `subsidiaries.party.id` (string, required)
    Example: "c182ed73-7b78-4d27-a14b-e30acf7f4104"

  - `subsidiaries.party.legacyIdentifier` (string, required)
    Example: "string"

  - `subsidiaries.party.archiveInfo` (object, required)

  - `subsidiaries.party.archiveInfo.archived` (boolean)

  - `subsidiaries.party.archiveInfo.archivedStatusChangedAt` (string)
    Example: "2026-03-04T17:27:05.147Z"

  - `subsidiaries.party.auditInfo` (object, required)

  - `subsidiaries.party.auditInfo.createdAt` (string)
    Example: "2026-03-04T17:27:05.145Z"

  - `subsidiaries.party.auditInfo.createdBy` (string)
    Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"

  - `subsidiaries.party.auditInfo.updatedAt` (string)
    Example: "2026-03-04T17:27:05.146Z"

  - `subsidiaries.party.auditInfo.updatedBy` (string)
    Example: "1372b691-af02-4b90-945a-c6351e785879"

  - `subsidiaries.party.activeInfo` (object, required)

  - `subsidiaries.party.activeInfo.active` (boolean, required)
    Example: true

  - `subsidiaries.party.activeInfo.activeStatusChangedAt` (string, required)
    Example: "2026-03-04T17:27:05.147Z"

  - `subsidiaries.party.phoneNumbers` (array, required)

  - `subsidiaries.party.phoneNumbers.id` (string, required)
    Example: "2674269e-d3b2-4cd0-a693-20953b1818b9"

  - `subsidiaries.party.phoneNumbers.phoneType` (number, required)
    Example: "1"

  - `subsidiaries.party.phoneNumbers.phoneNumber` (string, required)
    Example: "string"

  - `subsidiaries.party.phoneNumbers.extension` (string, required)
    Example: "string"

  - `subsidiaries.party.addresses` (array, required)

  - `subsidiaries.party.addresses.id` (string, required)
    Example: "d8036c26-3113-44be-ba4f-f60934b8eab1"

  - `subsidiaries.party.addresses.addressType` (number, required)
    Example: 1

  - `subsidiaries.party.addresses.addressLine1` (string)
    Example: "252 Lomas Santa Fe Dr Suite 290"

  - `subsidiaries.party.addresses.addressLine2` (string)
    Example: "Behind times square garden"

  - `subsidiaries.party.addresses.stateProvinceCode` (string)
    Example: "AL"

  - `subsidiaries.party.addresses.stateProvinceName` (string)
    Example: "Alabama"

  - `subsidiaries.party.addresses.city` (string)
    Example: "San Diego"

  - `subsidiaries.party.addresses.postalCode` (string)
    Example: "92075"

  - `subsidiaries.party.addresses.countryCode` (string)
    Example: "US"

  - `subsidiaries.party.addresses.countryName` (string)
    Example: "United States"

  - `subsidiaries.party.addresses.regionCode` (string)
    Enum: "US", "EU"

  - `subsidiaries.party.addresses.regionName` (string)
    Example: "United States"

  - `subsidiaries.party.addresses.auditInfo` (object, required)

  - `subsidiaries.party.addresses.auditInfo.createdAt` (string)
    Example: "2026-03-04T17:27:05.145Z"

  - `subsidiaries.party.addresses.auditInfo.createdBy` (string)
    Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"

  - `subsidiaries.party.addresses.auditInfo.updatedAt` (string)
    Example: "2026-03-04T17:27:05.146Z"

  - `subsidiaries.party.addresses.auditInfo.updatedBy` (string)
    Example: "1372b691-af02-4b90-945a-c6351e785879"

  - `subsidiaries.signOnDate` (string)
    Example: "2026-03-04T17:27:05.269Z"

  - `subsidiaries.actionPlanCode` (string)
    Example: "string"

  - `subsidiaries.customerId` (string)
    Example: "string"

  - `subsidiaries.partnerCriteria` (object)

  - `subsidiaries.partnerCriteria.id` (string, required)
    Example: "2faa49d6-1f60-452b-a6b8-a8b3acb8f384"

  - `subsidiaries.partnerCriteria.partnerType` (object, required)

  - `subsidiaries.partnerCriteria.partnerType.id` (string, required)
    Example: "1e01f3be-d88a-42a0-bbd3-09fc8aa3bc4d"

  - `subsidiaries.partnerCriteria.partnerType.name` (string, required)
    Example: "string"

  - `subsidiaries.partnerCriteria.partnerType.code` (string, required)
    Example: "string"

  - `subsidiaries.partnerCriteria.partnerType.description` (string)
    Example: "string"

  - `subsidiaries.partnerCriteria.partnerType.allowSelfParenting` (boolean)

  - `subsidiaries.partnerCriteria.partnerType.ancestryMetadata` (object)

  - `subsidiaries.partnerCriteria.partnerType.ancestryMetadata.groups` (array, required)
    List of ancestry groups in the response

  - `subsidiaries.partnerCriteria.partnerType.ancestryMetadata.groups.items` (array, required)
    List of ancestry nodes in this group

  - `subsidiaries.partnerCriteria.partnerType.ancestryMetadata.groups.items.level` (number, required)
    The level of the ancestry node in the hierarchy
    Example: 1

  - `subsidiaries.partnerCriteria.partnerType.ancestryMetadata.groups.items.id` (string, required)
    The unique identifier of the ancestry node
    Example: "c977309b-3b1f-454b-968f-38444871ef18"

  - `subsidiaries.partnerCriteria.partnerType.ancestryMetadata.groups.totalItems` (number, required)
    The total count of nodes in this ancestry group
    Example: 4

  - `subsidiaries.partnerCriteria.partnerType.ancestryMetadata.totalGroups` (number, required)
    Total number of ancestry groups
    Example: 2

  - `subsidiaries.partnerCriteria.partnerType.apptivoValueId` (string)
    Example: "string"

  - `subsidiaries.partnerCriteria.partnerType.auditInfo` (object, required)

  - `subsidiaries.partnerCriteria.partnerType.auditInfo.createdAt` (string)
    Example: "2026-03-04T17:27:05.145Z"

  - `subsidiaries.partnerCriteria.partnerType.auditInfo.createdBy` (string)
    Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"

  - `subsidiaries.partnerCriteria.partnerType.auditInfo.updatedAt` (string)
    Example: "2026-03-04T17:27:05.146Z"

  - `subsidiaries.partnerCriteria.partnerType.auditInfo.updatedBy` (string)
    Example: "1372b691-af02-4b90-945a-c6351e785879"

  - `subsidiaries.partnerCriteria.partnerType.activeInfo` (object, required)

  - `subsidiaries.partnerCriteria.partnerType.activeInfo.active` (boolean, required)
    Example: true

  - `subsidiaries.partnerCriteria.partnerType.activeInfo.activeStatusChangedAt` (string, required)
    Example: "2026-03-04T17:27:05.147Z"

  - `subsidiaries.partnerCriteria.partnerType.archiveInfo` (object, required)

  - `subsidiaries.partnerCriteria.partnerType.archiveInfo.archived` (boolean)

  - `subsidiaries.partnerCriteria.partnerType.archiveInfo.archivedStatusChangedAt` (string)
    Example: "2026-03-04T17:27:05.147Z"

  - `subsidiaries.partnerCriteria.partnerType.parentPartnerTypes` (array)

  - `subsidiaries.partnerCriteria.partnerType.parentPartnerTypes.id` (string, required)
    Example: "1e01f3be-d88a-42a0-bbd3-09fc8aa3bc4d"

  - `subsidiaries.partnerCriteria.partnerType.parentPartnerTypes.name` (string, required)
    Example: "string"

  - `subsidiaries.partnerCriteria.partnerType.parentPartnerTypes.code` (string, required)
    Example: "string"

  - `subsidiaries.partnerCriteria.partnerType.parentPartnerTypes.description` (string)
    Example: "string"

  - `subsidiaries.partnerCriteria.partnerType.parentPartnerTypes.allowSelfParenting` (boolean)

  - `subsidiaries.partnerCriteria.partnerType.parentPartnerTypes.ancestryMetadata` (object)

  - `subsidiaries.partnerCriteria.partnerType.parentPartnerTypes.ancestryMetadata.groups` (array, required)
    List of ancestry groups in the response

  - `subsidiaries.partnerCriteria.partnerType.parentPartnerTypes.ancestryMetadata.groups.items` (array, required)
    List of ancestry nodes in this group

  - `subsidiaries.partnerCriteria.partnerType.parentPartnerTypes.ancestryMetadata.groups.items.level` (number, required)
    The level of the ancestry node in the hierarchy
    Example: 1

  - `subsidiaries.partnerCriteria.partnerType.parentPartnerTypes.ancestryMetadata.groups.items.id` (string, required)
    The unique identifier of the ancestry node
    Example: "c977309b-3b1f-454b-968f-38444871ef18"

  - `subsidiaries.partnerCriteria.partnerType.parentPartnerTypes.ancestryMetadata.groups.totalItems` (number, required)
    The total count of nodes in this ancestry group
    Example: 4

  - `subsidiaries.partnerCriteria.partnerType.parentPartnerTypes.ancestryMetadata.totalGroups` (number, required)
    Total number of ancestry groups
    Example: 2

  - `subsidiaries.partnerCriteria.partnerType.parentPartnerTypes.apptivoValueId` (string)
    Example: "string"

  - `subsidiaries.partnerCriteria.partnerType.parentPartnerTypes.auditInfo` (object, required)

  - `subsidiaries.partnerCriteria.partnerType.parentPartnerTypes.auditInfo.createdAt` (string)
    Example: "2026-03-04T17:27:05.145Z"

  - `subsidiaries.partnerCriteria.partnerType.parentPartnerTypes.auditInfo.createdBy` (string)
    Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"

  - `subsidiaries.partnerCriteria.partnerType.parentPartnerTypes.auditInfo.updatedAt` (string)
    Example: "2026-03-04T17:27:05.146Z"

  - `subsidiaries.partnerCriteria.partnerType.parentPartnerTypes.auditInfo.updatedBy` (string)
    Example: "1372b691-af02-4b90-945a-c6351e785879"

  - `subsidiaries.partnerCriteria.partnerType.parentPartnerTypes.activeInfo` (object, required)

  - `subsidiaries.partnerCriteria.partnerType.parentPartnerTypes.activeInfo.active` (boolean, required)
    Example: true

  - `subsidiaries.partnerCriteria.partnerType.parentPartnerTypes.activeInfo.activeStatusChangedAt` (string, required)
    Example: "2026-03-04T17:27:05.147Z"

  - `subsidiaries.partnerCriteria.partnerType.parentPartnerTypes.archiveInfo` (object, required)

  - `subsidiaries.partnerCriteria.partnerType.parentPartnerTypes.archiveInfo.archived` (boolean)

  - `subsidiaries.partnerCriteria.partnerType.parentPartnerTypes.archiveInfo.archivedStatusChangedAt` (string)
    Example: "2026-03-04T17:27:05.147Z"

  - `subsidiaries.partnerCriteria.partnerType.childPartnerTypes` (array)

  - `subsidiaries.partnerCriteria.partnerType.childPartnerTypes.id` (string, required)
    Example: "1e01f3be-d88a-42a0-bbd3-09fc8aa3bc4d"

  - `subsidiaries.partnerCriteria.partnerType.childPartnerTypes.name` (string, required)
    Example: "string"

  - `subsidiaries.partnerCriteria.partnerType.childPartnerTypes.code` (string, required)
    Example: "string"

  - `subsidiaries.partnerCriteria.partnerType.childPartnerTypes.description` (string)
    Example: "string"

  - `subsidiaries.partnerCriteria.partnerType.childPartnerTypes.allowSelfParenting` (boolean)

  - `subsidiaries.partnerCriteria.partnerType.childPartnerTypes.ancestryMetadata` (object)

  - `subsidiaries.partnerCriteria.partnerType.childPartnerTypes.ancestryMetadata.groups` (array, required)
    List of ancestry groups in the response

  - `subsidiaries.partnerCriteria.partnerType.childPartnerTypes.ancestryMetadata.groups.items` (array, required)
    List of ancestry nodes in this group

  - `subsidiaries.partnerCriteria.partnerType.childPartnerTypes.ancestryMetadata.groups.items.level` (number, required)
    The level of the ancestry node in the hierarchy
    Example: 1

  - `subsidiaries.partnerCriteria.partnerType.childPartnerTypes.ancestryMetadata.groups.items.id` (string, required)
    The unique identifier of the ancestry node
    Example: "c977309b-3b1f-454b-968f-38444871ef18"

  - `subsidiaries.partnerCriteria.partnerType.childPartnerTypes.ancestryMetadata.groups.totalItems` (number, required)
    The total count of nodes in this ancestry group
    Example: 4

  - `subsidiaries.partnerCriteria.partnerType.childPartnerTypes.ancestryMetadata.totalGroups` (number, required)
    Total number of ancestry groups
    Example: 2

  - `subsidiaries.partnerCriteria.partnerType.childPartnerTypes.apptivoValueId` (string)
    Example: "string"

  - `subsidiaries.partnerCriteria.partnerType.childPartnerTypes.auditInfo` (object, required)

  - `subsidiaries.partnerCriteria.partnerType.childPartnerTypes.auditInfo.createdAt` (string)
    Example: "2026-03-04T17:27:05.145Z"

  - `subsidiaries.partnerCriteria.partnerType.childPartnerTypes.auditInfo.createdBy` (string)
    Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"

  - `subsidiaries.partnerCriteria.partnerType.childPartnerTypes.auditInfo.updatedAt` (string)
    Example: "2026-03-04T17:27:05.146Z"

  - `subsidiaries.partnerCriteria.partnerType.childPartnerTypes.auditInfo.updatedBy` (string)
    Example: "1372b691-af02-4b90-945a-c6351e785879"

  - `subsidiaries.partnerCriteria.partnerType.childPartnerTypes.activeInfo` (object, required)

  - `subsidiaries.partnerCriteria.partnerType.childPartnerTypes.activeInfo.active` (boolean, required)
    Example: true

  - `subsidiaries.partnerCriteria.partnerType.childPartnerTypes.activeInfo.activeStatusChangedAt` (string, required)
    Example: "2026-03-04T17:27:05.147Z"

  - `subsidiaries.partnerCriteria.partnerType.childPartnerTypes.archiveInfo` (object, required)

  - `subsidiaries.partnerCriteria.partnerType.childPartnerTypes.archiveInfo.archived` (boolean)

  - `subsidiaries.partnerCriteria.partnerType.childPartnerTypes.archiveInfo.archivedStatusChangedAt` (string)
    Example: "2026-03-04T17:27:05.147Z"

  - `subsidiaries.partnerCriteria.status` (string)
    Enum: "on-boarded", "active", "inactive", "suspended", "on-hold"

  - `subsidiaries.partnerCriteria.commissionPayoutStatus` (string)
    Enum: "active", "inactive", "blocked", "pending-cutoff", "under-charge-back"

  - `subsidiaries.partnerCriteria.deactivatedDate` (string)
    Example: "2026-03-04T17:27:05.268Z"

  - `subsidiaries.partnerCriteria.onboardingDate` (string)
    Example: "2026-03-04T17:27:05.268Z"

  - `subsidiaries.partnerCriteria.salesCutOffDate` (string)
    Example: "2026-03-04T17:27:05.268Z"

  - `subsidiaries.partnerCriteria.enableCommissions` (boolean)

  - `subsidiaries.partnerCriteria.w9Submitted` (boolean)

  - `subsidiaries.partnerCriteria.isW2` (boolean)

  - `subsidiaries.partnerCriteria.vendorMetadata` (object)

  - `subsidiaries.partnerCriteria.vendorMetadata.vendorId` (string, required)
    BILL-generated ID of the vendor. The value begins with 009.
    Example: "00902NCBVPYCOHO2b47k"

  - `subsidiaries.partnerCriteria.vendorMetadata.archived` (boolean, required)
    Set as true if the vendor is archived

  - `subsidiaries.partnerCriteria.vendorMetadata.isBankAccountLinked` (boolean, required)
    Indicates whether a bank account is linked to the vendor.
    Example: true

  - `subsidiaries.vendorProfiles` (any)