Get an invoice

curl --request GET \
  --url https://www.ruddr.io/api/workspace/invoices/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "56deca22-a707-4148-a5f7-ea3ae6391d67",
  "companyName": "Ruddr Inc.",
  "companyStreetAddress": "123 Main St, Suite 200",
  "number": "INV-001",
  "statusId": "paid",
  "billTo": "Acme Corp",
  "invoiceFor": "Website Redesign - January 2025",
  "issuedOn": "2025-01-15",
  "servicesThrough": "2025-01-31",
  "dueOn": "2025-02-14",
  "poNumber": "PO-84657",
  "notes": "Payment due within 30 days.",
  "emailSubject": "Invoice INV-001 from Ruddr Inc.",
  "emails": [
    "billing@acmecorp.com"
  ],
  "ccEmails": [
    "finance@acmecorp.com"
  ],
  "emailBody": "Please find your invoice attached.",
  "emailFromName": "Ruddr Billing",
  "replyTo": "billing@ruddr.io",
  "sendBcc": true,
  "sentOn": "2025-01-15",
  "currency": "USD",
  "subtotal": 50000,
  "totalDiscount": 2500,
  "taxRate": 0.05,
  "totalTax": 2375,
  "total": 49875,
  "amountPaid": 49875,
  "amountCredited": 500,
  "amountDue": 0,
  "createdAt": "2025-01-15T20:47:03.284Z",
  "client": {
    "id": "7c8f2e19-4d5a-4a3b-9c6d-2e8f1a0b3c4d",
    "name": "Acme Corp"
  },
  "projects": [
    {
      "id": "b4cc2b99-3b3a-4b73-8f4e-8c1d7a94e5b0",
      "name": "Website Redesign"
    }
  ],
  "lines": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "lineNumber": 1,
      "item": "Design Services",
      "description": "Homepage and landing page design",
      "quantity": 40,
      "rate": 150,
      "amount": 6000,
      "taxable": true,
      "project": {
        "id": "b4cc2b99-3b3a-4b73-8f4e-8c1d7a94e5b0",
        "name": "Website Redesign"
      },
      "invoiceItem": {
        "id": "d4e5f6a7-b8c9-0123-4567-89abcdef0123",
        "name": "Design Services"
      }
    }
  ],
  "paymentTerm": {
    "id": "3a2b1c0d-4e5f-6789-0abc-def123456789",
    "name": "Net 30",
    "type": "net",
    "days": 30
  },
  "payments": [
    {
      "id": "e5f6a7b8-c9d0-1234-5678-9abcdef01234",
      "referenceNumber": "CHK-1234",
      "amount": 49875
    }
  ],
  "creditNotes": [
    {
      "id": "f6a7b8c9-d0e1-2345-6789-abcdef012345",
      "number": "CN-001",
      "amount": 500
    }
  ]
}

GET

invoices

{id}

Get an invoice

curl --request GET \
  --url https://www.ruddr.io/api/workspace/invoices/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "56deca22-a707-4148-a5f7-ea3ae6391d67",
  "companyName": "Ruddr Inc.",
  "companyStreetAddress": "123 Main St, Suite 200",
  "number": "INV-001",
  "statusId": "paid",
  "billTo": "Acme Corp",
  "invoiceFor": "Website Redesign - January 2025",
  "issuedOn": "2025-01-15",
  "servicesThrough": "2025-01-31",
  "dueOn": "2025-02-14",
  "poNumber": "PO-84657",
  "notes": "Payment due within 30 days.",
  "emailSubject": "Invoice INV-001 from Ruddr Inc.",
  "emails": [
    "billing@acmecorp.com"
  ],
  "ccEmails": [
    "finance@acmecorp.com"
  ],
  "emailBody": "Please find your invoice attached.",
  "emailFromName": "Ruddr Billing",
  "replyTo": "billing@ruddr.io",
  "sendBcc": true,
  "sentOn": "2025-01-15",
  "currency": "USD",
  "subtotal": 50000,
  "totalDiscount": 2500,
  "taxRate": 0.05,
  "totalTax": 2375,
  "total": 49875,
  "amountPaid": 49875,
  "amountCredited": 500,
  "amountDue": 0,
  "createdAt": "2025-01-15T20:47:03.284Z",
  "client": {
    "id": "7c8f2e19-4d5a-4a3b-9c6d-2e8f1a0b3c4d",
    "name": "Acme Corp"
  },
  "projects": [
    {
      "id": "b4cc2b99-3b3a-4b73-8f4e-8c1d7a94e5b0",
      "name": "Website Redesign"
    }
  ],
  "lines": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "lineNumber": 1,
      "item": "Design Services",
      "description": "Homepage and landing page design",
      "quantity": 40,
      "rate": 150,
      "amount": 6000,
      "taxable": true,
      "project": {
        "id": "b4cc2b99-3b3a-4b73-8f4e-8c1d7a94e5b0",
        "name": "Website Redesign"
      },
      "invoiceItem": {
        "id": "d4e5f6a7-b8c9-0123-4567-89abcdef0123",
        "name": "Design Services"
      }
    }
  ],
  "paymentTerm": {
    "id": "3a2b1c0d-4e5f-6789-0abc-def123456789",
    "name": "Net 30",
    "type": "net",
    "days": 30
  },
  "payments": [
    {
      "id": "e5f6a7b8-c9d0-1234-5678-9abcdef01234",
      "referenceNumber": "CHK-1234",
      "amount": 49875
    }
  ],
  "creditNotes": [
    {
      "id": "f6a7b8c9-d0e1-2345-6789-abcdef012345",
      "number": "CN-001",
      "amount": 500
    }
  ]
}

A document sent to request payment for goods or services.

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

The invoice uuid

Response

200

string

The unique identifier for the object.

companyName

string | null

The company name displayed on the invoice.

companyStreetAddress

string | null

The company street address displayed on the invoice.

number

string

The invoice number.

statusId

enum<string>

The current status of the invoice.

Available options:

draft,

open,

sent,

viewed,

partially_paid,

paid,

overdue,

void,

write_off

billTo

string | null

The bill-to text displayed on the invoice.

invoiceFor

string | null

A description of the products or services being invoiced.

issuedOn

string<date> | null

The date the invoice was issued (YYYY-MM-DD).

servicesThrough

string<date> | null

The services-through date (YYYY-MM-DD).

dueOn

string<date> | null

The date the invoice is due (YYYY-MM-DD).

poNumber

string | null

The purchase order number.

notes

string | null

Notes displayed on the invoice.

emailSubject

string | null

The email subject used when sending the invoice.

emails

string[]

The email addresses the invoice is sent to.

ccEmails

string[]

The CC email addresses when sending the invoice.

emailBody

string | null

The email body used when sending the invoice.

emailFromName

string | null

The from name used when sending the invoice.

replyTo

string | null

The reply-to email address used when sending the invoice.

sendBcc

boolean

Whether to send a BCC copy when the invoice is sent.

sentOn

string<date> | null

The date the invoice was sent (YYYY-MM-DD).

currency

string

The 3-letter currency code for the invoice.

subtotal

number

The subtotal of all line items before discounts and taxes.

totalDiscount

number | null

The total discount amount applied to the invoice.

taxRate

number

The tax rate as a decimal (e.g., 0.05 for 5%).

totalTax

number

The total tax amount on the invoice.

total

number

The total amount of the invoice including tax.

amountPaid

number

The total amount paid on the invoice.

amountCredited

number

The total amount credited on the invoice.

amountDue

number

The remaining balance due on the invoice.

createdAt

string<date-time>

The timestamp when the object was created.

client

object

The client associated with this invoice.

Show child attributes

projects

object[]

The projects associated with this invoice.

Show child attributes

lines

object[]

The line items on the invoice.

Show child attributes

paymentTerm

object

The payment term for the invoice.

Show child attributes

payments

object[]

Payments applied to this invoice.

Show child attributes

creditNotes

object[]

Credit notes applied to this invoice.

Show child attributes

List invoices List credit notes

⌘I

Projects

Time

Pipeline

Expenses

Resourcing

Billing

Workspace

Members

Custom Data

Get an invoice

Authorizations

Path Parameters

Response