Staff have access to the API calls listed below if the Invoices tab is enabled for staff. Staff users can only access payments that belong to clients they are assigned to.
Create a new payment and returns the corresponding payment_id.
This function can have one of three possible effects depending on the presence of invoice_id and client_id:
Payment type must be one of: ‘Cash’, ‘Check’, ‘Credit’, ‘Credit Card’, ‘Bank Transfer’, ‘Debit’, ‘PayPal’, ’2Checkout’, ‘VISA’, ‘MASTERCARD’, ‘DISCOVER’, ‘NOVA’, ‘AMEX’, ‘DINERS’, ‘EUROCARD’, ‘JCB’ or ‘ACH’.
- If you specify an invoice_id only, the payment will be recorded as an invoice payment.
- If you specify a client_id only, the payment will be recorded as a client credit.
- If you specify both an invoice_id and client_id, the payment will be recorded as an invoice payment, and the amount will be subtracted from the client’s credit.
Note that ‘currency_code’ can only be provided when creating a credit, not a regular payment. Regular payments will default to the currency code of the invoice they are being made against.
Update an existing payment. All fields besides payment_id are optional – unpassed fields will retain their existing value.
Note that ‘currency_code’ can only be provided when updating a credit, not a regular payment. Regular payments will default to the currency code of the invoice they are being made against.
Retrieve payment details according to payment_id.
Permanently delete a payment. This will modify the status of the associated invoice if required.
Returns a list of recorded payments. You can optionally filter by invoice_id or client_id.
Note: This method uses pagination.