---
title: "GET /bills/payments"
method: GET
path: "/bills/payments"
tags: ["Bill", "Bill Payments"]
---

# GET /bills/payments

`GET /bills/payments`

## Request

- Base URL: `https://api.railz.ai`
- URL: `https://api.railz.ai/bills/payments`
- Auth: HTTP bearer

Gets the latest bill payments for a business.

## Query parameters

- `businessName` string, required
- `serviceName` 'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'myob' | 'zohoBooks', required
- `startDate` string
- `endDate` string
- `offset` number
- `limit` number
- `orderBy` string

## Response `200`

- GetBillPaymentResponseDto
  - `pagination` PaginationMetaData, required
    - `offset` number, required
    - `limit` number, required
    - `count` number, required
  - `meta` TransactionalReportMetaData, required
    - `reportId` string[], required
    - `serviceName` 'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'myob' | 'zohoBooks' | 'byod', required
    - `businessName` string, required
    - `startDate` string, date-time, required
    - `endDate` string, date-time, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `count` number, required
  - `data` GetBillPaymentData[], required
    - `id` string, required
    - `vendorRef` VendorRef
      - `id` string, required
      - `name` string
    - `accountRef` AccountRef
      - `id` string, required
      - `name` string
    - `totalAmount` number, float, required
    - `currencyRef` CurrencyRef
      - `id` string, required
      - `name` string
      - `symbol` string
    - `currencyRate` number, float
    - `date` string, date-time, required
    - `memo` string
    - `lines` BillPaymentLineItem[]
      - `amount` number, float, required
      - `link` BillPaymentLink
        - `type` 'bill' | 'billPayment' | 'paymentOnAccount' | 'creditNote' | 'refund' | 'other', required
        - `id` string
        - `amount` number, float
      - `links` BillPLinks[]
        - `type` 'bill' | 'billPayment' | 'paymentOnAccount' | 'creditNote' | 'refund' | 'other', required
        - `id` string, required
      - `allocatedOnDate` string, date-time
    - `subsidiaryRefs` SubsidiaryRef[]
      - `id` string
      - `name` string
    - `sourceModifiedDate` string, date-time

## Other responses

- `202`: Data in pending state
- `204`: No data available
- `400`: Bad Request Error - Thrown if fields sent via query does not follow specifications
- `401`: Unauthorized - Not logged in or log in expired
- `403`: Forbidden - Not enough permission
- `500`: Server Error

## Changes

- **2026-09-03** `1383b9a47ac9`: 1 info
  - api tag `Bill` added
- **2026-08-10** `5cdfae3fa1fa`: 10 breaking, 30 warning, 8 info
  - removed the enum value `plaid` from the `query` request parameter `serviceName`
  - removed the enum value `shopify` from the `query` request parameter `serviceName`
  - removed the enum value `square` from the `query` request parameter `serviceName`
  - removed the enum value `wave` from the `query` request parameter `serviceName`
  - …44 more

[Operation history](https://skmtc.dev/railz/apis/fis-accounting-data-as-a-service-api/changes/bills/payments/get.md)

---

[API](https://skmtc.dev/railz/apis/fis-accounting-data-as-a-service-api.md) - [All operations](https://skmtc.dev/railz/apis/fis-accounting-data-as-a-service-api/llms.txt) - [OpenAPI document](https://skmtc.dev/railz/apis/fis-accounting-data-as-a-service-api/revisions/1383b9a47ac9?raw)
