CommonCounterpart contacts

Create a counterpart contact

Counterparts of the organization type can have additional contacts defined. Contacts are useful if you need to use different contact information for the same counterpart in different invoices.

The first contact you add to a counterpart becomes its default contact. The default contact, if it exists, is automatically selected when you create invoices and quotes for this counterpart, but the contact information can also be changed later on the document level. To select a different contact as the default one, use POST /counterparts/{counterpart_id}/contacts/{contact_id}/make_default.

Path parameters

counterpart_idstringRequired
ID of a counterpart to add a contact for. This counterpart must be an organization, not an individual.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-monite-versionstringRequired
x-monite-entity-idstringRequired
The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.
addressobjectRequired
The address of a contact person.
first_namestringRequired
The first name of a contact person.
last_namestringRequired
The last name of a contact person.
emailstringOptionalformat: "email"
The email address of a contact person.
phonestringOptional
The phone number of a contact person
titlestringOptional

The title or honorific of a contact person. Examples: Mr., Ms., Dr., Prof.

Response

Successful Response
idstringformat: "uuid"
A unique ID assigned to this counterpart contact.
addressobject
The address of a contact person.
counterpart_idstringformat: "uuid"
ID of the counterpart to which this contact belongs.
first_namestring
The first name of a contact person.
is_defaultboolean

Indicates whether this contact is the default one. The default contact is used to fill in the counterpart’s contact details when you create invoices and quotes for this counterpart.

To select another contact as the default one, use POST /counterparts/{counterpart_id}/contacts/{contact_id}/make_default.

last_namestring
The last name of a contact person.
emailstring or nullformat: "email"
The email address of a contact person.
phonestring or null
The phone number of a contact person
titlestring or null

The title or honorific of a contact person. Examples: Mr., Ms., Dr., Prof.

Errors