Add and Update Payment Records

Learn to record payments and update them using the FreshBooks API.


In this lesson, we learn to record payments against invoices. The user:payments:write and user:payments:read scope permissions are required to execute the payment operations. In the sections below, we explore these two endpoints:

  • Record a payment: {base_url}/accounting/account/{ACCOUNT_ID}/payments/payments
  • Update a payment record: {base_url}/accounting/account/{ACCOUNT_ID}/payments/payments/{PAYMENT_ID}

Record a payment

Let’s add a payment record to a specific invoice in a user account specified by {ACCOUNT_ID}.

Request parameters

As this call is an HTTP POST request, the request’s payload object has parameters. Let’s see some of the parameters in the table below:

Get hands-on with 1200+ tech skills courses.