Skip to main content
GET
/
invoices
/
{invoiceId}
/
payment-status
Get invoice payment status
curl --request GET \
  --url https://connect.withvayu.com/invoices/{invoiceId}/payment-status \
  --header 'Authorization: Bearer <token>'
{
  "invoiceId": "<string>",
  "billingStatus": "None",
  "amountDue": 123,
  "amountPaid": 123,
  "total": 123,
  "dueDate": "2023-11-07T05:31:56Z",
  "paidAt": "2023-11-07T05:31:56Z",
  "invoicePdfUrl": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
invoiceId
string
required
Pattern: ^[0-9a-fA-F]{24}$

Response

Invoice payment status information including payment status, amounts, and dates.

​
invoiceId
string
required
Pattern: ^[0-9a-fA-F]{24}$
​
billingStatus
enum<string>
required

The billing status of the invoice

Available options:
None,
Paid,
Rejected,
PendingPayment,
Overdue
​
amountDue
number
required
​
amountPaid
number
required
​
total
number
required
​
dueDate
string<date-time>
​
paidAt
string<date-time>
​
invoicePdfUrl
string