Get the invoices
GET
/invoices
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api-sandbox.saaslogic.io/v1/invoices?customerId=b2f3e6a4-5678-4b9c-9876-6f8a8b3d4567&productId=e1b1f2a3-5678-4d9c-9876-5f8a8b3d4568&startDate=2023-06-01&endDate=2023-07-21' \
--header 'Authorization;' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Response Response Example
200 - Invoices retrieved successfully
[
{
"invoiceId": "a5e1343d-bf22-4bf9-b4e1-914f39bdbc16",
"invoiceNumber": "INV-2023-001",
"clientId": "b2f3e6a4-5678-4b9c-9876-6f8a8b3d4567",
"productId": "e1b1f2a3-5678-4d9c-9876-5f8a8b3d4568",
"subscriptionRefId": "c1d2e3f4-5678-4g9c-9876-4f8a8b3d4569",
"productName": "Konnectware",
"planName": "Gold",
"invoiceDate": "2023-06-15T12:00:00",
"dueDate": "2023-07-15T12:00:00",
"netAmount": 1500,
"amountReceived": 1500,
"totalTaxAmount": 150,
"totalDiscountAmount": 100,
"statusName": "Paid",
"currencySymbol": "$",
"billingCycleStartDate": "2023-06-01T00:00:00",
"billingCycleEndDate": "2023-06-30T23:59:59",
"billingFromDate": "2023-06-01T00:00:00",
"billingToDate": "2023-06-30T23:59:59"
},
{
"invoiceId": "a5e1343d-bf22-4bf9-b4e1-914f39bdbc16",
"invoiceNumber": "INV-2023-001",
"clientId": "b2f3e6a4-5678-4b9c-9876-6f8a8b3d4567",
"productId": "e1b1f2a3-5678-4d9c-9876-5f8a8b3d4568",
"subscriptionRefId": "c1d2e3f4-5678-4g9c-9876-4f8a8b3d4569",
"productName": "Konnectware",
"planName": "Gold",
"invoiceDate": "2023-06-15T12:00:00",
"dueDate": "2023-07-15T12:00:00",
"netAmount": 1500,
"amountReceived": 1500,
"totalTaxAmount": 150,
"totalDiscountAmount": 100,
"statusName": "Paid",
"currencySymbol": "$",
"billingCycleStartDate": "2023-06-01T00:00:00",
"billingCycleEndDate": "2023-06-30T23:59:59",
"billingFromDate": "2023-06-01T00:00:00",
"billingToDate": "2023-06-30T23:59:59"
}
]
Request
Query Params
customerId
string
required
Example:
b2f3e6a4-5678-4b9c-9876-6f8a8b3d4567
productId
string
required
Example:
e1b1f2a3-5678-4d9c-9876-5f8a8b3d4568
startDate
string
required
Example:
2023-06-01
endDate
string
required
Example:
2023-07-21
Header Params
Authorization
string
required
Default:
Bearer {{bearerToken}}
Content-Type
string
optional
Default:
application/json
Accept
string
optional
Default:
application/json