RecurringInvoices

Détail d'une facture récurrente (lignes)

Scope requis : invoices:read.

get/recurring-invoices/{id}

Request

  • Base URL: https://api.swipify.fr/api/v1
  • URL: https://api.swipify.fr/api/v1/recurring-invoices/{id}
  • Auth: API key in header X-API-Key

Path parameters

idinteger required

Response

Facture récurrente (détail)

idinteger
titlestring

Libellé de gestion, jamais imprimé sur la facture

frequency'weekly' | 'monthly' | 'quarterly' | 'yearly'
anchorDayinteger nullable

Jour du mois d'ancrage (1 à 31), borné à la fin du mois réel

status'active' | 'paused' | 'finished'
autoSendboolean

true : chaque échéance est émise et envoyée au client sans intervention

nextRunAtstring date-time

Prochaine échéance

endDatestring date-time nullable
maxOccurrencesinteger nullable
occurrencesCountinteger

Échéances déjà émises

objectstring nullable

Objet de chaque facture (les repères de période y sont remplacés à l'émission)

pendingInvoiceIdinteger nullable
createdFromInvoiceIdinteger nullable

Facture d'origine dont le contenu a été copié

createdAtstring date-time
updatedAtstring date-time

Example response

{
  "title": "Entretien chaudière Dupont"
}

Changes

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