HEhedgespecialty
Payments

Read current invoices for a billing record

Changed on

Reads provider invoice facts for a billing record belonging to your brokerage. Use the program_id returned by GET /broker/payments. Read scope is enough. This request does not create, repair or send invoices, payment links or billing programs. Missing invoice facts remain null; provider failures return an error rather than an empty list. Advance invoices remain available through the billing link.

get/broker/payments/{program_id}/invoices

Request

  • Base URL
    https://api.hedgespecialty.com/api/v1
  • Auth
    OAuth 2
    Authorization code: https://api.hedgespecialty.com/api/v1/oauth/authorize
    Client credentials
    Token URL: https://api.hedgespecialty.com/api/v1/oauth/token

Path parameters

program_idstring uuid required

Response

Current provider invoices; an empty list means none were returned

idstring required
statusstring nullable
amount_centsinteger nullable

Invoice amount in cents; zero is a known amount

due_datestring nullable
paid_atstring nullable
invoice_urlstring nullable
invoice_numberstring nullable

Changes