Skip to main content
Chaser logo
  • Category: accounting
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 30
  • Triggers: 0
  • Slug: CHASER
  • Version: 20261101_00

Tools

Slug: CHASER_CREATE_CONTACT_PERSONTool to create a new contact person for a customer in Chaser. Requires customer_id and external_id. Use when adding additional contacts to an existing customer account.

Input Parameters

string ("ACTIVE" | "ARCHIVED")
Contact person status: ACTIVE or ARCHIVED
string
required
Customer unique identifier. Both “id” and “external_id” can be used. In case of “external_id” please prepend “ext_” prefix (e.g., ext_1234)
string
required
Unique external (source system) ID for the contact person
string
Contact person’s phone number (include country code)
string
Contact person’s mobile number (include country code)
string
Contact person’s last name
string
Contact person’s first name
string
Email address for the contact person

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_CREATE_INVOICETool to create a new invoice record in the organization. Use after ensuring the customer exists in Chaser.

Input Parameters

string
required
Date the invoice was issued (ISO 8601)
number
required
Total amount of the invoice
string ("DRAFT" | "SUBMITTED" | "AUTHORISED" | "PAID" | "VOIDED" | "DELETED")
required
Status of the invoice
string
required
Date payment is due (ISO 8601)
number
Sub-total amount of the invoice
number
required
Amount left to pay on the invoice
string
required
External unique identifier for the invoice
number
required
Amount paid on the invoice
string
required
ISO 4217 currency code, 3 uppercase letters
string
required
Invoice reference number (not necessarily unique)
string
Date the invoice was fully paid (ISO 8601), if applicable
string
required
External ID of the associated customer

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_CREATE_OVERPAYMENTCreates a new overpayment record in Chaser for tracking customer overpayments. Overpayments represent amounts paid by customers in excess of invoice amounts and can be used to offset future invoices. The customer must exist in Chaser before creating an overpayment (use POST /customers first if needed). Valid statuses: DRAFT, SUBMITTED, AUTHORISED, PAID, VOIDED, DELETED.

Input Parameters

string
required
ISO 8601 timestamp when the overpayment was made.
number
required
Total amount of the overpayment.
string ("DRAFT" | "SUBMITTED" | "AUTHORISED" | "PAID" | "VOIDED" | "DELETED")
required
Status of the overpayment. Valid values: DRAFT, SUBMITTED, AUTHORISED, PAID, VOIDED, DELETED.
string
required
Three-letter ISO currency code for the overpayment (e.g., USD, EUR, GBP).
string
required
External unique identifier for the overpayment.
number
required
Remaining credit amount available on the overpayment.
string
required
External identifier of the customer linked to this overpayment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_DELETE_CONTACT_PERSONTool to delete a contact person from a customer record in Chaser. Use this when you need to remove a specific contact person associated with a customer. Requires both the customer identifier and the contact person identifier.

Input Parameters

string
required
Customer unique identifier. Both ‘id’ and ‘external_id’ can be used. In case of ‘external_id’ please prepend ‘ext_’ prefix (e.g. ext_1234)
string
required
Contact person unique identifier (external_id)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_GET_CONTACT_PERSONTool to get a specific contact person by ID for a customer. Use when you need to retrieve detailed information about a contact person associated with a customer in Chaser.

Input Parameters

string
required
Customer unique identifier. Both “id” and “external_id” can be used. In case of “external_id” please prepend “ext_” prefix (e.g. /v1/customers/ext_1234)
string
required
Contact person unique identifier (external_id)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_GET_CREDIT_NOTE_BY_IDRetrieve detailed information for a specific credit note by its ID. Accepts both internal Chaser IDs and external credit note IDs (with ‘ext_’ prefix). Use when you need to fetch complete details of a single credit note.

Input Parameters

string
required
Credit Note unique identifier. Both ‘id’ and ‘credit_note_id’ can be used. In case of ‘credit_note_id’ please prepend ‘ext_’ prefix (e.g., ‘ext_1234’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_GET_CREDIT_NOTESRetrieves a list of credit notes from Chaser. Supports filtering by customer, status, and date range. Returns all credit notes if no filters are specified.

Input Parameters

string ("ACTIVE" | "SUBMITTED" | "AUTHORISED" | "PAID" | "VOIDED" | "DELETED")
Filter by credit note status.
string
Filter to credit notes issued on or before this date (YYYY-MM-DD).
string
Filter to credit notes issued on or after this date (YYYY-MM-DD).
string
Filter by the external ID of the customer associated with the credit note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_GET_CURRENT_ORGANISATIONTool to retrieve information about the current organisation associated with the API credentials. Use when you need the organisation ID, currency, timezone, or legal details for the authenticated account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_GET_CUSTOMER_BY_IDRetrieve detailed information for a specific customer by their Chaser customer ID. Use this after obtaining the customer_id from listing customers or creating a customer. The customer_id is the internal Chaser identifier (e.g., ‘cust_abc123’), not the external_id from your source system.

Input Parameters

string
required
The unique Chaser customer ID (e.g., ‘cust_abc123’). This is the internal Chaser ID returned when creating or listing customers, not the external_id from your source system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_GET_CUSTOMERSTool to retrieve a list of all customers associated with the organization. Use when you need to display or process complete customer contact and status information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_GET_INVOICETool to retrieve detailed information for a specific invoice by its ID. Use when you need to view invoice details, payment status, or associated customer information.

Input Parameters

string
required
Invoice unique identifier. Both ‘id’ and ‘invoice_id’ can be used. In case of ‘invoice_id’ please prepend ‘ext_’ prefix (e.g., ext_1234). For internal Chaser ID, use the id directly (e.g., inv_HbpSNsJrr).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_GET_ORGANIZATIONTool to retrieve information about the connected organizations. Use when you need organization IDs, currency, timezone, or legal details before other operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_GET_OVERPAYMENTRetrieve detailed information for a specific overpayment by its ID. Use when you need to fetch overpayment details, check remaining credit, or verify overpayment status. Both internal ID (e.g., op_XXX) and external ID with ‘ext_’ prefix are supported.

Input Parameters

string
required
Overpayment unique identifier. Both ‘id’ and ‘overpayment_id’ can be used. In case of ‘overpayment_id’ please prepend ‘ext_’ prefix (e.g., ext_1234 or op_OUJnSE1wQ for internal ID).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_GET_STATUSTool to check the status of the Chaser API. Use when you need to verify if the API is operational before making other requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_LIST_CONTACT_PERSONSTool to retrieve contact persons for a specific customer. Returns a paginated list of contact persons with their details. Use when you need to get contact information for a customer’s representatives.

Input Parameters

string
required
Customer unique identifier. Both ‘id’ and ‘external_id’ can be used. In case of ‘external_id’ please prepend ‘ext_’ prefix (e.g., ‘ext_CUST-2026-001’ or ‘cust_abc123’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_LIST_INVOICESTool to retrieve invoices with pagination and filtering. Use when you need to fetch invoice records from Chaser with support for various filter criteria including status, amounts, dates, and customer information.

Input Parameters

string
Filter by invoice date. Supported operators: gt, lt, gte, lte, eq, ne. Use ISO date format (YYYY-MM-DD).
integer
Page number, starts from 0.
integer
Number of items per page (maximum 100).
string
Filter by total invoice amount. Supported operators: gt, lt, gte, lte, eq, ne.
string
Filter by invoice status. Supported operators: in, nin, eq, ne. Valid statuses: DRAFT, SUBMITTED, AUTHORISED, PAID, VOIDED, DELETED.
string
Filter by due date. Supported operators: gt, lt, gte, lte, eq, ne. Use ISO date format (YYYY-MM-DD).
string
Filter by subtotal amount. Supported operators: gt, lt, gte, lte, eq, ne.
string
Filter by amount due. Supported operators: gt, lt, gte, lte, eq, ne.
string
Filter by invoice ID. Supported operators: in, nin, eq, ne.
string
Filter by amount paid. Supported operators: gt, lt, gte, lte, eq, ne.
string
Filter by currency code (3-letter ISO code). Supported operators: in, nin, eq, ne.
string
Filter by invoice number. Supported operators: in, nin, eq, ne.
string
Filter by fully paid date. Supported operators: gt, lt, gte, lte, eq, ne. Use ISO date format (YYYY-MM-DD).
string
Filter by customer external ID. Supported operators: in, nin, eq, ne.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_LIST_OVERPAYMENTSTool to retrieve overpayments from Chaser with pagination and filtering. Use when you need to list overpayments, check remaining credits, or filter by customer, amount, currency, or date.

Input Parameters

string
Filter by overpayment date (ISO 8601 format). Supported operators: gt, lt, gte, lte, eq, ne. Example: ‘gte:2024-01-01’ for dates on or after Jan 1, 2024.
integer
Page number to retrieve, starts from 0.
integer
Number of items per page. Maximum is 100.
string
Filter by total overpayment amount. Supported operators: gt, lt, gte, lte, eq, ne. Example: ‘gte:1000’ for total >= 1000.
string
Filter by currency code (ISO 4217). Supported operators: in, nin, eq, ne. Example: ‘eq:USD’ or ‘in:USD,GBP’.
string
Filter by overpayment external ID. Supported operators: in, nin, eq, ne. Example: ‘eq:overpay123’ or ‘in:overpay1,overpay2’.
string
Filter by remaining credit amount. Supported operators: gt, lt, gte, lte, eq, ne. Example: ‘gte:100’ for credit >= 100.
string
Filter by customer external ID. Supported operators: in, nin, eq, ne. Example: ‘eq:cust123’ or ‘in:cust1,cust2’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_POST_CREDIT_NOTECreates a new credit note record in Chaser for tracking customer credits. Credit notes represent amounts owed to customers and are used to reduce outstanding invoices. The customer must exist in Chaser before creating a credit note (use POST /customers first). Note: ACTIVE is not a valid status for creating credit notes via API. Valid statuses: SUBMITTED, AUTHORISED, PAID, VOIDED, DELETED.

Input Parameters

string
required
ISO 8601 timestamp when the credit note was issued.
number
required
Total amount of the credit note.
string ("SUBMITTED" | "AUTHORISED" | "PAID" | "VOIDED" | "DELETED")
required
Status of the credit note. Note: ACTIVE is not a valid status for creating credit notes.
string
required
Three-letter ISO currency code of the credit note.
string
required
Unique identifier for the credit note.
number
required
Unallocated credit amount remaining on the credit note.
string
required
Reference number assigned to the credit note.
string
required
External identifier of the customer linked to this credit note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_POST_CUSTOMERTool to create a new customer record in Chaser. Use after obtaining Basic Auth credentials.

Input Parameters

array
List of customer group objects
string ("ACTIVE" | "ARCHIVED")
Customer visibility status (ACTIVE or ARCHIVED)
array
List of addresses to display on statements
string
required
Unique external (source system) ID for the customer
string
required
Name of the company for display in Chaser
string
Main phone number
string
Mobile number (include country code)
string
Contact person’s last name
string
Contact person’s first name
string
Email address to receive Chaser reminders

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_PUT_CREDIT_NOTEUpdate an existing credit note in Chaser by its credit note identifier. The update fields are optional and can modify details such as amount, status, or customer association.

Input Parameters

string
ISO 8601 timestamp when the credit note was issued.
number
Total amount of the credit note. Must be non-negative.
string ("DRAFT" | "SUBMITTED" | "AUTHORISED" | "PAID" | "VOIDED" | "DELETED")
Status of the credit note. Valid values: DRAFT, SUBMITTED, AUTHORISED, PAID, VOIDED, DELETED.
string
Three-letter ISO currency code of the credit note (e.g., USD, GBP, EUR).
string
required
Credit Note unique identifier. Both ‘id’ and ‘credit_note_id’ can be used. In case of ‘credit_note_id’ please prepend ‘ext_’ prefix (e.g. ext_1234)
number
Unallocated credit amount remaining on the credit note. Must be non-negative.
string
Reference number assigned to the credit note.
string
External identifier of the customer linked to this credit note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_PUT_CUSTOMERTool to update an existing customer’s information using their unique Chaser customer ID. Use after confirming the customer’s ID (the ‘id’ field, not ‘externalID’). Example: “Update contactEmailAddress for customer ID cust_abc123.”

Input Parameters

string ("ACTIVE" | "ARCHIVED")
Customer status; either ‘ACTIVE’ or ‘ARCHIVED’
string
required
The unique internal Chaser customer ID (e.g., ‘cust_abc123’). This is the ‘id’ field returned when creating or retrieving a customer, not the externalID.
string
Name of the company associated with the customer
string
The phone number of the customer
string
Mobile number including country code (e.g., +447261928377)
string
Last name of the primary contact
string
First name of the primary contact
string
Email address of the primary contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_PUT_INVOICEUpdate an existing invoice in Chaser by its internal ID. Use this to modify invoice status, amounts, dates, payments, or customer associations. Requires the internal Chaser invoice ID (e.g., ‘inv_abc123’) from invoice creation or retrieval responses.

Input Parameters

string
Invoice issue date in ISO 8601 format
number
Total invoice amount
string ("DRAFT" | "SUBMITTED" | "AUTHORISED" | "PAID" | "VOIDED" | "DELETED")
Invoice status
string
Payment due date in ISO 8601 format
array
List of payments applied to the invoice
number
Subtotal before tax
number
Remaining balance due
string
required
Internal Chaser invoice ID (e.g., ‘inv_abc123’). Use the ‘id’ field from invoice creation/retrieval responses, NOT the external invoice_id.
number
Total amount paid
string
ISO-4217 currency code, e.g., ‘USD’
string
Reference number assigned to the invoice
string
Date the invoice was fully paid in ISO 8601 format
string
External ID of the customer to associate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_UPDATE_CONTACT_PERSONTool to update a contact person for a customer in Chaser. Use when you need to modify contact person details such as name, email, or phone numbers.

Input Parameters

string ("ACTIVE" | "ARCHIVED")
Contact person status; either ‘ACTIVE’ or ‘ARCHIVED’. Default is ‘ACTIVE’
string
required
Customer unique identifier. Both “id” and “external_id” can be used. In case of “external_id” please prepend “ext_” prefix (e.g. /v1/customers/ext_1234)
string
External identifier for the contact person
string
Phone number of the contact person
string
Mobile number of the contact person including country code
string
Last name of the contact person (minimum 1 character)
string
required
Contact person unique identifier (external_id)
string
First name of the contact person (minimum 1 character)
string
Email address of the contact person

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_UPDATE_OVERPAYMENTTool to update an overpayment record in Chaser. Use when modifying overpayment details such as remaining credit, status, or other fields. All fields except overpayment_id are optional.

Input Parameters

string
Date of the overpayment in ISO 8601 date-time format
number
Total amount of the overpayment
string ("DRAFT" | "SUBMITTED" | "AUTHORISED" | "PAID" | "VOIDED" | "DELETED")
Status values for overpayments in Chaser.
string
Three-letter ISO 4217 currency code
string
Alternative field for overpayment ID (if updating this field)
string
required
Overpayment unique identifier. Both ‘id’ and ‘overpayment_id’ can be used. In case of ‘overpayment_id’ please prepend ‘ext_’ prefix (e.g., ext_1234)
number
Remaining credit amount on the overpayment
string
External identifier for the customer

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_UPLOAD_INVOICE_PDFUpload a PDF file to an existing invoice in Chaser. Use this to attach invoice documentation. The file must be a valid PDF document and is sent as multipart/form-data.

Input Parameters

object
required
PDF file to upload. Must be a valid PDF document.
string
required
Invoice unique identifier. Use the internal ‘id’ field from the invoice (format: ‘inv_xxxxx’). The external invoice_id format is not supported for this endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_UPSERT_BULK_CUSTOMERSBulk upsert up to 100 customers in a single operation, using external_id to identify customers for updates.

Input Parameters

array
required
Array of customer objects to upsert (max 100 items). Customers are matched by external_id (or id) for updates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_UPSERT_CONTACT_PERSONSTool to bulk insert or update contact persons for a customer. Use when you need to create or update multiple contact persons in a single request (up to 100). Matching is done by external_id - existing contacts with the same external_id will be updated, new ones will be inserted.

Input Parameters

array
required
List of contact person entries to insert or update. Maximum 100 entries per request. Matching is done by external_id.
string
required
Customer unique identifier. Both ‘id’ and ‘external_id’ can be used. For external_id, prepend ‘ext_’ prefix (e.g., ext_1234)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_UPSERT_CREDIT_NOTES_BULKBulk upsert up to 100 credit notes in a single request, using credit_note_id to identify entries for matching.

Input Parameters

array
required
Array of credit note objects to upsert. Maximum 100 items per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_UPSERT_INVOICESTool to bulk upsert up to 100 invoices in a single request. Invoices are matched by invoice_id for updates or created if not found. Use when you need to create or update multiple invoices efficiently.

Input Parameters

array
required
Array of invoice objects to upsert. Maximum 100 items. Invoices are matched by invoice_id for updates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHASER_UPSERT_OVERPAYMENTS_BULKTool to bulk upsert up to 100 overpayments in Chaser, matching by overpayment_id. Use when you need to create or update multiple overpayment records in a single operation.

Input Parameters

array
required
Array of overpayment objects to upsert. Maximum 100 entries per request. Matching is performed by overpayment_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not