Create or Update Partner

Creates a new partner or updates an existing one.

On update, only the provided attributes will be modified. Arrays use sync behavior:

• Sending an array with values replaces all existing ones.
• Sending an empty array [] clears all existing ones.
• Omitting the array keeps current values unchanged.

Request Body — REQUIRED
uuid string Identifier used exclusively for updating an existing partner. If provided, the request is always treated as update. If the partner does not exist, an error is returned.
national_registry_number string Partner's national identifier. If provided and the partner exists, it will be updated. If provided and the partner does not exist, it will be created. Required if editing and uuid is not provided.
national_registry_number_type string Possible values: [CPF, CNPJ, RUT, CUIT] Type of national registry. Required if national_registry_number is provided.
name string Required except when national_registry_number_type = CNPJ (in this case it can be retrieved from Receita Federal).
situation string Possible values: [NONE, NO_HOMOLOGATED, PRE_HOMOLOGATED, HOMOLOGATED, REPPROVED, ACTIVE, INACTIVE] Current situation of the partner in the approval timeline.
situation_justification string Required when changing status to REPPROVED, INACTIVE, or rolling back status (e.g.: ACTIVE → PRE_HOMOLOGATED).
code_erp string ERP code.
send_network_invite boolean Sends a network invite to the partner. If the partner is not validated on the platform, a main contact must be provided to send the invite.
service_types string[] — REQUIRED Required for creation. Defines the services provided by the partner. Defaults are 'GENERATOR', 'CARRIER', or 'RECYCLER'. Alternatively, a custom service type name may be provided, which will be registered accordingly.
treatments string[] Required when service_types includes 'RECYCLER'. Can be provided as uuid or treatment name.
managed_wastes string[] Wastes managed by the partner. Can be provided as uuid, ERP code, or internal waste code.
waste_groups string[] Names of waste groups related to the partner. Example: 'Orgânicos', 'Químicos', 'Resíduos Industriais'.
partner_sharing string[] Indicates which tenancies will have access to this partner. The allowed tenancies/companies must be under the hierarchy where the partner was registered. Either the tenancy uuid or the company's national_registry_number can be provided. If national_registry_number is provided, all departments under that company will be linked.
default_unit_codes object[] Information used to generate the MTR barcode for government consultation and when changing partners in the MTR. schema string — REQUIRED Possible values: [IMA, IMA_AL, FEPAM, IEMA, INEA, FEAM, SIGOR, SINIR] Government authority. unit_code integer — REQUIRED Unit code in the government authority.
government_passwords object[] schema string — REQUIRED Possible values: [IMA, IMA_AL, FEPAM, IEMA, INEA, FEAM, SIGOR, SINIR] Government authority. is_default boolean If there is more than one password for the same unit, the default one will be used. is_auto_updated_on_government boolean When enabled, automatically synchronizes with the government authority. total_wtm_import_management boolean When enabled, all MTRs related to this CNPJ will be synchronized from the government to the platform. When disabled, MTRs where only this CNPJ is involved (generator, transporter, or final disposer) will not be synchronized (imported or received by sharing). unit string Unit code in the government authority. password string — REQUIRED Password for access to the government authority. identifier string — REQUIRED Identifier for access to the government authority. responsible_users string[] Users linked to MTRs issued with this partner. Can be provided as login or email.
provisory_wtm_configurations object[] Provisory MTR configurations. Accepted only if government_passwords are provided. schema string — REQUIRED Possible values: [IMA, IMA_AL, FEPAM, IEMA, INEA, FEAM, SIGOR, SINIR] Government authority. unit string — REQUIRED Unit code in the government authority. stock_size integer Number of provisory MTRs available in stock. auto_regularize_wtm boolean When enabled, the system will try to regularize the provisory MTR automatically once it connects to the government. generate_stock boolean When enabled, provisory MTR stock will be generated upon saving.
main_address object Partner's main address. Required when national_registry_number_type is not CNPJ (in this case, it can be retrieved from Receita Federal). If lat and lng are provided, the other fields are not mandatory. lat string Latitude lng string Longitude city_name string additional_address string address string address_number string district string zip_code string
secondary_addresses object[] lat string Latitude lng string Longitude city_name string additional_address string address string address_number string district string zip_code string
contacts object[] Contacts linked to the partner. phone string Contact phone number. name string — REQUIRED Contact name. Required. email string — REQUIRED Contact email. Required. type string — REQUIRED Possible values: [MAIN_CONTACT, LOGISTIC, FINANCIAL, DOCUMENT, WASTE_TRANSPORT_MANIFEST] Contact type. Required. main_contact_notification_configuration object Notification settings for MAIN_CONTACT type. If not provided, all values default to true. new_invoice_mail boolean Sends notification when a task is completed and no invoice is attached. pending_wtm_mail boolean Sends daily notification (07:00) if there are pending MTRs with this partner as final disposer until they are received. partner_invite_mail boolean Sends notification by email when a partner invitation is created. cancel_wtm_mail boolean Sends notification when an MTR is canceled and the partner is involved as transporter or final disposer. partner_invite_platform boolean Sends notification through the platform when a partner invitation is created. partner_invite_whatsapp boolean Sends notification by WhatsApp when a partner invitation is created. logistic_notification_configuration object Notification settings for LOGISTIC type. notification_mode string Possible values: [SUMMARY, DEFAULT] Notification mode: SUMMARY sends a daily summary (executed, non-executed, and justified tasks from the previous day). DEFAULT sends notifications in real time when the task is executed. programmed_tasks_mail boolean Sends notification for scheduled tasks. executed_tasks_mail boolean Sends notification for executed tasks. justified_tasks_mail boolean Sends notification for justified tasks. canceled_tasks_mail boolean Sends notification for canceled tasks. executed_tasks_whatsapp_message boolean Sends WhatsApp notification for executed tasks. canceled_tasks_whatsapp_message boolean Sends WhatsApp notification for canceled tasks. document_notification_configuration object Notification settings for DOCUMENT type. If not provided, values default to true. document_status_mail boolean Sends notification when the document status is different from valid. document_share_mail boolean Sends notification when a document is shared or rejected. document_reminder_mail boolean Sends notification when there are document reminders scheduled for the current day.

Responses

200 200 response Schema — OPTIONAL id string — OPTIONAL The unique identifier of the integration path string — OPTIONAL The path of the integration message string — OPTIONAL A message describing the integration status string — OPTIONAL Possible values: [CREATED, PROCESSING, COMPLETED, FAILED, ARCHIVED] The status of the integration request_details object — OPTIONAL Details of the request made to the integration path string — OPTIONAL The original request's path http_method string — OPTIONAL The original request's HTTP method body string — OPTIONAL The original request's body content query_params string — OPTIONAL The original request's query param content response — OPTIONAL Contains the result of the process, each request type has it's own result format.