---
title: "Gets the list of UrlToPay objects from the local Advantage database. This data may not be 100% consistent with what is in phoenix due to eventual consistency."
method: GET
path: "/api/v1/urltopay"
tags: ["UrlToPay"]
---

# Gets the list of UrlToPay objects from the local Advantage database. This data may not be 100% consistent with what is in phoenix due to eventual consistency.

`GET /api/v1/urltopay`

## Query parameters

- `AccountsReceivableInvoiceId` string, uuid
- `EventRefNo` integer
- `TransactionId` integer
- `StatusFilter` UrlToPayStatus[]
- `skip` integer
- `take` integer

## Response `200`

Success

- UrlToPaySummary[]
  - `gratuityAmount` number, double, nullable
  - `id` string, uuid
  - `netAmount` number, double
  - `urlToPayUri` string, uri, nullable
  - `taxAmount` number, double
  - `target` UrlToPayTarget
    - `type` 'UrlToPayAccountsReceivableTarget' | 'UrlToPayEventsTarget' | 'UrlToPayTransactionTarget', required
  - `invoiceCreationTime` string, date-time

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.dev/centeredge/apis/advantage-api.md) · [All operations](https://skmtc.dev/centeredge/apis/advantage-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/centeredge/advantage-api/revisions/00cc7dde429b/schema)