Invoices

Get an invoice

get/invoices/{id}

Request

  • Base URL: https://www.ruddr.io/api/workspace
  • URL: https://www.ruddr.io/api/workspace/invoices/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The invoice uuid

Response

200

idstring

The unique identifier for the object.

companyNamestring nullable

The company name displayed on the invoice.

companyStreetAddressstring nullable

The company street address displayed on the invoice.

numberstring

The invoice number.

statusId'draft' | 'open' | 'sent' | 'viewed' | 'partially_paid' | 'paid' | 'overdue' | 'void' | 'write_off'

The current status of the invoice.

billTostring nullable

The bill-to text displayed on the invoice.

invoiceForstring nullable

A description of the products or services being invoiced.

issuedOnstring date nullable

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

servicesThroughstring date nullable

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

dueOnstring date nullable

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

poNumberstring nullable

The purchase order number.

notesstring nullable

Notes displayed on the invoice.

emailSubjectstring nullable

The email subject used when sending the invoice.

emailsstring[]

The email addresses the invoice is sent to.

ccEmailsstring[]

The CC email addresses when sending the invoice.

emailBodystring nullable

The email body used when sending the invoice.

emailFromNamestring nullable

The from name used when sending the invoice.

replyTostring nullable

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

sendBccboolean

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

sentOnstring date nullable

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

currencystring

The 3-letter currency code for the invoice.

subtotalnumber

The subtotal of all line items before discounts and taxes.

totalDiscountnumber nullable

The total discount amount applied to the invoice.

taxRatenumber

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

totalTaxnumber

The total tax amount on the invoice.

totalnumber

The total amount of the invoice including tax.

amountPaidnumber

The total amount paid on the invoice.

amountCreditednumber

The total amount credited on the invoice.

amountDuenumber

The remaining balance due on the invoice.

createdAtstring date-time

The timestamp when the object was created.

modifiedAtstring date-time

The timestamp when the object was last modified.

Changes

No recorded changes to this operation across all 1 revision of this API.