Get Invoice

Retrieve invoice details by unique identifier.

GET /v1/invoices/{id}

cURL

cURL

curl --request GET \
  --url https://api.nomod.com/v1/invoices/{id} \
  --header 'X-API-KEY: <api-key>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reference_id": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "title": "<string>",
  "code": "<string>",
  "url": "<string>",
  "amount": "<string>",
  "currency": "<string>",
  "status": "paid",
  "discount": "<string>",
  "tax": "<string>",
  "shipping_address_required": true,
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": "<string>",
      "total_amount": "<string>",
      "name": "<string>",
      "quantity": 2147483647,
      "sku": "<string>"
    }
  ],
  "note": "<string>",
  "expiry": "2023-11-07T05:31:56Z",
  "user": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "first_name": "<string>",
    "last_name": "<string>"
  },
  "tip": "<string>",
  "invoice_number": "<string>",
  "service_date": "2023-11-07T05:31:56Z",
  "due_date": "2023-11-07T05:31:56Z",
  "interval_count": 123,
  "starts_at": "2023-11-07T05:31:56Z",
  "ends_at": "2023-11-07T05:31:56Z",
  "due_days": 123,
  "source": "nomod_hosted",
  "files": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "content_type": "<string>",
      "file": "<string>"
    }
  ],
  "reminders": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "days": 123,
      "title": "<string>",
      "invoice": 123,
      "run_at": "2023-11-07T05:31:56Z"
    }
  ],
  "events": [
    {
      "created": "2023-11-07T05:31:56Z",
      "type": "created",
      "message": "<string>",
      "user": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "first_name": "<string>",
        "last_name": "<string>"
      }
    }
  ],
  "customer": {},
  "service_fee": "<string>",
  "discount_percentage": "<string>",
  "service_fee_percentage": "<string>",
  "tip_percentage": "<string>",
  "custom_fields": [],
  "success_url": "<string>",
  "failure_url": "<string>",
  "payment_capture_source": "<string>"
}

Authorizations

X-API-KEY · string · header · required

Your API key. This is required by all endpoints to access our API programatically. You can view your API Key by navigating to the app settings

Path Parameters

id · string<uuid> · required

Response

200

application/json

id · string<uuid> · required · read-only

reference_id · string · required · read-only

created · string<date-time> · required · read-only

title · string · required · read-only

code · string · required · read-only

url · string<uri> · required · read-only

URL of the link or invoice,

amount · string<decimal> · required · read-only

Pattern: ^-?\d{0,10}(?:\.\d{0,3})?$

currency · string · required

status · enum<string> · required

• paid - paid
• unpaid - unpaid
• overdue - overdue
• cancelled - cancelled
• scheduled - scheduled

Available options: paid, unpaid, overdue, cancelled, scheduled

discount · string<decimal> · required · read-only

Pattern: ^-?\d{0,10}(?:\.\d{0,3})?$

tax · string<decimal> · required · read-only

Pattern: ^-?\d{0,10}(?:\.\d{0,3})?$

shipping_address_required · boolean · required · read-only

items · object[] · required · read-only

Show child attributes

note · string · required · read-only

expiry · string<date-time> · required · read-only

user · object · required

Show child attributes

tip · string<decimal> · required · read-only

Pattern: ^-?\d{0,10}(?:\.\d{0,3})?$

invoice_number · string · required · read-only

service_date · string<date-time> · required · read-only

due_date · string<date-time> · required · read-only

interval_count · integer · required · read-only

starts_at · string<date-time> · required · read-only

ends_at · string<date-time> · required · read-only

due_days · integer · required · read-only

source · enum<string> · required

• nomod_hosted - Nomod Hosted
• woocommerce - WooCommerce
• shopify - Shopify
• zapier - Zapier
• nomod_api - API
• store - Store
• app - App
• web - Web

Available options: nomod_hosted, woocommerce, shopify, zapier, nomod_api, store, app, web

files · object[] · required · read-only

Show child attributes

reminders · object[] · required · read-only

Show child attributes

events · object[] · required

Show child attributes

customer · object · required · read-only

Show child attributes

service_fee · string<decimal> | null

Pattern: ^-?\d{0,10}(?:\.\d{0,3})?$

discount_percentage · string<decimal> | null

Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$

service_fee_percentage · string<decimal> | null

Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$

tip_percentage · string<decimal> | null

Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$

custom_fields · object[]

Show child attributes

success_url · string<uri>

Redirects to the success URL after the invoice is completed.

failure_url · string<uri>

Redirects to the failure URL if the invoice payment fails.

payment_capture_source · string