Skip to content

Skip recurring invoice

POST
/rest/billing/recurring-invoices/skip
curl --request POST \
--url https://api.shypr.app/rest/billing/recurring-invoices/skip \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <X-API-KEY>' \
--data '{ "iri": "example", "date": "2026-04-15T12:00:00Z" }'

Creates a RecurringInvoice resource.

The new RecurringInvoice resource

An invoice that the system makes each period for a customer, without a sales order. The cron job RecurringInvoicesRun sends a RunRecurringInvoice for each one that is due. It is never deleted, only archived (the generic archive and publish endpoints), and an archived one makes no invoices.

object
iri
required
string
date
required
string format: date-time

Example generated

{
"iri": "example",
"date": "2026-04-15T12:00:00Z"
}

RecurringInvoice resource created

An invoice that the system makes each period for a customer, without a sales order. The cron job RecurringInvoicesRun sends a RunRecurringInvoice for each one that is due. It is never deleted, only archived (the generic archive and publish endpoints), and an archived one makes no invoices.

object
startDate

The first run. Each later run counts from this date, see RecurringPeriodType::occurrence().

string format: date-time
endDate

The last day that can get an invoice. Null: no end.

string | null format: date-time
nextRunAt

The date of the next invoice. Null when the status is ended.

string | null format: date-time
lastRunAt

The schedule is done up to this date: the day of the last run, or the date of the schedule that it invoiced when that is later. The next run is always after it.

string | null format: date-time
skippedDates

The dates (Y-m-d) of the schedule that get no invoice.

Array<string>
name

The name that the user gives it, to find it in the list.

string
reference

The reference of the customer (a contract or a purchase order number). Each invoice gets a copy, and the PDF shows it. Null: no reference.

string | null
lines

The lines of each invoice. The price is the price as typed, in minor units with MoneyScale::PPU_DECIMALS decimals, not the price of the product at the time of the run.

Array<object>
object
key
additional properties
Any of:
integer
status
string
default: active
Allowed values: active paused ended
pausedReason

Why the system paused it: the run failed. Null when a member paused it.

string | null
version

The edit counter. It also stops two workers that run the same date at the same moment: the second flush fails, with its invoice.

integer
default: 1
upcomingDates

The next dates that get an invoice, at most UPCOMING_DATES, each as a unix timestamp (the unix of a date field). A list of dates would be a collection of resources in GraphQL.

Array<integer>
nextDates

The next dates that get an invoice as Y-m-d, for the AI tools: an agent cannot read the unix time of upcomingDates.

Array<string>
invoiceLines

The lines with the price as money, for the AI tools: an agent reads a price in minor units wrong.

Array<object>
object
key
additional properties
unknown_type
customer
string format: iri-reference
currency
object
currencyCode

The currency code. For ISO currencies this will be the 3-letter uppercase ISO 4217 currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes.

string
numericCode

The numeric currency code. For ISO currencies this will be the ISO 4217 numeric currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes. Set to null if the currency does not have a numeric code.

integer | null
name

The currency name. For ISO currencies this will be the official English name of the currency. For non-ISO currencies no constraints are defined.

string
defaultFractionDigits

The default number of fraction digits (typical scale) used with this currency. For example, the default number of fraction digits for the Euro is 2, while for the Japanese Yen it is 0. This cannot be a negative number.

integer
currencyType

The type of the currency. For ISO currencies, this indicates whether the currency is currently in use (IsoCurrent) or has been withdrawn (IsoHistorical). For non-ISO currencies defined by the application, the type is Custom.

object
name
string
periodicity
string
Allowed values: daily weekly biweekly monthly bimonthly quarterly half_yearly yearly
paymentTermDays

Null: the payment term of the customer at the time of the run.

integer | null
archivedAt
string | null format: date-time
creator
string format: iri-reference
createdAt
string format: date-time
updatedAt
string | null format: date-time
id

More information

string format: uuid
uid
string
archived
boolean

Example

{
"status": "active",
"version": 1,
"customer": "https://example.com/",
"periodicity": "daily",
"creator": "https://example.com/"
}

Invalid input

A representation of common errors.

object
title

A short, human-readable summary of the problem.

string | null
detail

A human-readable explanation specific to this occurrence of the problem.

string | null
status
integer | null
default: 400
instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

string | null
type

A URI reference that identifies the problem type

string

Example

{
"status": 400
}

Forbidden

A representation of common errors.

object
title

A short, human-readable summary of the problem.

string | null
detail

A human-readable explanation specific to this occurrence of the problem.

string | null
status
integer | null
default: 400
instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

string | null
type

A URI reference that identifies the problem type

string

Example

{
"status": 400
}

An error occurred

Unprocessable entity

object
status
integer
default: 422
violations
Array<object>
object
propertyPath
required

The property path of the violation

string
message
required

The message associated with the violation

string
code

The code of the violation

string
hint

An extra hint to understand the violation

string
payload

The serialized payload of the violation

object
key
additional properties
any
detail
string
type
string
title
string | null
instance
string | null

Example

{
"status": 422
}