API Factures

Cet objet représente les factures du site Le Temps.

Endpoints disponibles

Recherche de factures
Détail d’une facture

Recherche de factures

URL : https://www.letemps.ch/api/invoices
Type d’appel : GET

ParamètreTypeObligatoireCommentaireExemple
codestringNonADIGI240101
subscription_idintegerNon654321
user_idintegerNon123456
Exemple d'appel
https://www.letemps.ch/api/invoices?code=ADIGI240101
⚠️
  1. La recherche doit contenir l’un au moins de ces paramètres, sinon elle renverra un message d’erreur
  2. Le critères de recherche sont cumulables, si vous précisez un code ET un user_id la recherche filtrera sur ces deux critères.

L’appel renvoie un statut 200 à partir du moment où la recherche s’effectue correctement, même si elle ne trouve pas de résultats. Il renvoie un statut 400 si aucun paramètre de recherche valable n’a été trouvé.
Si la requête est valable il renvoie également un tableau invoices contenant les objets trouvés, sinon il renvoie un code d’erreur.

Réponse correcte
{
    "invoices": [
        {
            "id": 567,
            "code": "ADIGI240101",
            "total": "120.0",
            "creation_date": "2024-01-01",
            "due_date": "2024-02-01",
            "status": "paid",
            "paid_amount": "120.0",
            "remaining_amount": "0.0",
            "user_id": 123456,
            "subscription_id": 654321
        },
        {...}
    ]
}

ou

Réponse erronnée
{
    "code": "no_param"
}

Détail d’une facture

URL : https://www.letemps.ch/api/invoices/:id
Type d’appel : GET

ParamètreTypeObligatoireExemple
id (dans l’url directement)integerOui567
Exemple d'appel
https://www.letemps.ch/api/invoices/567

L’appel renvoie un statut 200 si la facture a bien été trouvée, ou un statut 404 en cas d’échec.
Si la facture a été trouvée il renvoie également un objet invoice, sinon il renvoie un code d’erreur.

Réponse correcte
{
    "invoice": {
        "id": 567,
        "code": "ADIGI240101",
        "total": "120.0",
        "creation_date": "2024-01-01",
        "due_date": "2024-02-01",
        "status": "paid",
        "paid_amount": "120.0",
        "remaining_amount": "0.0",
        "user_id": 123456,
        "subscription_id": 654321
    }
}

ou

Réponse erronnée
{
    "code": "not_found"
}