Version information

Version: 3.0.0
Platform Version: 15.15.0

Authentication

This integration uses OAuth2 for authentication. Here is how it is structured:

a. OAuth2 authentication

Authorization Type: OAuth2
Oauth2 Configuration:
- Authorization URL: Accepts the client_id, state, redirect_uri, response_type, audience, and scope as parameters to the authorization URL
- Get Access Token: A POST request is made to retrieve an access token, using code, client_id, client_secret, grant_type, and redirect_uri
- Refresh Access Token: This refreshes the access token when expired
- Scope: openid, profile, email, offline_access
- Auto-refresh: Enabled
Testing Authentication
- URL: https://{{process.env.API_BASE}}/v1/users/meta
- Headers: Requires Authorization and X-ORG-ID headers
- Params: Requires org_id

Fields

org_id: Computed field, used in connection labeling

Triggers

The integration supports various triggers based on different events:

a. Proposal triggers

Proposal published
- Description: Triggers when a proposal is published.
- Key: proposal_published
- Output description:
  - id: string
    The unique identifier for the proposal. Example: "cbddb2fd-60b6-4c25-a69c-17fbde34a148".
  - name: string
    The name or title of the proposal. Example: "Sample Proposal".
  - due_date: string (ISO 8601 format)
    The date by which the proposal should be reviewed or completed. Example: "2021-12-31".
  - preview_url: string
    A URL where the preview of the proposal can be accessed. Example: "<https://example.com/pm/proposals/preview/123>".
  - start_date: string (ISO 8601 format)
    The starting date for the proposal activities or services. Example: "2021-12-01".
  - end_date: string (ISO 8601 format)
    The completion date for the proposal activities or services. Example: "2021-12-31".
  - created_at: string (ISO 8601 format with timezone)
    The date and time when the proposal was created. Example: "2024-09-05T11:06:00.910465+05:30".
  - published_at: string (ISO 8601 format with timezone)
    The date and time when the proposal was published. Example: "2024-09-05T11:06:00.910465+05:30".
  - sent_at: string (optional)
    The date and time when the proposal was sent to stakeholders. Empty if not yet sent. Example: "".
  - staff: array of objects
    A list of staff members associated with the proposal.
    name: string
    The name of a staff member. Example: "John Doe".
    email: string
    The email address of the staff member. Example: "[email protected]".
  - signatory: array of objects
    A list of client contacts who must sign the proposal.
    name: string
    The name of the signatory. Example: "Jane Doe".
    email: string
    The email address of the signatory. Example: "[email protected]".
    url: string
    A URL specific to the signatory for accessing the proposal. Example: "<https://example.com/shared/proposals/123>".
  - services: array of objects
    The list of services included in the proposal.
    name: string
    The name of the service. Example: "Sample Service".
    description: string
    A brief description of the service. Example: "Sample Description".
    pricing_method: string
    The method used to price the service. Possible values include "fixed", "hourly", etc. Example: "fixed".
    billing_type: string
    Indicates the type of billing, whether one-time or recurring. Example: "one_time".
    price: string (numeric value as string)
    The base price of the service before tax. Example: "100".
    tax: string (numeric value as string)
    The amount of tax applied to the service price. Example: "10".
    total: string (numeric value as string)
    The total price including tax. Example: "110"
- Sample data:
```
{
"id": "cbddb2fd-60b6-4c25-a69c-17fbde34a148",
"name": "Sample Proposal",
"due_date": "2021-12-31",
"preview_url": "<https://example.com/pm/proposals/preview/123>",
"start_date": "2021-12-01",
"end_date": "2021-12-31",
"created_at": "2024-09-05T11:06:00.910465+05:30",
"published_at": "2024-09-05T11:06:00.910465+05:30",
"sent_at": "",
"staff": [
{
"name": "John Doe",
"email": "[email protected]"
 }
],
"signatory": [
{
"name": "Jane Doe",
"email": "[email protected]",
"url": "<https://example.com/shared/proposals/123>"
 }
],
"services": [
{
"name": "Sample Service",
"description": "Sample Description",
"pricing_method": "fixed",
"billing_type": "one_time",
"price": "100",
"tax": "10",
"total": "110"
 }
]
}
```
Proposal accepted
- Description: Triggers when a proposal is accepted.
- Key: proposal_accepted
- Output description:
  - id: string
    The unique identifier for the proposal. Example: "cbddb2fd-60b6-4c25-a69c-17fbde34a148".
  - name: string
    The name or title of the proposal. Example: "Sample Proposal".
  - due_date: string (ISO 8601 format)
    The date by which the proposal should be reviewed or completed. Example: "2021-12-31".
  - preview_url: string
    A URL where the preview of the proposal can be accessed. Example: "<https://example.com/pm/proposals/preview/123>".
  - start_date: string (ISO 8601 format)
    The starting date for the proposal activities or services. Example: "2021-12-01".
  - end_date: string (ISO 8601 format)
    The completion date for the proposal activities or services. Example: "2021-12-31".
  - created_at: string (ISO 8601 format with timezone)
    The date and time when the proposal was created. Example: "2024-09-05T11:06:00.910465+05:30".
  - published_at: string (ISO 8601 format with timezone)
    The date and time when the proposal was published. Example: "2024-09-05T11:06:00.910465+05:30".
  - sent_at: string (optional)
    The date and time when the proposal was sent to stakeholders. Empty if not yet sent. Example: "".
  - staff: array of objects
    A list of staff members associated with the proposal.
    name: string
    The name of a staff member. Example: "John Doe".
    email: string
    The email address of the staff member. Example: "[email protected]".
  - signatory: array of objects
    A list of client contacts who must sign the proposal.
    name: string
    The name of the signatory. Example: "Jane Doe".
    email: string
    The email address of the signatory. Example: "[email protected]".
    url: string
    A URL specific to the signatory for accessing the proposal. Example: "<https://example.com/shared/proposals/123>".
    signed at: The date and time when this signatory signed the proposal. Example: "2024-09-05T11:06:00.910465+05:30"
  - services: array of objects
    The list of services included in the proposal.
    name: string
    The name of the service. Example: "Sample Service".
    description: string
    A brief description of the service. Example: "Sample Description".
    pricing_method: string
    The method used to price the service. Possible values include "fixed", "hourly", etc. Example: "fixed".
    billing_type: string
    Indicates the type of billing, whether one-time or recurring. Example: "one_time".
    price: string (numeric value as string)
    The base price of the service before tax. Example: "100".
    tax: string (numeric value as string)
    The amount of tax applied to the service price. Example: "10".
    total: string (numeric value as string)
    The total price including tax. Example: "110"
- Sample data:
```
{
"id": "cbc80cc2-bed2-4a01-9649-2468c62ca5a7",
"name": "Sample Proposal",
"preview_url": "<https://example.com/pm/proposals/preview/123>",
"start_date": "2021-12-01",
"end_date": "2021-12-31",
"created_at": "2024-09-05T11:08:26.962764+05:30",
"published_at": "2024-09-05T11:08:26.962764+05:30",
"sent_at": "",
"staff": [
{
"name": "John Doe",
"email": "[email protected]"
 }
],
"signatory": [
{
"name": "Jane Doe",
"email": "[email protected]",
"url": "<https://example.com/shared/proposals/123>",
"signed_at": "2024-09-05T11:08:26.962764+05:30"
 }
],
"services": [
{
"name": "Sample Service",
"description": "Sample Description",
"pricing_method": "fixed",
"billing_type": "one_time",
"price": "100",
"tax": "10",
"total": "110"
 }
]
}
```
Proposal created
- Description: Triggers when a proposal is created as draft.
- Key: proposal_created
- Output description:
  - id: string
    The unique identifier for the proposal. Example: "cbddb2fd-60b6-4c25-a69c-17fbde34a148".
  - name: string
    The name or title of the proposal. Example: "Sample Proposal".
  - due_date: string (ISO 8601 format)
    The date by which the proposal should be reviewed or completed. Example: "2021-12-31".
  - preview_url: string
    A URL where the preview of the proposal can be accessed. Example: "<https://example.com/pm/proposals/preview/123>".
  - start_date: string (ISO 8601 format)
    The starting date for the proposal activities or services. Example: "2021-12-01".
  - end_date: string (ISO 8601 format)
    The completion date for the proposal activities or services. Example: "2021-12-31".
  - created_at: string (ISO 8601 format with timezone)
    The date and time when the proposal was created. Example: "2024-09-05T11:06:00.910465+05:30".
  - staff: array of objects
    A list of staff members associated with the proposal.
    name: string
    The name of a staff member. Example: "John Doe".
    email: string
    The email address of the staff member. Example: "[email protected]".
  - signatory: array of objects
    A list of client contacts who must sign the proposal.
    name: string
    The name of the signatory. Example: "Jane Doe".
    email: string
    The email address of the signatory. Example: "[email protected]".
    url: string
    A URL specific to the signatory for accessing the proposal. Example: "<https://example.com/shared/proposals/123>".
  - services: array of objects
    The list of services included in the proposal.
    name: string
    The name of the service. Example: "Sample Service".
    description: string
    A brief description of the service. Example: "Sample Description".
    pricing_method: string
    The method used to price the service. Possible values include "fixed", "hourly", etc. Example: "fixed".
    billing_type: string
    Indicates the type of billing, whether one-time or recurring. Example: "one_time".
    price: string (numeric value as string)
    The base price of the service before tax. Example: "100".
    tax: string (numeric value as string)
    The amount of tax applied to the service price. Example: "10".
    total: string (numeric value as string)
    The total price including tax. Example: "110"
- Sample data:
```
{
"id": "cc7e7245-3fed-4803-b5ac-8113db5bbfb1",
"name": "Sample Proposal",
"due_date": "2021-12-31",
"preview_url": "<https://example.com/pm/proposals/preview/123>",
"start_date": "2021-12-01",
"end_date": "2021-12-31",
"created_at": "2024-09-05T10:54:56.011778+05:30",
"staff": [
{
"name": "John Doe",
"email": "[email protected]"
 }
],
"signatory": [
{
"name": "Jane Doe",
"email": "[email protected]",
"url": "<https://example.com/shared/proposals/123>"
 }
],
"services": [
{
"name": "Sample Service",
"description": "Sample Description",
"pricing_method": "fixed",
"billing_type": "one_time",
"price": "100",
"tax": "10",
"total": "110"
 }
]
}
```
Proposal lost
- Description: Triggers when a proposal is marked as lost.
- Key: proposal_lost
- Output description:
  - id: string
    The unique identifier for the proposal. Example: "cbddb2fd-60b6-4c25-a69c-17fbde34a148".
  - lost_reason: string
    The reason for losing this proposal. Example: "Price mismatch".
  - name: string
    The name or title of the proposal. Example: "Sample Proposal".
  - due_date: string (ISO 8601 format)
    The date by which the proposal should be reviewed or completed. Example: "2021-12-31".
  - preview_url: string
    A URL where the preview of the proposal can be accessed. Example: "<https://example.com/pm/proposals/preview/123>".
  - start_date: string (ISO 8601 format)
    The starting date for the proposal activities or services. Example: "2021-12-01".
  - end_date: string (ISO 8601 format)
    The completion date for the proposal activities or services. Example: "2021-12-31".
  - created_at: string (ISO 8601 format with timezone)
    The date and time when the proposal was created. Example: "2024-09-05T11:06:00.910465+05:30".
  - published_at: string (ISO 8601 format with timezone)
    The date and time when the proposal was published. Example: "2024-09-05T11:06:00.910465+05:30".
  - sent_at: string (optional)
    The date and time when the proposal was sent to stakeholders. Empty if not yet sent. Example: "".
  - staff: array of objects
    A list of staff members associated with the proposal.
    name: string
    The name of a staff member. Example: "John Doe".
    email: string
    The email address of the staff member. Example: "[email protected]".
  - signatory: array of objects
    A list of client contacts who must sign the proposal.
    name: string
    The name of the signatory. Example: "Jane Doe".
    email: string
    The email address of the signatory. Example: "[email protected]".
    signed at: The date and time when this signatory signed the proposal. Example: "2024-09-05T11:06:00.910465+05:30"
  - services: array of objects
    The list of services included in the proposal.
    name: string
    The name of the service. Example: "Sample Service".
    description: string
    A brief description of the service. Example: "Sample Description".
    pricing_method: string
    The method used to price the service. Possible values include "fixed", "hourly", etc. Example: "fixed".
    billing_type: string
    Indicates the type of billing, whether one-time or recurring. Example: "one_time".
    price: string (numeric value as string)
    The base price of the service before tax. Example: "100".
    tax: string (numeric value as string)
    The amount of tax applied to the service price. Example: "10".
    total: string (numeric value as string)
    The total price including tax. Example: "110"
- Sample data:
```
{
"id": "16e407c3-8aab-481b-8722-a5333da35c51",
"name": "Sample Proposal",
"due_date": "2021-12-31",
"preview_url": "<https://example.com/pm/proposals/preview/123>",
"start_date": "2021-12-01",
"end_date": "2021-12-31",
"created_at": "2024-09-05T11:10:55.185506+05:30",
"published_at": "2024-09-05T11:10:55.185506+05:30",
"sent_at": "",
"staff": [
{
"name": "John Doe",
"email": "[email protected]"
 }
],
"signatory": [
{
"name": "Jane Doe",
"email": "[email protected]"
 }
],
"services": [
{
"name": "Sample Service",
"description": "Sample Description",
"pricing_method": "fixed",
"billing_type": "one_time",
"price": "100",
"tax": "10",
"total": "110"
 }
],
"lost_reason": "Sample Reason"
}
```
Proposal revoked
- Description: Triggers when a proposal is revoked.
- Key: proposal_revoked
- Output description:
  - id: string
    The unique identifier for the proposal. Example: "cbddb2fd-60b6-4c25-a69c-17fbde34a148".
  - revoke reason: string
    The reason for revoking this proposal. Example: "Price mismatch".
  - name: string
    The name or title of the proposal. Example: "Sample Proposal".
  - due_date: string (ISO 8601 format)
    The date by which the proposal should be reviewed or completed. Example: "2021-12-31".
  - preview_url: string
    A URL where the preview of the proposal can be accessed. Example: "<https://example.com/pm/proposals/preview/123>".
  - start_date: string (ISO 8601 format)
    The starting date for the proposal activities or services. Example: "2021-12-01".
  - end_date: string (ISO 8601 format)
    The completion date for the proposal activities or services. Example: "2021-12-31".
  - created_at: string (ISO 8601 format with timezone)
    The date and time when the proposal was created. Example: "2024-09-05T11:06:00.910465+05:30".
  - published_at: string (ISO 8601 format with timezone)
    The date and time when the proposal was published. Example: "2024-09-05T11:06:00.910465+05:30".
  - sent_at: string (optional)
    The date and time when the proposal was sent to stakeholders. Empty if not yet sent. Example: "".
  - staff: array of objects
    A list of staff members associated with the proposal.
    name: string
    The name of a staff member. Example: "John Doe".
    email: string
    The email address of the staff member. Example: "[email protected]".
  - signatory: array of objects
    A list of client contacts who must sign the proposal.
    name: string
    The name of the signatory. Example: "Jane Doe".
    email: string
    The email address of the signatory. Example: "[email protected]".
    signed at: The date and time when this signatory signed the proposal. Example: "2024-09-05T11:06:00.910465+05:30"
  - services: array of objects
    The list of services included in the proposal.
    name: string
    The name of the service. Example: "Sample Service".
    description: string
    A brief description of the service. Example: "Sample Description".
    pricing_method: string
    The method used to price the service. Possible values include "fixed", "hourly", etc. Example: "fixed".
    billing_type: string
    Indicates the type of billing, whether one-time or recurring. Example: "one_time".
    price: string (numeric value as string)
    The base price of the service before tax. Example: "100".
    tax: string (numeric value as string)
    The amount of tax applied to the service price. Example: "10".
    total: string (numeric value as string)
    The total price including tax. Example: "110"
- Sample data:
```
{
"id": "c9442833-0f2b-425a-abbd-1191673a4bf7",
"name": "Sample Proposal",
"due_date": "2021-12-31",
"preview_url": "<https://example.com/pm/proposals/preview/123>",
"start_date": "2021-12-01",
"end_date": "2021-12-31",
"created_at": "2024-09-05T11:13:06.096842+05:30",
"published_at": "2024-09-05T11:13:06.096842+05:30",
"sent_at": "",
"staff": [
{
"name": "John Doe",
"email": "[email protected]"
 }
],
"signatory": [
{
"name": "Jane Doe",
"email": "[email protected]"
 }
],
"services": [
{
"name": "Sample Service",
"description": "Sample Description",
"pricing_method": "fixed",
"billing_type": "one_time",
"price": "100",
"tax": "10",
"total": "110"
 }
],
"revoke_reason": "Sample Reason"
}
```

b. Client Triggers

Client created
- Description: Triggers when a client is created.
- Key: client_created
- Output description:
  - name (string): The name of the client.
    Example: "Sample Client"
  - business_name (string): The registered name of the client's business.
    Example: "Sample Business"
  - created_at (string, ISO 8601 format): The date and time when the client record was created. Represented in YYYY-MM-DDTHH:MM:SS.ssssss+TZ format.
    Example: "2024-09-04T20:42:03.503063+05:30"
  - updated_at (string, ISO 8601 format): The date and time when the client record was last updated. Represented in YYYY-MM-DDTHH:MM:SS.ssssss+TZ format.
    Example: "2024-09-04T20:42:03.503063+05:30"
  - alias (string): An alternative name or nickname for the client.
    Example: "Sample Alias"
  - entity_type (string): The type of entity the client is, such as "individual" or "business".
    Example: "business"
  - type (string): Specifies the role or category of the client.
    Example: "client"
  - country (string): The client's country code, following the ISO 3166-1 alpha-2 standard.
    Example: "US"
  - primary_contact_name (string): The full name of the primary contact person for the client.
    Example: "Jane Doe"
  - primary_contact_email (string): The email address of the primary contact person for the client.
    Example: "[email protected]"
  - contacts (array of objects): A list of additional contact persons associated with the client. Each object in the array includes:
    first_name (string): The first name of the contact person.Example: "Jane"
    middle_name (string, optional): The middle name or initial of the contact person.Example: "S"
    last_name (string): The last name of the contact person.Example: "Doe"
    email (string): The email address of the contact person.Example: "[email protected]"
- Sample data:
```
{
"name": "Sample Client",
"business_name": "Sample Business",
"created_at": "2024-09-04T20:42:03.503063+05:30",
"updated_at": "2024-09-04T20:42:03.503063+05:30",
"alias": "Sample Alias",
"entity_type": "business",
"type": "client",
"country": "US",
"primary_contact_name": "Jane Doe",
"primary_contact_email": "[email protected]",
"contacts": [
{
"first_name": "Jane",
"middle_name": "S",
"last_name": "Doe",
"email": "[email protected]"
 }
]
}
```
Client updated
- Description: Triggers when a client is updated.
- Key: client_updated
- Output description:
  - name (string): The name of the client.
    Example: "Sample Client"
  - business_name (string): The registered name of the client's business.
    Example: "Sample Business"
  - created_at (string, ISO 8601 format): The date and time when the client record was created. Represented in YYYY-MM-DDTHH:MM:SS.ssssss+TZ format.
    Example: "2024-09-04T20:42:03.503063+05:30"
  - updated_at (string, ISO 8601 format): The date and time when the client record was last updated. Represented in YYYY-MM-DDTHH:MM:SS.ssssss+TZ format.
    Example: "2024-09-04T20:42:03.503063+05:30"
  - alias (string): An alternative name or nickname for the client.
    Example: "Sample Alias"
  - entity_type (string): The type of entity the client is, such as "individual" or "business".
    Example: "business"
  - type (string): Specifies the role or category of the client.
    Example: "client"
  - country (string): The client's country code, following the ISO 3166-1 alpha-2 standard.
    Example: "US"
  - primary_contact_name (string): The full name of the primary contact person for the client.
    Example: "Jane Doe"
  - primary_contact_email (string): The email address of the primary contact person for the client.
    Example: "[email protected]"
  - contacts (array of objects): A list of additional contact persons associated with the client. Each object in the array includes:
    first_name (string): The first name of the contact person.Example: "Jane"
    middle_name (string, optional): The middle name or initial of the contact person.Example: "S"
    last_name (string): The last name of the contact person.Example: "Doe"
    email (string): The email address of the contact person.Example: "[email protected]"
- Sample data:
```
{
"name": "Sample Client",
"business_name": "Sample Business",
"created_at": "2024-09-04T20:42:03.503063+05:30",
"updated_at": "2024-09-04T20:42:03.503063+05:30",
"alias": "Sample Alias",
"entity_type": "business",
"type": "client",
"country": "US",
"primary_contact_name": "Jane Doe",
"primary_contact_email": "[email protected]",
"contacts": [
{
"first_name": "Jane",
"middle_name": "S",
"last_name": "Doe",
"email": "[email protected]"
 }
]
}
```
Client converted to customer
- Description: Triggers when a prospect is converted to a customer.
- Key: client_converted_to_customer
- Output description:
  - name (string): The name of the client.
    Example: "Sample Client"
  - business_name (string): The registered name of the client's business.
    Example: "Sample Business"
  - created_at (string, ISO 8601 format): The date and time when the client record was created. Represented in YYYY-MM-DDTHH:MM:SS.ssssss+TZ format.
    Example: "2024-09-04T20:42:03.503063+05:30"
  - updated_at (string, ISO 8601 format): The date and time when the client record was last updated. Represented in YYYY-MM-DDTHH:MM:SS.ssssss+TZ format.
    Example: "2024-09-04T20:42:03.503063+05:30"
  - alias (string): An alternative name or nickname for the client.
    Example: "Sample Alias"
  - entity_type (string): The type of entity the client is, such as "individual" or "business".
    Example: "business"
  - type (string): Specifies the role or category of the client.
    Example: "client"
  - country (string): The client's country code, following the ISO 3166-1 alpha-2 standard.
    Example: "US"
  - primary_contact_name (string): The full name of the primary contact person for the client.
    Example: "Jane Doe"
  - primary_contact_email (string): The email address of the primary contact person for the client.
    Example: "[email protected]"
  - contacts (array of objects): A list of additional contact persons associated with the client. Each object in the array includes:
    first_name (string): The first name of the contact person.Example: "Jane"
    middle_name (string, optional): The middle name or initial of the contact person.Example: "S"
    last_name (string): The last name of the contact person.Example: "Doe"
    email (string): The email address of the contact person.Example: "[email protected]"
- Sample data:
```
{
"name": "Sample Client",
"business_name": "Sample Business",
"created_at": "2024-09-04T20:42:03.503063+05:30",
"updated_at": "2024-09-04T20:42:03.503063+05:30",
"alias": "Sample Alias",
"entity_type": "business",
"type": "client",
"country": "US",
"primary_contact_name": "Jane Doe",
"primary_contact_email": "[email protected]",
"contacts": [
{
"first_name": "Jane",
"middle_name": "S",
"last_name": "Doe",
"email": "[email protected]"
 }
]
}
```

c. Invoice Triggers

Invoice created
- Description: Triggers when an invoice is created as a draft.
- Key: invoice_created
- Output description:
  - id: (string) A unique identifier for the invoice.
  - number: (string) The invoice number used for identification.
  - invoice_date: (string, date-time) The date the invoice was issued in ISO 8601 format.
  - due_date: (string, date-time) The date by which the invoice should be paid in ISO 8601 format.
  - sub_total: (string) The subtotal amount of the invoice before discounts and taxes.
  - discount: (string) The discount amount applied to the invoice.
  - tax: (string) The total tax amount applied to the invoice.
  - invoice_status: (string) The current status of the invoice, e.g., "open", “draft”, “scheduled”.
  - client: (object) The client to whom the invoice is issued, containing:
    id: (string) Unique identifier for the client.
    display_name: (string) The display name of the client.
  - total: (string) The total amount of the invoice after discounts and taxes.
  - terms: (integer) The payment terms indicating the number of days within which payment is due.
  - memo: (string) Additional notes or memo on the invoice.
  - currency: (string) The currency code in which the invoice is issued, e.g., "USD".
  - line_items: (array of objects) A list of items included in the invoice, where each item contains:
    name: (string) The name of the item.
    description: (string) A description of the item.
    unit_price: (string) The price per unit of the item.
    quantity: (string) The quantity of the item.
    discount: (string) The discount amount applied to the item.
    tax: (string) The tax amount applied to the item.
    tax_percentage: (string) The tax percentage applied to the item.
    total: (string) The total cost of the line item after discounts and taxes.
  - paid_at: (string, date-time) The date and time at which the invoice was paid in ISO 8601 format.
  - payment_collection_type: (string) The method of payment collection, such as "automatically_charge".
- Sample data:
```
{
"id": "3bccc967-8401-4f3d-bbdc-33c741d2b9f5",
"number": "INV-123",
"invoice_date": "2024-09-04T20:47:54.917386+05:30",
"due_date": "2024-09-04T20:47:54.917388+05:30",
"sub_total": "100.0",
"discount": "0.0",
"tax": "10.0",
"invoice_status": "open",
"client": {
"id": "cd5c8764-208a-459e-a39c-6ce2c36ea764",
"display_name": "Jane Doe"
 },
"total": "110.0",
"terms": 30,
"memo": "Sample Memo",
"currency": "USD",
"line_items": [
{
"name": "Sample Item",
"description": "Sample Description",
"unit_price": "100",
"quantity": "1",
"discount": "0",
"tax": "10",
"tax_percentage": "10",
"total": "110"
 }
],
"payment_collection_type": "automatically_charge"
}
```
Invoice updated
- Description: Triggers when an invoice is updated.
- Key: invoice_updated
- Output description:
  - id: (string) A unique identifier for the invoice.
  - number: (string) The invoice number used for identification.
  - invoice_date: (string, date-time) The date the invoice was issued in ISO 8601 format.
  - due_date: (string, date-time) The date by which the invoice should be paid in ISO 8601 format.
  - sub_total: (string) The subtotal amount of the invoice before discounts and taxes.
  - discount: (string) The discount amount applied to the invoice.
  - tax: (string) The total tax amount applied to the invoice.
  - invoice_status: (string) The current status of the invoice, e.g., "open", “draft”, “scheduled”, “cancelled”.
  - client: (object) The client to whom the invoice is issued, containing:
    id: (string) Unique identifier for the client.
    display_name: (string) The display name of the client.
  - total: (string) The total amount of the invoice after discounts and taxes.
  - terms: (integer) The payment terms indicating the number of days within which payment is due.
  - memo: (string) Additional notes or memo on the invoice.
  - currency: (string) The currency code in which the invoice is issued, e.g., "USD".
  - line_items: (array of objects) A list of items included in the invoice, where each item contains:
    name: (string) The name of the item.
    description: (string) A description of the item.
    unit_price: (string) The price per unit of the item.
    quantity: (string) The quantity of the item.
    discount: (string) The discount amount applied to the item.
    tax: (string) The tax amount applied to the item.
    tax_percentage: (string) The tax percentage applied to the item.
    total: (string) The total cost of the line item after discounts and taxes.
  - payment_collection_type: (string) The method of payment collection, such as "automatically_charge".
- Sample data:
```
{
"id": "3bccc967-8401-4f3d-bbdc-33c741d2b9f5",
"number": "INV-123",
"invoice_date": "2024-09-04T20:47:54.917386+05:30",
"due_date": "2024-09-04T20:47:54.917388+05:30",
"sub_total": "100.0",
"discount": "0.0",
"tax": "10.0",
"invoice_status": "open",
"client": {
"id": "cd5c8764-208a-459e-a39c-6ce2c36ea764",
"display_name": "Jane Doe"
 },
"total": "110.0",
"terms": 30,
"memo": "Sample Memo",
"currency": "USD",
"line_items": [
{
"name": "Sample Item",
"description": "Sample Description",
"unit_price": "100",
"quantity": "1",
"discount": "0",
"tax": "10",
"tax_percentage": "10",
"total": "110"
 }
],
"payment_collection_type": "automatically_charge"
}
```
Invoice finalized
- Description: Triggers when an invoice is finalized.
- Key: invoice_finalized
- Output description:
  - id: (string) A unique identifier for the invoice.
  - number: (string) The invoice number used for identification.
  - invoice_date: (string, date-time) The date the invoice was issued in ISO 8601 format.
  - due_date: (string, date-time) The date by which the invoice should be paid in ISO 8601 format.
  - sub_total: (string) The subtotal amount of the invoice before discounts and taxes.
  - discount: (string) The discount amount applied to the invoice.
  - tax: (string) The total tax amount applied to the invoice.
  - invoice_status: (string) The current status of the invoice, e.g., "paid".
  - client: (object) The client to whom the invoice is issued, containing:
    id: (string) Unique identifier for the client.
    display_name: (string) The display name of the client.
  - total: (string) The total amount of the invoice after discounts and taxes.
  - terms: (integer) The payment terms indicating the number of days within which payment is due.
  - memo: (string) Additional notes or memo on the invoice.
  - currency: (string) The currency code in which the invoice is issued, e.g., "USD".
  - line_items: (array of objects) A list of items included in the invoice, where each item contains:
    name: (string) The name of the item.
    description: (string) A description of the item.
    unit_price: (string) The price per unit of the item.
    quantity: (string) The quantity of the item.
    discount: (string) The discount amount applied to the item.
    tax: (string) The tax amount applied to the item.
    tax_percentage: (string) The tax percentage applied to the item.
    total: (string) The total cost of the line item after discounts and taxes.
  - payment_collection_type: (string) The method of payment collection, such as "automatically_charge".
- Sample data:
```
{
"id": "eab01c47-8b1a-40a0-a9da-9712b842ef48",
"number": "INV-123",
"invoice_date": "2024-09-04T20:58:00.896455+05:30",
"due_date": "2024-09-04T20:58:00.896455+05:30",
"sub_total": "100",
"discount": "0",
"tax": "10",
"invoice_status": "sent",
"client": {
"id": "6507256d-3cdb-4937-95c7-f183d33c8c3a",
"display_name": "Jane Doe"
 },
"total": "110",
"terms": 30,
"memo": "Sample Memo",
"currency": "USD",
"line_items": [
{
"name": "Sample Item",
"description": "Sample Description",
"unit_price": "100",
"quantity": "1",
"discount": "0",
"tax": "10",
"tax_percentage": "10",
"total": "110"
 }
],
"payment_collection_type": "automatically_charge"
}
```
Invoice paid
- Description: Triggers when an invoice is paid.
- Key: invoice_paid
- Output description:
  - id: (string) A unique identifier for the invoice.
  - number: (string) The invoice number used for identification.
  - invoice_date: (string, date-time) The date the invoice was issued in ISO 8601 format.
  - due_date: (string, date-time) The date by which the invoice should be paid in ISO 8601 format.
  - sub_total: (string) The subtotal amount of the invoice before discounts and taxes.
  - discount: (string) The discount amount applied to the invoice.
  - tax: (string) The total tax amount applied to the invoice.
  - invoice_status: (string) The current status of the invoice, e.g., "paid".
  - client: (object) The client to whom the invoice is issued, containing:
    id: (string) Unique identifier for the client.
    display_name: (string) The display name of the client.
  - total: (string) The total amount of the invoice after discounts and taxes.
  - terms: (integer) The payment terms indicating the number of days within which payment is due.
  - memo: (string) Additional notes or memo on the invoice.
  - currency: (string) The currency code in which the invoice is issued, e.g., "USD".
  - line_items: (array of objects) A list of items included in the invoice, where each item contains:
    name: (string) The name of the item.
    description: (string) A description of the item.
    unit_price: (string) The price per unit of the item.
    quantity: (string) The quantity of the item.
    discount: (string) The discount amount applied to the item.
    tax: (string) The tax amount applied to the item.
    tax_percentage: (string) The tax percentage applied to the item.
    total: (string) The total cost of the line item after discounts and taxes.
  - paid_at: (string, date-time) The date and time at which the invoice was paid in ISO 8601 format.
  - payment_collection_type: (string) The method of payment collection, such as "automatically_charge".
- Sample data:
```
{
"id": "b5719776-d099-468a-994a-3b44a4ab596a",
"number": "INV-123",
"invoice_date": "2024-09-04T20:59:59.513447+05:30",
"due_date": "2024-09-04T20:59:59.513448+05:30",
"sub_total": "100",
"discount": "0",
"tax": "10",
"invoice_status": "paid",
"client": {
"id": "465e413d-132d-4fff-ac19-c1362566346f",
"display_name": "Jane Doe"
 },
"total": "110",
"terms": 30,
"memo": "Sample Memo",
"currency": "USD",
"line_items": [
{
"name": "Sample Item",
"description": "Sample Description",
"unit_price": "100",
"quantity": "1",
"discount": "0",
"tax": "10",
"tax_percentage": "10",
"total": "110"
 }
],
"paid_at": "2024-09-04T20:59:59.513454+05:30",
"payment_collection_type": "automatically_charge"
}
```
Invoice canceled
- Description: Triggers when an invoice is canceled
- Key: invoice_cancelled
- Output description:
  - id: (string) A unique identifier for the invoice.
  - number: (string) The invoice number used for identification.
  - invoice_date: (string, date-time) The date the invoice was issued in ISO 8601 format.
  - due_date: (string, date-time) The date by which the invoice should be paid in ISO 8601 format.
  - sub_total: (string) The subtotal amount of the invoice before discounts and taxes.
  - discount: (string) The discount amount applied to the invoice.
  - tax: (string) The total tax amount applied to the invoice.
  - invoice_status: (string) The current status of the invoice, e.g., "cancelled”.
  - client: (object) The client to whom the invoice is issued, containing:
    id: (string) Unique identifier for the client.
    display_name: (string) The display name of the client.
  - total: (string) The total amount of the invoice after discounts and taxes.
  - terms: (integer) The payment terms indicating the number of days within which payment is due.
  - memo: (string) Additional notes or memo on the invoice.
  - currency: (string) The currency code in which the invoice is issued, e.g., "USD".
  - line_items: (array of objects) A list of items included in the invoice, where each item contains:
    name: (string) The name of the item.
    description: (string) A description of the item.
    unit_price: (string) The price per unit of the item.
    quantity: (string) The quantity of the item.
    discount: (string) The discount amount applied to the item.
    tax: (string) The tax amount applied to the item.
    tax_percentage: (string) The tax percentage applied to the item.
    total: (string) The total cost of the line item after discounts and taxes.
  - payment_collection_type: (string) The method of payment collection, such as "automatically_charge".
- Sample data:
```
{
"id": "38a4117f-e622-44bd-9596-e30e0734c495",
"number": "INV-123",
"invoice_date": "2024-09-04T21:01:01.455078+05:30",
"due_date": "2024-09-04T21:01:01.455079+05:30",
"sub_total": "100",
"discount": "0",
"tax": "10",
"invoice_status": "canceled",
"client": {
"id": "e3792a00-c68f-4647-bd4f-1006de1b450c",
"display_name": "Jane Doe"
 },
"total": "110",
"terms": 30,
"memo": "Sample Memo",
"currency": "USD",
"line_items": [
{
"name": "Sample Item",
"description": "Sample Description",
"unit_price": "100",
"quantity": "1",
"discount": "0",
"tax": "10",
"tax_percentage": "10",
"total": "110"
 }
],
"payment_collection_type": "automatically_charge"
}
```

Actions

This section encompasses various create operations which are actions the user can perform:

Create business customer
- Description: Adds a new business customer.
- Key: create_business_customer
- Outlined fields:
  - business_name: "Sample Business"
  - contacts:
    first_name: "Jane"
    middle_name: "S" (Optional)
    last_name: "Doe"
    phone: "8888888888" (Optional)
    email: "[email protected]"
    is_primary: true
- Sample input:
```
{
"business_name": "Sample Business",
"contacts": [
{
"first_name": "Jane",
"middle_name": "S",
"last_name": "Doe",
"phone": "8888888888",
"email": "[email protected]",
"is_primary": true
 }
]
}
```
- Sample output:
```
{
"data": {
"id": "12344"
 }
}
```
Create business prospect
- Description: Adds a business prospect.
- Key: create_business_prospect
- Outlined fields:
  - business_name: "Sample Prospect Business"
  - contacts:
    first_name: "Anna"
    middle_name: "M" (Optional)
    last_name: "Smith"
    phone: "7777777777" (Optional)
    email: "[email protected]"
    is_primary: true
- Sample Input:
```
{
"business_name": "Sample Prospect Business",
"contacts": [
{
"first_name": "Anna",
"middle_name": "M",
"last_name": "Smith",
"phone": "7777777777",
"email": "[email protected]",
"is_primary": true
 }
]
}
```
- Sample Output:
```
{
"data": {
"id": "12344"
 }
}
```
Create individual customer
- Description: Adds an individual customer.
- Key: create_individual_customer
- Outlined fields:
  - business_name: (string) The official name of the business or company.
  - contacts: (array of objects) A list containing contact information for people associated with the business.
    first_name: (string) The contact's first name; required.
    middle_name: (string, optional) The contact's middle initial or middle name; not mandatory.
    last_name: (string) The contact's last name; required.
    phone: (string, optional) The contact's phone number; not mandatory.
    email: (string) The contact's email address; required.
    is_primary: (boolean) Indicates whether this contact is the primary contact for the business; required.
- Sample input:
```
{
"firstname": "Emily",
"middlename": "A",
"lastname": "Brown",
"contacts": [
{
"first_name": "Michael",
"middle_name": "B",
"last_name": "Johnson",
"email": "[email protected]",
"phone": "6666666666",
"is_primary": true
 }
]
}
```
- Sample output:
```
{
"data": {
"id": "12344"
 }
}
```
Create individual prospect
- Description: Creates an individual prospect.
- Key: create_individual_prospect
- Outlined fields:
  - firstname: "James"
  - lastname: "Wilson"
  - middlename: "R" (Optional)
  - contacts:
    first_name: "Sarah"
    middle_name: "C" (Optional)
    last_name: "Davis"
    phone: "5555555555" (Optional)
    email: "[email protected]"
    is_primary: true
- Sample input:
```
{
"firstname": "James",
"lastname": "Wilson",
"middlename": "R",
"contacts": [
{
"first_name": "Sarah",
"middle_name": "C",
"last_name": "Davis",
"phone": "5555555555",
"email": "[email protected]",
"is_primary": true
 }
]
}
```
- Sample output:
```
{
"data": {
"id": "12344"
 }
}
```

Manage Services

GoCardless Integration

Zapier Integration

Managing signed proposals

FAQs

Zapier Integration Schema

Table of contents

Version information

Authentication

a. OAuth2 authentication

Fields

Triggers

a. Proposal triggers

Proposal published

Proposal accepted

Proposal created

Proposal lost

Proposal revoked

b. Client Triggers

Client created

Client updated

Client converted to customer

c. Invoice Triggers

Invoice created

Invoice updated

Invoice finalized

Invoice paid

Invoice canceled

Actions

Create business customer

Create business prospect

Create individual customer

Create individual prospect