v4

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-0684241293.2 KB
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

AccountsReceivableInvoiceIdstring uuid

Id for an Accounts Receivable transaction

EventRefNointeger

Id for an Events/Groups transaction

TransactionIdinteger
StatusFilterUrlToPayStatus[]

A status filter list that allows for searching across different combinations of status'. i.e. setting the list to only include Pending will result in returned results only being in pending status

Note: If the status filter is null/empty, it will be treated as if ALL status' are included.

skipinteger
takeinteger

Response

Success

gratuityAmountnumber double nullable
idstring uuid
netAmountnumber double
urlToPayUristring uri nullable
taxAmountnumber double
invoiceCreationTimestring date-time