Skip to Content
HelvetlyDocs
API referenceInvoices

List an invoice's payments

Needs a token with the read:invoices scope (or write:invoices). Authentication

Try in Playground sends a real request to app.helvetly.com with a token you paste. It stays in this browser tab only (session storage) and goes to no one else.

GET
/api/v1/invoices/{id}/payments

Payments recorded against the invoice.

Authorization

bearerAuth
headerAuthorizationBearer <token>

A personal API token, hvt_…, with scopes such as read:* or write:invoices

Path Parameters

id*string

The record's id.

Response Body

OK

application/json
  1. response
data*array<>
Example Request
curl -X GET 'https://app.helvetly.com/api/v1/invoices/string/payments'
Example Response
{  "data": [    {      "id": "string",      "amount": "1234.50",      "paid_on": "2019-08-24",      "method": "bank_transfer",      "note": "string",      "created_at": "2019-08-24T14:15:22Z",      "created_by": {        "id": "string",        "name": "string"      }    }  ]}