Sign in

v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB
Payments

Get all documents associated with the specific invoice

Get all metadata associated with all documents for a specific invoice. Each item in the response body contains information about the document name, template and url.

Required scopes: flex.billing.payments.documents.read

get/api/v2/organizations/{orgSlug}/payments/{paymentId}/documents

Path parameters

paymentIdstring required

invoice/overpayment/credit note id

orgSlugstring required

organization slug

Response

_idstring

The _id of the document associated with the payment.

namestring

The name of the document associated with the payment.

urlstring

The URL of the document associated with the payment.

typestring

The template type of the document associated with the payment.

templateNamestring

The template name of the document associated with the payment.

Example response

{
  "_id": "6a59d07d856fad4ee41952b3",
  "name": "Membership fee",
  "url": "https://example.com/document.pdf",
  "type": "invoice",
  "templateName": "Invoice Template"
}