Counterpart contacts
Learn how to manage the counterpart's contact information.
Counterparts of type organization
can have contact information associated with them. The contact information can be used to pay the invoices issued by those counterparts.
Add a contact to a counterpart
To add a contact to a counterpart, call POST /counterparts/{counterpart_id}/contacts
:
The successful response returns the information about the contact:
Set the default contact
Once the contacts are added to the counterpart, select a default contact by calling POST /counterparts/{counterpart_id}/contacts/{contact_id}/make_default
:
The successful response contains information about the contact marked as default:
List all contacts
To get information about all contacts associated with the specified counterpart, call
GET /counterparts/{counterpart_id}/contacts
.
Retrieve a contact
To get information about a specific contact associated with the specified counterpart, call
GET /counterparts/{counterpart_id}/contacts/{contact_id}
.
Edit a contact
To edit an existing contact of the specified counterpart, call
PATCH /counterparts/{counterpart_id}/contacts/{contact_id}
.
Delete a contact
To delete an existing contact from the list of contacts associated with the specified counterpart, call
DELETE /counterparts/{counterpart_id}/contacts/{contact_id}
. Only non-default contacts can be deleted.