Saaslogic
  1. Invoices
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 the invoices by subscription
    • 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. Invoices

Get the invoice details .

GET
/invoices/{invoiceId}
Get the invoice details by its ref Id
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api-sandbox.saaslogic.io/v1/invoices/70e59c72-80f2-49e2-91ae-ded8a70d2f50' \
--header 'Authorization;' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Response Response Example
200 - Invoice retrieved successfully
{
  "invoiceId": "70e59c72-80f2-49e2-91ae-ded8a70d2f50",
  "customerId": "b572be78-3c06-48f8-a72e-c704a58aa150",
  "subscriptionId": "0043452e-4cd1-440d-9a3b-d8c3e0dc32d4",
  "invoiceNumber": "INV-0001",
  "invoiceDate": "2023-09-24T15:30:00Z",
  "ownerOrgName": "ACME Corp",
  "customerName": "John Doe",
  "serviceAddress": {
    "addressName": "Main Office",
    "address": "1234 Elm Street",
    "city": "Springfield",
    "zip": "62701",
    "countryCode": "US",
    "stateCode": "IL"
  },
  "billingAddress": {
    "addressName": "Main Office",
    "address": "1234 Elm Street",
    "city": "Springfield",
    "zip": "62701",
    "countryCode": "US",
    "stateCode": "IL"
  },
  "billingFromDate": "2023-09-01T00:00:00Z",
  "billingToDate": "2023-09-30T23:59:59Z",
  "dueDate": "2023-10-15T23:59:59Z",
  "currencyIsoCode": "USD",
  "currencySymbol": "$",
  "totalReceivedAmount": 150,
  "invoiceAmount": 200,
  "totalDiscount": 50,
  "totalTaxAmount": 10,
  "grossAmount": 200,
  "balanceAmount": 50,
  "customNote": "Thank you for your business!",
  "systemNote": "Generated succesfully.",
  "signature": "Authorized Signature",
  "payments": [
    {
      "paymentDate": "2023-10-01T10:00:00Z",
      "referenceNumber": "PAY-123456",
      "description": "Monthly subscription payment.",
      "amount": 150
    },
    {
      "paymentDate": "2023-10-01T10:00:00Z",
      "referenceNumber": "PAY-123456",
      "description": "Monthly subscription payment.",
      "amount": 150
    }
  ],
  "products": [
    {
      "productId": "f76dbae5-caca-44d3-aaec-35c45bd2221a",
      "lineItems": [
        {
          "categoryName": "Subscriptions",
          "groupName": "Monthly Subscription",
          "groupDescription": "Access to premium features",
          "description": "Premium software subscription for one month",
          "quantity": 1,
          "unitPrice": 200,
          "price": 200
        },
        {
          "categoryName": "Subscriptions",
          "groupName": "Monthly Subscription",
          "groupDescription": "Access to premium features",
          "description": "Premium software subscription for one month",
          "quantity": 1,
          "unitPrice": 200,
          "price": 200
        }
      ]
    },
    {
      "productId": "f76dbae5-caca-44d3-aaec-35c45bd2221a",
      "lineItems": [
        {
          "categoryName": "Subscriptions",
          "groupName": "Monthly Subscription",
          "groupDescription": "Access to premium features",
          "description": "Premium software subscription for one month",
          "quantity": 1,
          "unitPrice": 200,
          "price": 200
        },
        {
          "categoryName": "Subscriptions",
          "groupName": "Monthly Subscription",
          "groupDescription": "Access to premium features",
          "description": "Premium software subscription for one month",
          "quantity": 1,
          "unitPrice": 200,
          "price": 200
        }
      ]
    }
  ],
  "status": "Paid",
  "billingType": "Recurring",
  "invoiceAttributes": [
    {
      "attributeName": "shippingNumber",
      "attributeValue": "SH-34556"
    },
    {
      "attributeName": "shippingNumber",
      "attributeValue": "SH-34556"
    }
  ]
}

Request

Path Params
invoiceId
string 
required
(Required) The ID of the invoice.
Example:
70e59c72-80f2-49e2-91ae-ded8a70d2f50
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

🟢200Invoice retrieved successfully
application/json
Body
invoiceId
string 
read-onlyoptional
The ID of the invoice.
customerId
string 
optional
The ID of the customer associated with the invoice.
subscriptionId
string 
optional
The ID of the subscription linked to the invoice.
invoiceNumber
string 
optional
The invoice number allocated to the invoice.
invoiceDate
string <yyyy-MM-ddTHH:mm:ss>
optional
The date when the invoice was generated.
ownerOrgName
string 
optional
The name of the organization issuing the invoice.
customerName
string 
optional
The name of the customer receiving the invoice.
serviceAddress
object 
optional
The address where the service is provided.
addressName
string 
optional
A label for the address, such as 'Home' or 'Office'.
address
string 
optional
The full street address, including house number and street name.
city
string 
optional
The city where the service is provided.
zip
string 
optional
The postal or ZIP code of the service address.
countryCode
string 
optional
The country code (ISO 3166-1 alpha-2 format).
stateCode
string 
optional
The state or province code within the country.
billingAddress
object 
optional
The billing address associated with the invoice.
addressName
string 
optional
A label for the address, such as 'Billing' or 'Corporate'.
address
string 
optional
The full street address for billing.
city
string 
optional
The city for billing purposes.
zip
string 
optional
The postal or ZIP code of the billing address.
countryCode
string 
optional
The country code (ISO 3166-1 alpha-3 format).
stateCode
string 
optional
The state ISO code within the country.
billingFromDate
string <yyyy-MM-ddTHH:mm:ss>
optional
The start date of the billing period.
billingToDate
string <yyyy-MM-ddTHH:mm:ss>
optional
The end date of the billing period.
dueDate
string <yyyy-MM-ddTHH:mm:ss>
optional
The date when the invoice payment is due.
currencyIsoCode
string 
optional
The ISO code of the currency used for billing.
currencySymbol
string 
optional
The currency symbol (e.g., '$', '€').
totalReceivedAmount
number 
optional
The total amount received for this invoice.
invoiceAmount
number 
optional
The total amount of the invoice before discounts and taxes.
totalDiscount
number 
optional
The total discount applied to the invoice.
totalTaxAmount
number 
optional
The total tax amount applicable to the invoice.
grossAmount
number 
optional
The total gross amount, including taxes and discounts.
balanceAmount
number 
optional
The remaining balance to be paid on the invoice.
customNote
string 
optional
A custom note added to the invoice.
systemNote
string 
optional
System-generated notes regarding the invoice.
signature
string 
optional
A digital signature associated with the invoice.
payments
array[object (InvoicePayment) {4}] 
optional
A list of payments made towards this invoice.
paymentDate
string <yyyy-MM-ddTHH:mm:ss>
required
referenceNumber
string 
required
description
string 
required
amount
number 
required
products
array[object (InvoiceProduct) {2}] 
optional
A list of products associated with the invoice.
productId
string 
required
lineItems
array[object (InvoiceLineItemDTO) {7}] 
required
status
string 
optional
The current status of the invoice (e.g., 'Paid', 'Pending').
billingType
string 
optional
The type of billing for this invoice (e.g., 'Recurring', 'One-time').
invoiceAttributes
array[object (InvoiceAttributeDTO) {2}] 
optional
Additional attributes related to the invoice.
attributeName
string 
required
attributeValue
string 
required
🔴500ErrorResponse
Previous
Mark the invoice payment status
Next
cancel the invoices
Built with