Get invoices by reference ID

Returns all invoices for the given reference ID

Request
Security:
tilia_auth (read_invoices)
path Parameters
reference_id
required
string <UUID4>

The reference ID of transactions to return

query Parameters
states
string

Comma separated states in which to filter the response. By default, the response has no state filter applied. For example, a value of states=FAILED,CANCELED will return only invoices in those two states.

Enum: "OPEN" "PROCESSING" "SUCCESS" "FAILED" "CANCELED"
invoice_types
string
Default: "user_purchase,user_purchase_virtual"

Comma separated list of transaction types to return.

Enum: "user_purchase" "user_purchase_virtual" "payout_escrow" "payout_execute" "payout_reverse" "refund_invoice" "refund_line_item_invoice" "refund_invoice_virtual" "refund_line_item_invoice_virtual" "user_purchase_escrow" "user_purchase_escrow_virtual" "user_purchase_commit_escrow" "user_purchase_commit_escrow_virtual" "user_purchase_refund_escrow" "user_purchase_refund_escrow_virtual" "deposit" "token_purchase" "token_convert" "balance_transfer"
limit
number
Default: 100

Maximum number of items to be retrieved

offset
number
Default: 0

Offset to query at

sort_field
string
Default: "updated"

The field to sort the items by

Enum: "created" "updated"
sort
string
Default: "desc"

Sort ascending or descending

Enum: "asc" "desc"
Responses
200

Successfully retrieved invoices.

401

Unauthorized access.

500

Service unavailable or server error.

get/v2/invoice/reference/{reference_id}
Request samples
curl -i -X GET \
  'https://invoicing.tilia-inc.com/v2/invoice/reference/:reference_id?states=OPEN&invoice_types=user_purchase&limit=100&offset=0&sort_field=created&sort=asc' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "status": "Success",
  • "message": null,
  • "codes": null,
  • "payload": {
    }
}