# Partner-Organizations

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

 - [POST /api/v2/partners](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_add.md): 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)

## This API will list all the given partners.

 - [GET /api/v2/partners](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_list.md): Permissions needed - partners.read

## This API will get the partner details

 - [GET /api/v2/partners/{partnerId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_getbyid.md): Permissions needed - partners.read

## This API will delete the partner.

 - [DELETE /api/v2/partners/{partnerId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_delete.md): Permissions needed - partners.admin

## This API updates a specific partner.

 - [PATCH /api/v2/partners/{partnerId}](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_update.md): Permissions needed - partners.admin

## This API activates a previously deactivated partner.

 - [POST /api/v2/partners/{partnerId}/activate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_activate.md): Permissions needed - partners.admin

## This API deactivates a given partner.

 - [POST /api/v2/partners/{partnerId}/deactivate](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_deactivate.md): Permissions needed - partners.admin

## This API archives a specific partner

 - [POST /api/v2/partners/{partnerId}/archive](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_archive.md): Permissions needed - partners.admin

## This API restores a previously archived partner.

 - [POST /api/v2/partners/{partnerId}/restore](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_restore.md): Permissions needed - partners.admin

## The purpose of this API is to list all partners that can potentially be assigned as parents, based on the correct partner type

 - [GET /api/v2/partner-types/{partnerTypeId}/eligible-partners](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_listeligiblepartners.md): Permissions needed - partners.read

## This API will list all the ancestry or hierarchy tiers for a given partner based on the selected mode (ancestry or hierarchy).

 - [GET /api/v2/partners/{partnerId}/tiers](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_tiers.md): Permissions needed - partners.read

## The purpose of this API is to fetch the audit trails based on the partner Id.

 - [GET /api/v2/partners/{partnerId}/audit-trails](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_getaudittrails.md): Permissions needed - partners.read

## The purpose of this API is to perform CRM Sync.

 - [POST /api/v2/partners/{partnerId}/crm-sync](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_crmsync.md): Permissions needed - partners.admin,ecg-api-key

## The purpose of this API is to triggers a sync for the specified partner across dependent systems.

 - [POST /api/v2/partners/{partnerId}/re-sync](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_relaypartnersync.md): Permissions needed - partners.admin,ecg-api-key

## The purpose of this API is to triggers a sync for the specified partner across dependent systems.

 - [POST /api/v2/partners/re-sync-all](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_relaypartnersyncall.md): Permissions needed - partners.admin,ecg-api-key

## Syncs the vendor ID from Sage Intacct.

 - [POST /api/v2/partners/{partnerId}/vendorId-sync](https://ecg-api-documentation.redocly.app/products/organizations/apis/orgs/partner-organizations/partnerv2controller_syncvendorid.md)