Tranzakt APIs

Get Collection Invoices

GET

https://api.tranzakt.finance/api/v1/collections/{id}/invoices

Returns a paginated list of invoices belonging to the specified collection, with optional filtering capabilities.

Request

Path Params

string

required

Collection ID

Example:

550e8400-e29b-41d4-a716-446655440000

Query Params

invoiceStatus

string

optional

Filter by "Paid", "Unpaid", or "Invalidated"

Example:

Paid

string

optional

Search by invoice title or payer name

Example:

John

startDate

string

optional

Filter by start date (YYYY-MM-DD)

Example:

2024-04-01

endDate

string

optional

Filter by end date (YYYY-MM-DD)

Example:

2024-04-09

invoiceType

string

optional

Filter by "Test" or "Live" (default: Live)

Example:

Test

page

string

optional

Page number (default: 1)

Example:

pageSize

string

optional

Items per page (default: 10)

Example:

Header Params

x-api-key

string

required

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.tranzakt.finance/api/v1/collections/550e8400-e29b-41d4-a716-446655440000/invoices?invoiceStatus=Paid&search=John&startDate=2024-04-01&endDate=2024-04-09&invoiceType=Test&page=1&pageSize=50' \
--header 'x-api-key: Your secret key'

Responses

🟢200OK

application/json

Body

object {0}

Examples

SuccessException

{
    "status": "success",
    "message": "Invoices fetched successfully",
    "data": {
        "items": [
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "title": "Invoice #123",
                "amount": 1000,
                "status": "Paid",
                "payerName": "John Doe",
                "payerEmail": "john@example.com",
                "dateCreated": "2024-03-21T10:00:00Z",
                "datePaid": "2024-03-21T10:30:00Z"
            }
        ],
        "page": 1,
        "pageSize": 10,
        "totalCount": 1,
        "hasNextPage": true,
        "hasPreviousPage": true
    }
}

Modified at 2024-11-07 01:25:59

Get Collection by ID

Invoices