---
title: "Retrieves a RepeatingInvoice resource."
method: GET
path: "/repeating_invoices/{id}"
tags: ["RepeatingInvoice"]
---

# Retrieves a RepeatingInvoice resource.

`GET /repeating_invoices/{id}`

Retrieves a RepeatingInvoice resource.

## Path parameters

- `id` string, required

## Response `200`

RepeatingInvoice resource

- RepeatingInvoice — Repeating invoice represents invoices that are automatically created at regular intervals
  - `id` string
  - `integration` string — The key of the integration source e.g. "quickbooks", or "xero"
  - `srcId` string — Unique identifier for each repeating invoice
  - `period` integer, nullable — Number of times the invoice is charged per unit
  - `unit` string, nullable — Interval unit defining how often the invoice is charged e.g. WEEKLY e.g. MONTHLY
  - `dueDate` string, nullable — Number of days defining when the invoice is scheduled to be charged
  - `dueDateType` string, nullable — The type of billing used together with due date e.g. "DAYSAFTERBILLDATE" e.g. "DAYSAFTERBILLMONTH" e.g. "OFCURRENTMONTH" e.g. "OFFOLLOWINGMONTH"
  - `startDate` string, nullable — date on which the recurring invoice starts
  - `nextScheduledDate` string, nullable — date at which next invoice is to be sent
  - `type` string, nullable — The type of invoice e.g. "ACCPAY" e.g. "ACCREC"
  - `reference` string, nullable — Order number of recurring invoice
  - `hasAttachments` boolean, nullable — Whether the invoice has attachments or not
  - `contactId` string, nullable — Id of customer for whom recurring invoice is raised
  - `contactName` string, nullable — Full name of contact
  - `status` string, nullable — Status of the repeating invoice e.g. "DRAFT" e.g. "AUTHORISED"
  - `lineAmountTypes` string, nullable — Whether the line amount includes, excludes or doesn't have tax.
  - `lineItemDescription` string, nullable — A description of the line item
  - `lineItemUnitAmount` integer, nullable — The unit amount of the line item
  - `lineItemTaxType` string, nullable — The type of tax applied to line items e.g. "OUTPUT" e.g. "INPUT" e.g. "CAPEXINPUT"
  - `lineAmount` integer, nullable — The final amount for the line items
  - `lineItemAccountCode` string, nullable — Account code for the line item
  - `lineItemQuantity` integer, nullable — The quantity of the line items
  - `lineItemId` string, nullable — Unique ID for the line item
  - `subTotal` integer, nullable — Total of invoice excluding taxes
  - `totalTax` integer, nullable — Total tax on invoice
  - `total` integer — Total of invoice tax inclusive
  - `currencyCode` string, nullable — currency of invoice
  - `recurrenceName` string, nullable — Unique name for the recurring profile given by the user
  - `endDate` string, nullable — date on which the recurring invoice expires
  - `lastSentDate` string, nullable — date at which the last invoice was sent
  - `paidInvoicesTotal` integer, nullable — total amount paid to date
  - `unpaidInvoicesBalance` integer, nullable — total amount left to be paid
  - `discount` integer, nullable
  - `billingStreet` string, nullable
  - `billingStreet2` string, nullable
  - `billingCity` string, nullable
  - `billingState` string, nullable
  - `billingPostalCode` string, nullable
  - `billingCountry` string, nullable
  - `created` string, date-time, nullable
  - `modified` string, date-time, nullable

## Other responses

- `404` — Resource not found

---

[API](https://skmtc.net/bossinsights/apis/boss-insights.md) · [All operations](https://skmtc.net/bossinsights/apis/boss-insights/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bossinsights/boss-insights/versions/d08a107895ad/schema)