riverty logo

Docs

Path

GET /v1/clients/{clientId}/partner-subscriptions/{subscriptionId}/invoices/{invoiceNumber}

Request Parameters

clientId required
integer
Your assigned `ClientId`.
subscriptionId required
string
Id of the subscription.
invoiceNumber required
string
Number of the invoice.

Responses

Successful Request

Response Example

    
        {
 "invoiceNumber": "PF100001",
 "invoiceDate": "2023-08-09T12:00:00Z",
 "dueDate": "2023-08-23T12:00:00Z",
 "createdAt": "2023-08-09T08:00:00Z",
 "status": "Reminder",
 "balance": 15,
 "total": {
  "grossAmount": 100,
  "netAmount": 85,
  "currencyCode": "EUR"
 },
 "ocr": "123456789",
 "invoiceLines": [
  {
   "productId": "P123",
   "description": "Product A",
   "imageUrl": "https://example.com/product_a.jpg",
   "grossAmount": 50,
   "vatPercentage": 20,
   "unit": {
    "netPrice": 40,
    "quantity": 2,
    "code": "EUR"
   },
   "metadata": [
    {
     "key": "Color",
     "value": "Blue"
    }
   ]
  },
  {
   "productId": "P124",
   "description": "Product B",
   "imageUrl": "https://example.com/product_b.jpg",
   "grossAmount": 50,
   "vatPercentage": 20,
   "unit": {
    "netPrice": 25,
    "quantity": 2,
    "code": "EUR"
   }
  }
 ],
 "metadata": [
  {
   "key": "Company",
   "value": "ABC Inc."
  },
  {
   "key": "Location",
   "value": "New York"
  }
 ],
 "_links": [
  {
   "method": "GET",
   "href": "https://consumer.riverty.io/p/apgD/24pOlNDL7zKrKzjzF5ba",
   "rel": "manage-payments",
   "target": "BROWSER"
  }
 ]
}
    

Request Example

    
        null