clientary-billing

Invoices, Estimates, Payments, Recurring

Server path: /clientary-billing | Type: Application | PCID required: Yes

Tools

Tool	Description
clientary_billing_create_estimate	Create a new estimate
clientary_billing_create_invoice	Create a new invoice
clientary_billing_create_payment	Create a payment for an invoice
clientary_billing_create_recurring_schedule	Create a recurring schedule
clientary_billing_delete_estimate	Delete an estimate
clientary_billing_delete_invoice	Delete an invoice
clientary_billing_delete_payment	Delete a payment
clientary_billing_delete_recurring_schedule	Delete a recurring schedule
clientary_billing_get_estimate	Get a single estimate
clientary_billing_get_invoice	Get a single invoice
clientary_billing_get_recurring_schedule	Get a recurring schedule
clientary_billing_list_client_payment_profiles	List payment profiles for a client
clientary_billing_list_estimates	List all estimates
clientary_billing_list_invoices	List all invoices
clientary_billing_list_payments	List all payments
clientary_billing_list_recurring_schedules	List recurring schedules
clientary_billing_send_estimate	Send an estimate
clientary_billing_send_invoice	Send an invoice
clientary_billing_update_estimate	Update an estimate
clientary_billing_update_invoice	Update an invoice
clientary_billing_update_recurring_schedule	Update a recurring schedule

---

clientary_billing_create_estimate

Create a new estimate

Parameters:

Parameter	Type	Required	Default	Description
estimate	object	Yes	—	The estimate value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "estimate": {
      "type": "object",
      "description": "The estimate value",
      "properties": {
        "date": {
          "type": "string",
          "description": "Estimate date (YYYY-MM-DD, required)"
        },
        "currency_code": {
          "type": "string",
          "description": "Currency code e.g. USD, EUR (required)"
        },
        "number": {
          "type": "string",
          "description": "Unique estimate number (auto-incremented if omitted)"
        },
        "client_id": {
          "type": "integer",
          "description": "Associated client ID"
        },
        "title": {
          "type": "string",
          "description": "Estimate title"
        },
        "note": {
          "type": "string",
          "description": "Notes"
        },
        "tax": {
          "type": "number",
          "description": "Tax rate"
        },
        "tax_label": {
          "type": "string",
          "description": "Tax label"
        },
        "tax2": {
          "type": "number",
          "description": "Second tax rate"
        },
        "tax2_label": {
          "type": "string",
          "description": "Second tax label"
        },
        "tax3": {
          "type": "number",
          "description": "Third tax rate"
        },
        "tax3_label": {
          "type": "string",
          "description": "Third tax label"
        },
        "compound_tax": {
          "type": "boolean",
          "description": "Whether taxes compound"
        },
        "estimate_items_attributes": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Line items for the estimate"
        }
      },
      "required": [
        "date",
        "currency_code"
      ]
    }
  },
  "required": [
    "PCID",
    "estimate"
  ]
}

---

clientary_billing_create_invoice

Create a new invoice

Parameters:

Parameter	Type	Required	Default	Description
invoice	object	Yes	—	The invoice value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "invoice": {
      "type": "object",
      "description": "The invoice value",
      "properties": {
        "date": {
          "type": "string",
          "description": "Invoice date (YYYY-MM-DD, required)"
        },
        "due_date": {
          "type": "string",
          "description": "Due date (YYYY-MM-DD, required)"
        },
        "currency_code": {
          "type": "string",
          "description": "Currency code e.g. USD (required)"
        },
        "number": {
          "type": "string",
          "description": "Unique invoice number (auto-incremented if omitted)"
        },
        "client_id": {
          "type": "integer",
          "description": "Associated client ID"
        },
        "title": {
          "type": "string",
          "description": "Invoice title"
        },
        "note": {
          "type": "string",
          "description": "Notes"
        },
        "po": {
          "type": "string",
          "description": "Purchase order number"
        },
        "tax": {
          "type": "number",
          "description": "Tax rate"
        },
        "tax_label": {
          "type": "string",
          "description": "Tax label"
        },
        "tax2": {
          "type": "number",
          "description": "The tax2 value"
        },
        "tax2_label": {
          "type": "string",
          "description": "Tax2 Label"
        },
        "tax3": {
          "type": "number",
          "description": "The tax3 value"
        },
        "tax3_label": {
          "type": "string",
          "description": "Tax3 Label"
        },
        "compound_tax": {
          "type": "boolean",
          "description": "Compound Tax"
        },
        "invoice_items_attributes": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Line items for the invoice"
        }
      },
      "required": [
        "date",
        "due_date",
        "currency_code"
      ]
    }
  },
  "required": [
    "PCID",
    "invoice"
  ]
}

---

clientary_billing_create_payment

Create a payment for an invoice

Parameters:

Parameter	Type	Required	Default	Description
invoice_id	integer	Yes	—	Invoice ID
payment	object	Yes	—	The payment value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "invoice_id": {
      "type": "integer",
      "description": "Invoice ID"
    },
    "payment": {
      "type": "object",
      "description": "The payment value",
      "properties": {
        "amount": {
          "type": "number",
          "description": "Payment amount"
        },
        "note": {
          "type": "string",
          "description": "Payment note"
        },
        "payment_profile_id": {
          "type": "integer",
          "description": "Payment profile ID for auto-charge (charges full balance)"
        }
      }
    }
  },
  "required": [
    "PCID",
    "invoice_id",
    "payment"
  ]
}

---

clientary_billing_create_recurring_schedule

Create a recurring schedule

Parameters:

Parameter	Type	Required	Default	Description
recurring_schedule	object	Yes	—	Recurring Schedule

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "recurring_schedule": {
      "type": "object",
      "description": "Recurring Schedule",
      "properties": {
        "due_period": {
          "type": "integer",
          "description": "Number of days until due (required)"
        },
        "currency_code": {
          "type": "string",
          "description": "Currency code e.g. USD (required)"
        },
        "next_date": {
          "type": "string",
          "description": "Next invoice date (required)"
        },
        "time_interval": {
          "type": "integer",
          "description": "Interval: 1=weekly, 2=bi-weekly, 3=monthly, etc. (required)"
        },
        "client_id": {
          "type": "integer",
          "description": "Client ID (required)"
        },
        "number": {
          "type": "string",
          "description": "Schedule number"
        },
        "title": {
          "type": "string",
          "description": "Schedule title"
        },
        "note": {
          "type": "string",
          "description": "Notes"
        },
        "po": {
          "type": "string",
          "description": "Purchase order number"
        },
        "action": {
          "type": "integer",
          "description": "0=Send, 1=Draft, 2=Autobill"
        },
        "unlimited": {
          "type": "boolean",
          "description": "Whether schedule runs indefinitely"
        },
        "occurrences_remaining": {
          "type": "integer",
          "description": "Number of remaining occurrences"
        },
        "tax": {
          "type": "number",
          "description": "The tax value"
        },
        "tax_label": {
          "type": "string",
          "description": "Tax Label"
        },
        "tax2": {
          "type": "number",
          "description": "The tax2 value"
        },
        "tax2_label": {
          "type": "string",
          "description": "Tax2 Label"
        },
        "tax3": {
          "type": "number",
          "description": "The tax3 value"
        },
        "tax3_label": {
          "type": "string",
          "description": "Tax3 Label"
        },
        "compound_tax": {
          "type": "boolean",
          "description": "Compound Tax"
        },
        "recurring_schedule_items_attributes": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Line items"
        }
      },
      "required": [
        "due_period",
        "currency_code",
        "next_date",
        "time_interval",
        "client_id"
      ]
    }
  },
  "required": [
    "PCID",
    "recurring_schedule"
  ]
}

---

clientary_billing_delete_estimate

Delete an estimate

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	Estimate ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "Estimate ID"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

clientary_billing_delete_invoice

Delete an invoice

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	Invoice ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "Invoice ID"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

clientary_billing_delete_payment

Delete a payment

Parameters:

Parameter	Type	Required	Default	Description
invoice_id	integer	Yes	—	Invoice ID
id	integer	Yes	—	Payment ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "invoice_id": {
      "type": "integer",
      "description": "Invoice ID"
    },
    "id": {
      "type": "integer",
      "description": "Payment ID"
    }
  },
  "required": [
    "PCID",
    "invoice_id",
    "id"
  ]
}

---

clientary_billing_delete_recurring_schedule

Delete a recurring schedule

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	Recurring schedule ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "Recurring schedule ID"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

clientary_billing_get_estimate

Get a single estimate

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	Estimate ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "Estimate ID"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

clientary_billing_get_invoice

Get a single invoice

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	Invoice ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "Invoice ID"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

clientary_billing_get_recurring_schedule

Get a recurring schedule

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	Recurring schedule ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "Recurring schedule ID"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

clientary_billing_list_client_payment_profiles

List payment profiles for a client

Parameters:

Parameter	Type	Required	Default	Description
client_id	integer	Yes	—	Client ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "client_id": {
      "type": "integer",
      "description": "Client ID"
    }
  },
  "required": [
    "PCID",
    "client_id"
  ]
}

---

clientary_billing_list_estimates

List all estimates

Parameters:

Parameter	Type	Required	Default	Description
page	integer	No	—	Page number

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    }
  },
  "required": [
    "PCID"
  ]
}

---

clientary_billing_list_invoices

List all invoices

Parameters:

Parameter	Type	Required	Default	Description
page	integer	No	—	Page number
updated_since	string	No	—	Filter invoices updated since this date (YYYY-MM-DD)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "updated_since": {
      "type": "string",
      "description": "Filter invoices updated since this date (YYYY-MM-DD)"
    }
  },
  "required": [
    "PCID"
  ]
}

---

clientary_billing_list_payments

List all payments

Parameters:

Parameter	Type	Required	Default	Description
page	integer	No	—	Page number
sort	string	No	—	Sort order. Use ‘created_at’ to sort by creation date.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "sort": {
      "type": "string",
      "description": "Sort order. Use 'created_at' to sort by creation date.",
      "enum": [
        "created_at"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

clientary_billing_list_recurring_schedules

List recurring schedules

Parameters:

Parameter	Type	Required	Default	Description
page	integer	No	—	Page number

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page": {
      "type": "integer",
      "description": "Page number"
    }
  },
  "required": [
    "PCID"
  ]
}

---

clientary_billing_send_estimate

Send an estimate

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	Estimate ID
attach_pdf	boolean	No	—	Attach PDF of estimate
message	string	No	—	Email message body
recipients	string[]	Yes	—	Array of recipient email addresses (required)
send_copy	boolean	No	—	Send a copy to yourself
subject	string	No	—	Email subject

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "Estimate ID"
    },
    "attach_pdf": {
      "type": "boolean",
      "description": "Attach PDF of estimate"
    },
    "message": {
      "type": "string",
      "description": "Email message body"
    },
    "recipients": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of recipient email addresses (required)"
    },
    "send_copy": {
      "type": "boolean",
      "description": "Send a copy to yourself"
    },
    "subject": {
      "type": "string",
      "description": "Email subject"
    }
  },
  "required": [
    "PCID",
    "id",
    "recipients"
  ]
}

---

clientary_billing_send_invoice

Send an invoice

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	Invoice ID
attach_pdf	boolean	No	—	Attach PDF of invoice
message	string	No	—	Email message body
recipients	string[]	Yes	—	Array of recipient email addresses (required)
send_copy	boolean	No	—	Send a copy to yourself
subject	string	No	—	Email subject

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "Invoice ID"
    },
    "attach_pdf": {
      "type": "boolean",
      "description": "Attach PDF of invoice"
    },
    "message": {
      "type": "string",
      "description": "Email message body"
    },
    "recipients": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of recipient email addresses (required)"
    },
    "send_copy": {
      "type": "boolean",
      "description": "Send a copy to yourself"
    },
    "subject": {
      "type": "string",
      "description": "Email subject"
    }
  },
  "required": [
    "PCID",
    "id",
    "recipients"
  ]
}

---

clientary_billing_update_estimate

Update an estimate

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	Estimate ID
estimate	object	No	—	The estimate value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "Estimate ID"
    },
    "estimate": {
      "type": "object",
      "description": "The estimate value",
      "properties": {
        "date": {
          "type": "string",
          "description": "Estimate date"
        },
        "currency_code": {
          "type": "string",
          "description": "Currency code"
        },
        "number": {
          "type": "string",
          "description": "Unique estimate number"
        },
        "client_id": {
          "type": "integer",
          "description": "Associated client ID"
        },
        "title": {
          "type": "string",
          "description": "Estimate title"
        },
        "note": {
          "type": "string",
          "description": "Notes"
        },
        "tax": {
          "type": "number",
          "description": "The tax value"
        },
        "tax_label": {
          "type": "string",
          "description": "Tax Label"
        },
        "tax2": {
          "type": "number",
          "description": "The tax2 value"
        },
        "tax2_label": {
          "type": "string",
          "description": "Tax2 Label"
        },
        "tax3": {
          "type": "number",
          "description": "The tax3 value"
        },
        "tax3_label": {
          "type": "string",
          "description": "Tax3 Label"
        },
        "compound_tax": {
          "type": "boolean",
          "description": "Compound Tax"
        },
        "estimate_items_attributes": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Estimate Items Attributes"
        }
      }
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

clientary_billing_update_invoice

Update an invoice

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	Invoice ID
invoice	object	No	—	The invoice value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "Invoice ID"
    },
    "invoice": {
      "type": "object",
      "description": "The invoice value",
      "properties": {
        "date": {
          "type": "string",
          "description": "The date value"
        },
        "due_date": {
          "type": "string",
          "description": "Due Date"
        },
        "currency_code": {
          "type": "string",
          "description": "Currency Code"
        },
        "number": {
          "type": "string",
          "description": "The number value"
        },
        "client_id": {
          "type": "integer",
          "description": "Client Id"
        },
        "title": {
          "type": "string",
          "description": "The title value"
        },
        "note": {
          "type": "string",
          "description": "The note value"
        },
        "po": {
          "type": "string",
          "description": "The po value"
        },
        "tax": {
          "type": "number",
          "description": "The tax value"
        },
        "tax_label": {
          "type": "string",
          "description": "Tax Label"
        },
        "tax2": {
          "type": "number",
          "description": "The tax2 value"
        },
        "tax2_label": {
          "type": "string",
          "description": "Tax2 Label"
        },
        "tax3": {
          "type": "number",
          "description": "The tax3 value"
        },
        "tax3_label": {
          "type": "string",
          "description": "Tax3 Label"
        },
        "compound_tax": {
          "type": "boolean",
          "description": "Compound Tax"
        },
        "invoice_items_attributes": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Invoice Items Attributes"
        }
      }
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

clientary_billing_update_recurring_schedule

Update a recurring schedule

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	Recurring schedule ID
recurring_schedule	object	No	—	Recurring Schedule

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "Recurring schedule ID"
    },
    "recurring_schedule": {
      "type": "object",
      "description": "Recurring Schedule",
      "properties": {
        "due_period": {
          "type": "integer",
          "description": "Due Period"
        },
        "currency_code": {
          "type": "string",
          "description": "Currency Code"
        },
        "next_date": {
          "type": "string",
          "description": "Next Date"
        },
        "time_interval": {
          "type": "integer",
          "description": "Time Interval"
        },
        "client_id": {
          "type": "integer",
          "description": "Client Id"
        },
        "number": {
          "type": "string",
          "description": "The number value"
        },
        "title": {
          "type": "string",
          "description": "The title value"
        },
        "note": {
          "type": "string",
          "description": "The note value"
        },
        "po": {
          "type": "string",
          "description": "The po value"
        },
        "action": {
          "type": "integer",
          "description": "The action value"
        },
        "unlimited": {
          "type": "boolean",
          "description": "The unlimited value"
        },
        "occurrences_remaining": {
          "type": "integer",
          "description": "Occurrences Remaining"
        },
        "tax": {
          "type": "number",
          "description": "The tax value"
        },
        "tax_label": {
          "type": "string",
          "description": "Tax Label"
        },
        "tax2": {
          "type": "number",
          "description": "The tax2 value"
        },
        "tax2_label": {
          "type": "string",
          "description": "Tax2 Label"
        },
        "tax3": {
          "type": "number",
          "description": "The tax3 value"
        },
        "tax3_label": {
          "type": "string",
          "description": "Tax3 Label"
        },
        "compound_tax": {
          "type": "boolean",
          "description": "Compound Tax"
        },
        "recurring_schedule_items_attributes": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Recurring Schedule Items Attributes"
        }
      }
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}