Invoice List Api

curl --request GET \
  --url https://api.justpaid.io/api/v1/invoice/ \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "invoice_status": "draft",
      "amount": 1000,
      "currency": "USD",
      "invoice_number": "INV-2024-001",
      "invoice_date": "2024-03-21",
      "due_date": "2024-04-21",
      "service_start_date": "2024-03-01",
      "service_end_date": "2024-03-31",
      "description": "Monthly services for March 2024",
      "created_at": "2024-03-21T10:00:00Z",
      "is_recurring": false,
      "from_external_source": false,
      "external_source": "stripe",
      "external_source_id": "inv_123456",
      "payment_link": "https://app.justpaid.ai/portal/inv/123",
      "line_items": [
        {
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "unit_price": 123,
          "quantity": 123,
          "amount": 123,
          "currency": "<string>",
          "description": "<string>",
          "flat_fee": 123,
          "tax_rate": 123,
          "tax_amount": 123,
          "tax_name": "<string>",
          "discount_amount": 123,
          "discount_percent": 123,
          "service_start_date": "2023-12-25",
          "service_end_date": "2023-12-25",
          "display_order": 123
        }
      ],
      "file_url": "https://api.justpaid.ai/invoices/123.pdf",
      "customer": {
        "external_id": "CUST-001",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "contact_name": "<string>",
        "email": "<string>",
        "additional_emails": [
          "<unknown>"
        ],
        "billing_emails": [
          "<unknown>"
        ],
        "phone_number": "<string>",
        "currency": "<string>",
        "tax_id": "<string>"
      }
    }
  ],
  "count": 123
}

GET

api

invoice

Invoice List Api

curl --request GET \
  --url https://api.justpaid.io/api/v1/invoice/ \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "invoice_status": "draft",
      "amount": 1000,
      "currency": "USD",
      "invoice_number": "INV-2024-001",
      "invoice_date": "2024-03-21",
      "due_date": "2024-04-21",
      "service_start_date": "2024-03-01",
      "service_end_date": "2024-03-31",
      "description": "Monthly services for March 2024",
      "created_at": "2024-03-21T10:00:00Z",
      "is_recurring": false,
      "from_external_source": false,
      "external_source": "stripe",
      "external_source_id": "inv_123456",
      "payment_link": "https://app.justpaid.ai/portal/inv/123",
      "line_items": [
        {
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "unit_price": 123,
          "quantity": 123,
          "amount": 123,
          "currency": "<string>",
          "description": "<string>",
          "flat_fee": 123,
          "tax_rate": 123,
          "tax_amount": 123,
          "tax_name": "<string>",
          "discount_amount": 123,
          "discount_percent": 123,
          "service_start_date": "2023-12-25",
          "service_end_date": "2023-12-25",
          "display_order": 123
        }
      ],
      "file_url": "https://api.justpaid.ai/invoices/123.pdf",
      "customer": {
        "external_id": "CUST-001",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "contact_name": "<string>",
        "email": "<string>",
        "additional_emails": [
          "<unknown>"
        ],
        "billing_emails": [
          "<unknown>"
        ],
        "phone_number": "<string>",
        "currency": "<string>",
        "tax_id": "<string>"
      }
    }
  ],
  "count": 123
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

invoice_status

string

Filter by invoice status (e.g., 'draft', 'sent', 'paid')

customer

string

Filter by customer UUID

invoice_date_gte

string<date>

Filter invoices with invoice date greater than or equal to this date

invoice_date_lte

string<date>

Filter invoices with invoice date less than or equal to this date

due_date_gte

string<date>

Filter invoices with due date greater than or equal to this date

due_date_lte

string<date>

Filter invoices with due date less than or equal to this date

amount_gte

number

Filter invoices with amount greater than or equal to this value

amount_lte

number

Filter invoices with amount less than or equal to this value

limit

integer

Number of results to return per page

offset

integer

Number of results to skip

Response

200 - application/json

List of invoices retrieved successfully

items

InvoiceOut2 · object[]

required

Show child attributes

items.uuid

string<uuid>

The unique identifier for the invoice

Example:

"123e4567-e89b-12d3-a456-426614174000"

items.invoice_status

string

The current status of the invoice

Example:

"draft"

items.amount

number

The total amount due for the invoice

Example:

1000

items.currency

string

The currency code for the invoice

Example:

"USD"

items.invoice_number

string

The unique invoice number

Example:

"INV-2024-001"

items.invoice_date

string<date>

The date when the invoice was created

Example:

"2024-03-21"

items.due_date

string<date> | null

The date by which the invoice must be paid

Example:

"2024-04-21"

items.service_start_date

string<date> | null

The start date of the service period

Example:

"2024-03-01"

items.service_end_date

string<date> | null

The end date of the service period

Example:

"2024-03-31"

items.description

string | null

A description of the invoice

Example:

"Monthly services for March 2024"

items.created_at

string<date-time>

The timestamp when the invoice was created

Example:

"2024-03-21T10:00:00Z"

items.is_recurring

boolean

Indicates if this is a recurring invoice

Example:

false

items.from_external_source

boolean

Indicates if the invoice was created from an external source

Example:

false

items.external_source

string | null

The name of the external source if applicable

Example:

"stripe"

items.external_source_id

string | null

The ID of the invoice in the external system

Example:

"inv_123456"

items.payment_link

string | null

URL where the customer can pay this invoice

Example:

"https://app.justpaid.ai/portal/inv/123"

items.line_items

InvoiceLineItemOut2 · object[]

List of line items included in this invoice

Show child attributes

items.line_items.uuid

string<uuid>

items.line_items.name

string | null

Maximum string length: 255

items.line_items.unit_price

number | null

items.line_items.quantity

integer | null

items.line_items.amount

number | null

items.line_items.currency

string | null

Maximum string length: 3

items.line_items.description

string | null

The description of the line item

items.line_items.flat_fee

number | null

Fixed flat fee added to the line item amount

items.line_items.tax_rate

number | null

items.line_items.tax_amount

number | null

items.line_items.tax_name

string | null

Maximum string length: 255

items.line_items.discount_amount

number | null

items.line_items.discount_percent

number | null

items.line_items.service_start_date

string<date> | null

The date the service starts for the item

items.line_items.service_end_date

string<date> | null

The date the service ends for the item

items.line_items.display_order

integer | null

The order in which the line item will be displayed in the UI/pdf

items.file_url

string | null

URL to download the invoice PDF

Example:

"https://api.justpaid.ai/invoices/123.pdf"

items.customer

CustomerOut2 · object

Details of the customer associated with this invoice

Show child attributes

items.customer.external_id

string | null

An optional external identifier for the customer. This can be used to link the customer to an external system.

Example:

"CUST-001"

items.customer.uuid

string<uuid>

items.customer.name

string | null

Customer name

Maximum string length: 100

items.customer.contact_name

string | null

The name of the contact person

Maximum string length: 100

items.customer.email

string | null

Maximum string length: 100

items.customer.additional_emails

any[] | null

A list of additional customer email addresses

items.customer.billing_emails

any[] | null

Billing email addresses

items.customer.phone_number

string | null

Customer phone number with country code

Maximum string length: 20

items.customer.currency

string | null

Maximum string length: 3

items.customer.tax_id

string | null

Customer tax id

Maximum string length: 25

count

integer

required

Customer Payment Methods Get Api Invoice Get Api

⌘I

API Documentation

Authorizations

Query Parameters

Response