Actions (30)
Customers · 16
- Create a customerPOST /api/v3/customer
Create a new ChargeOver customer.
documented - Delete a customerDELETE /api/v3/customer/{customer_id}
Remove a customer from ChargeOver.
documented - Disconnect a customer from its parent customerPOST /api/v3/customer/{customer_id}/_action/disconnectParent
Detach a child customer from its parent.
documented - Disconnect a customer from its parent customerPOST /api/v3/customer/{customer_id}/_action/disconnectParent
Disconnect the parent/child relationship.
documented - Email a customerPOST /api/v3/customer/{customer_id}/_action/email
Send an email to the customer using a template.
documented - Email a customerPOST /api/v3/customer/{customer_id}/_action/email
Send an email to the customer.
documented - Get a specific customerGET /api/v3/customer/{customer_id}
Retrieve details for a specific customer.
documented - List customersGET /api/v3/customer
Retrieve a list of customers.
documented - Set a customer as activePOST /api/v3/customer/{customer_id}/_action/setActive
Mark a customer as active.
documented - Set a customer as activePOST /api/v3/customer/{customer_id}/_action/setActive
Mark a customer as active.
documented - Set a customer as inactivePOST /api/v3/customer/{customer_id}/_action/setInactive
Mark a customer as inactive.
documented - Set a customer as inactivePOST /api/v3/customer/{customer_id}/_action/setInactive
Mark a customer as inactive.
documented - Set the default payment method for a customerPOST /api/v3/customer/{customer_id}/_action/setPayMethod
Set the default payment method for a customer.
documented - Set the primary contact for a customerPOST /api/v3/customer/{customer_id}/_action/setSuperUser
Assign the primary contact to a customer.
documented - Set the primary contact for a customerPOST /api/v3/customer/{customer_id}/_action/setSuperUser
Assign the primary contact (user) to a customer.
documented - Update a customerPUT /api/v3/customer/{customer_id}
Update details for a specific customer.
documented
Transactions (Payments, Refunds, Credits) · 6
- Create a credit memo / Record offline paymentPOST /api/v3/transaction
Record a credit or an offline payment for a customer.
documented - Get a transactionGET /api/v3/transaction/{transaction_id}
Retrieve a specific transaction.
documented - Get a transactionGET /api/v3/transaction/{transaction_id}
Retrieve a specific transaction.
documented - List transactionsGET /api/v3/transaction
Query for transactions.
documented - Make a paymentPOST /api/v3/transaction/_action/pay
Attempt a payment for a customer using a payment method.
documented - Mark a transaction declinedPOST /api/v3/transaction/{transaction_id}/_action/decline
Mark a transaction as declined.
documented
Users / Contacts · 5
- Add a contactPOST /api/v3/user
Create a new contact for a customer.
documented - Delete a contactDELETE /api/v3/user/{user_id}
Remove a contact.
documented - Get a specific contactGET /api/v3/user/{user_id}
Retrieve details for a specific contact.
documented - List contactsGET /api/v3/user
Retrieve a list of contacts.
documented - Update a contactPUT /api/v3/user/{user_id}
Update details for a specific contact.
documented