Get the invoice details .

GET

/invoices/{invoiceId}

Get the invoice details by its ref Id

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 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

Header Params

Responses

🟢200Invoice retrieved successfully

application/json

Body

🔴500ErrorResponse

Mark the invoice payment status

cancel the invoices