Get available contacts for potential invoice
What are Invoice Contacts? Returns a list of organization members (contacts) from the customer organization who can be selected as invoice recipients. These contacts are the people who will receive the invoice when it is sent via email. You can set a contact for each potential invoice to specify who should receive the final invoice document.
Invoice ID Format: The invoice ID follows the format: {type}::{projectId}::{dateFrom}::{dateTo}
- Example: SingleProject::0e9d033a-ab41-4212-8637-66c4e3b01fe2::2025-10-01::2025-10-31 The projectId is extracted from the invoice ID to determine which organization is the customer, and then returns contacts from that organization.
What data is returned:
- List of organization members from the project customer organization
- Each contact includes ID (UUID), full name, avatar file ID (if available), and email address
- Contacts are sorted alphabetically by first name, then last name
- Only active (non-deleted) organization members are returned
How to use:
- Get the list of available contacts for a potential invoice
- Select a contact ID from the list
- Use the PATCH endpoint to set the contactId for the potential invoice
- When the invoice is finalized and sent, it will be emailed to this contact
Permission requirements: Requires Invoices.manage permission and access to the project to view contacts.
/billing/potential-invoices/{id}/contactsAuthorizationOAuth2 access token · headerrequiredapi:readAuthorizationBearer token (JWT) · headerrequiredidstringrequiredPotential invoice ID in format: {type}::{projectId}::{dateFrom}::{dateTo}
Invoice contacts retrieved successfully
InvoiceContactResponseDtoavatarIdobject<uuid> | nullrequiredAvatar file ID (UUID) if the contact has a profile picture. Null if no avatar is set.
emailobject | nullrequiredEmail address of the contact. This is where the invoice will be sent when finalized. Null if the contact does not have an email address.
idstring<uuid>requiredContact ID (UUID) of the organization member. Use this ID when setting the contactId for a potential invoice via the PATCH endpoint.
namestringrequiredFull name of the contact (organization member). This is the person who will receive the invoice when it is sent via email.
Unauthorized - Invalid or missing authentication token
User lacks Invoices.manage permission or project access
Potential invoice not found