Saaslogic
  1. subscriptions
Saaslogic
  • Introduction
  • Authentication
  • Enum Reference
  • Authentication
    • saaslogic token
      • Get the saaslogic access token
    • login Url
      • Gives the login URL
    • logout Url
      • Gives the logout URL
  • Countries
    • Get list of countries
  • Plans
    • List all plans for a product
  • Subscriptions
    • Create a product subscription
    • Retrieve a subscription
    • Create Customer and Subscription
    • Subscription with details permissions, menus and features
    • The Saaslogic URL for creating subscription
  • Usage Reporting
    • Report the resource usages in subscription for invoicing
    • Retrieves the resource usages of a subscription in the current billing cycle
  • Customers
    • addresses
      • Create an address
      • List all addresses
      • Update an address
      • Retrieve an address
      • Delete an address
    • contacts
      • Create a contact
      • List all contacts
      • Update a contact
      • Retrieve a contact
      • Delete a contact
    • Create a customer
    • List all customers
    • Update a customer
    • Retrieve a customer
    • Delete a customer
  • Vendors
    • vendor addresses
      • Create a vendor address.
      • List all vendor addresses.
      • Update a vendor address.
      • Retrieve a vendor address..
      • Delete a vendor address.
    • vendor contacts
      • Create a vendor contact.
      • List all vendor contacts.
      • Update a vendor contact.
      • Retrieve a vendor contact.
      • Delete a vendor contact.
    • vendor bills
      • Create a vendor bill
      • Cancel a vendor bill.
    • vendor bills payout
      • Update payment details to vendor bills.
    • Create a vendor
    • Update a vendor.
    • Activate a vendor.
    • Dectivate a vendor.
  • Attributes
    • Create a organization attribute and set the value
    • Retrieve a organization attribute
    • Create a user attribute
    • Update a user attribute
    • Get a user attribute
  • Invoices
    • subscriptions
      • Get the invoices
        GET
      • Get the invoices by subscription
        GET
    • payments
      • Mark the invoice payment status
    • Get the invoice details .
      GET
    • cancel the invoices
      PUT
    • Send invoice as pdf with payment link.
      POST
    • Create an on-demand invoice
      POST
  1. subscriptions

Get the invoices

GET
/invoices
This endpoint retrieves invoices based on various scenarios:
Invoice by Merchant
Requires startDate and endDate.
Example URL: <baseurl>/invoices?startDate=2023-06-01&endDate=2023-07-21
Invoice by Customer
Invoice by Product and Customer
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
(Required) The unique identifier of the customer.
Example:
b2f3e6a4-5678-4b9c-9876-6f8a8b3d4567
productId
string 
required
The unique identifier of the product.
Example:
e1b1f2a3-5678-4d9c-9876-5f8a8b3d4568
startDate
string 
required
(Required) Start date for the invoice retrieval.
Example:
2023-06-01
endDate
string 
required
(Required) End date for the invoice retrieval.
Example:
2023-07-21
Header Params
Authorization
string 
required
Saaslogic authorization token
Default:
Bearer {{bearerToken}}
Content-Type
string 
optional
Default:
application/json
Accept
string 
optional
Default:
application/json

Responses

🟢200Invoices retrieved successfully
application/json
Body
array of:
invoiceId
string 
required
invoiceNumber
string 
required
clientId
string 
required
productId
string 
required
subscriptionRefId
string 
required
productName
string 
required
planName
string 
required
invoiceDate
string <yyyy-MM-ddTHH:mm:ss>
required
dueDate
string <yyyy-MM-ddTHH:mm:ss>
required
netAmount
number 
required
amountReceived
number 
required
totalTaxAmount
number 
required
totalDiscountAmount
number 
required
statusName
string 
required
currencySymbol
string 
required
billingCycleStartDate
string <yyyy-MM-ddTHH:mm:ss>
required
billingCycleEndDate
string <yyyy-MM-ddTHH:mm:ss>
required
billingFromDate
string <yyyy-MM-ddTHH:mm:ss>
required
billingToDate
string <yyyy-MM-ddTHH:mm:ss>
required
🔴500ErrorResponse
Previous
Get a user attribute
Next
Get the invoices by subscription
Built with