Get refund details for an invoice

Retrieves refund details for the invoice specified by the invoice_id URL parameter.

Request
Security:
tilia_auth (read_refunds)
path Parameters
invoice_id
required
string <UUID4 or TUID>

The Invoice ID

Example: 5d5cea6c-2745-4453-b5ea-fb6df0424be7
query Parameters
status
string
Default: "REFUND-SUCCESS"

Filter refunds by refund status

Enum: "REFUND-SUCCESS" "REFUND-FAILED" "REFUND-REJECTED"
Responses
200

Successfully retrieved refunds for invoice.

400

Invalid input

401

Unauthorized access.

500

Service unavailable or server error.

get/v2/invoice/{invoice_id}/refunds
Request samples
curl -i -X GET \
  'https://invoicing.tilia-inc.com/v2/invoice/:invoice_id/refunds?status=REFUND-SUCCESS' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "invoice_id": "5d5cea6c-2745-4453-b5ea-fb6df0424be7",
  • "is_fully_refunded": false,
  • "payments": {
    },
  • "refunds": {
    },
  • "line_item_refunds": {
    }
}