Skip to main content
Server path: /clientary-billing | Type: Application | PCID required: Yes

Tools


clientary_billing_create_estimate

Create a new estimate Parameters:
ParameterTypeRequiredDefaultDescription
estimateobjectYesThe estimate value

clientary_billing_create_invoice

Create a new invoice Parameters:
ParameterTypeRequiredDefaultDescription
invoiceobjectYesThe invoice value

clientary_billing_create_payment

Create a payment for an invoice Parameters:
ParameterTypeRequiredDefaultDescription
invoice_idintegerYesInvoice ID
paymentobjectYesThe payment value

clientary_billing_create_recurring_schedule

Create a recurring schedule Parameters:
ParameterTypeRequiredDefaultDescription
recurring_scheduleobjectYesRecurring Schedule

clientary_billing_delete_estimate

Delete an estimate Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesEstimate ID

clientary_billing_delete_invoice

Delete an invoice Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesInvoice ID

clientary_billing_delete_payment

Delete a payment Parameters:
ParameterTypeRequiredDefaultDescription
invoice_idintegerYesInvoice ID
idintegerYesPayment ID

clientary_billing_delete_recurring_schedule

Delete a recurring schedule Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesRecurring schedule ID

clientary_billing_get_estimate

Get a single estimate Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesEstimate ID

clientary_billing_get_invoice

Get a single invoice Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesInvoice ID

clientary_billing_get_recurring_schedule

Get a recurring schedule Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesRecurring schedule ID

clientary_billing_list_client_payment_profiles

List payment profiles for a client Parameters:
ParameterTypeRequiredDefaultDescription
client_idintegerYesClient ID

clientary_billing_list_estimates

List all estimates Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number

clientary_billing_list_invoices

List all invoices Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
updated_sincestringNoFilter invoices updated since this date (YYYY-MM-DD)

clientary_billing_list_payments

List all payments Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
sortstringNoSort order. Use ‘created_at’ to sort by creation date.

clientary_billing_list_recurring_schedules

List recurring schedules Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number

clientary_billing_send_estimate

Send an estimate Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesEstimate ID
attach_pdfbooleanNoAttach PDF of estimate
messagestringNoEmail message body
recipientsstring[]YesArray of recipient email addresses (required)
send_copybooleanNoSend a copy to yourself
subjectstringNoEmail subject

clientary_billing_send_invoice

Send an invoice Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesInvoice ID
attach_pdfbooleanNoAttach PDF of invoice
messagestringNoEmail message body
recipientsstring[]YesArray of recipient email addresses (required)
send_copybooleanNoSend a copy to yourself
subjectstringNoEmail subject

clientary_billing_update_estimate

Update an estimate Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesEstimate ID
estimateobjectNoThe estimate value

clientary_billing_update_invoice

Update an invoice Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesInvoice ID
invoiceobjectNoThe invoice value

clientary_billing_update_recurring_schedule

Update a recurring schedule Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesRecurring schedule ID
recurring_scheduleobjectNoRecurring Schedule