• Home
  • Managing Receipts

Enlivy allows you to seamlessly manage receipts for your organization via its robust API.

Whether you’re synchronizing with internal payment tracking tools, generating transaction records, or integrating with finance dashboards, the Enlivy API provides endpoints to list, view, create, and update receipts with full control and flexibility.

Each receipt is linked to an organization and can hold details like amounts, currencies, status, payment methods, and linked invoices.

Using the following endpoints, you can automate and streamline receipt operations within your system.

Each receipt is tied to an organization and may contain detailed information including payment methods, statuses, and line items.

Use the following endpoints to integrate receipt management into your workflows.

This section covers the essential operations:

  • List all receipts
  • Retrieve details of a specific receipt
  • Create a new receipt
  • Edit an existing receipt

List All Receipts

Returns a list of all receipts in your organization, supporting pagination, filtering, and expanded data like line items, tags, and taxes.

bash
GET /organizations/{organizationId}/receipts

Request Headers

bash
Authorization: Bearer
Content-Type: application/json
  • page number

    Page number for pagination.

    Default: 1

  • limit number

    Number of invoices per page.

    Default: 20

  • include string

    Comma-separated list of related data to include in the response.

    Examples: invoice_prefix , line_items , taxes , tag_ids

  • include_meta string

    Type of metadata to include alongside the response data.

    Examples: navigation , totals

Example

javascript
const organizationId = "your_org_id";
const token = "YOUR_TOKEN_HERE";

fetch(`https://api.enlivy.com/organizations/${organizationId}/receipts?page=1&limit=20&include=line_items,taxes,tag_ids&include_meta=navigation`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  }
});

Request Response

This is just a preview, additional fields may appear depending on organization settings.

json
{
  "data": [
    {
      "id": "org_rct_dummy",
      "organization_id": "org_dummy",
      "organization_bank_account_id": "org_bankacc_dummy",
      "organization_sender_user_id": "org_user_dummy",
      "organization_receiver_user_id": "org_user_dummy",
      "receipt_number": "1",
      "status": "scheduled",
      "currency": "USD",
      "sub_total": 99.99,
      "discount": 0,
      "tax_total": 0,
      "total": 99.99,
      "direction": "outbound",
      "tag_ids": [],
      "taxes": {}
    }
  ],
  "meta": {
    "navigation": {
      "active": 3,
      "trash": 0
    },
    "pagination": {
      "total": 3,
      "count": 3,
      "per_page": 20,
      "current_page": 1,
      "total_pages": 1,
      "links": {}
    }
  }
}

Get a Receipt

Retrieve a specific receipt and view full details, including totals, payment method, line items, and status.

bash
GET /organizations/{organizationId}/receipts/{receiptId}

Request Headers

bash
Authorization: Bearer
Content-Type: application/json
  • include string

    Comma-separated list of related data to include in the response.

    Examples: invoice_prefix , line_items , taxes , tag_ids

Example

javascript
fetch(`https://api.enlivy.com/organizations/{organizationId}/receipts/{receiptId}?include=tag_ids,taxes`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  }
});

Request Response

This is just a preview, additional fields may appear depending on organization settings.

json
{
  "data": {
    "id": "org_rct_dummy",
    "organization_id": "org_dummy",
    "organization_bank_account_id": "org_bankacc_dummy",
    "organization_sender_user_id": "org_user_dummy",
    "organization_receiver_user_id": "org_user_dummy",
    "receipt_number": "1",
    "status": "scheduled",
    "currency": "USD",
    "sub_total": 99.99,
    "discount": 0,
    "tax_total": 0,
    "total": 99.99,
    "direction": "outbound",
    "tag_ids": [],
    "taxes": {}
  }
}

Add a Receipt

Creates a new receipt with sender, receiver, payment details, and line items.

bash
POST /organizations/{organizationId}/receipts

Request Headers

bash
Authorization: Bearer
Content-Type: application/json

Example

javascript
fetch(`https://api.enlivy.com/organizations/${organizationId}/receipts`, {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: 
});

Request Response

This is just a preview, additional fields may appear depending on organization settings.

json
{
  "data": {
    "id": "org_rct_dummy",
    "organization_id": "org_dummy",
    "organization_bank_account_id": "org_bankacc_dummy",
    "organization_sender_user_id": "org_user_dummy",
    "organization_receiver_user_id": "org_user_dummy",
    "receipt_number": "1",
    "status": "pending",
    "currency": "USD",
    "sub_total": 99.99,
    "discount": 0,
    "tax_total": 0,
    "total": 99.99,
    "direction": "outbound",
    "file_extension": "png",
    "issued_at": "2025-05-13T13:00:00Z",
    "has_file": true
  },
  "meta": {
    "has_file": true
  }
}

Edit a Receipt

Update an existing receipt’s details.

bash
PUT /organizations/{organizationId}/receipts/{receiptId}

Example

javascript
fetch(`https://api.enlivy.com/organizations/${organizationId}/receipts/${receiptId}`, {
  method: 'PUT',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: 
});

Request Response

This is just a preview, additional fields may appear depending on organization settings.

json
{
  "data": {
    "id": "org_rct_dummy",
    "organization_id": "org_dummy",
    "organization_bank_account_id": "org_bankacc_dummy",
    "organization_sender_user_id": "org_user_dummy",
    "organization_receiver_user_id": "org_user_dummy",
    "receipt_number": "2",
    "status": "pending",
    "currency": "USD",
    "sub_total": 199.99,
    "discount": 0,
    "tax_total": 0,
    "total": 199.99,
    "direction": "outbound",
    "file_extension": "png",
    "issued_at": "2025-05-13T13:00:00Z",
    "has_file": true
  },
  "meta": {
    "has_file": true
  }
}