Creation de facture

Une fois authentifie le client peut proceder a la creation d'une nouvelle facture. La facture contient une reference au champ reference, le montant de la facture en millimes au champ amount, l'heure Posix de la creation de la facture au champ createdAt, l'heure Posix limite du paiement de la facture au champ dueAt, l'identifiant de l'unite de paiement acceptée au champ unitID, les donnees relatifs au client de la facture au champ customer et une liste des elements de la facture au champ items.

{
  "reference": "1",
  "amount": 100000,
  "customer": {
    "name": "Client",
    "address": "Addresse",
    "email": "client@email.com",
    "phoneNumber": "12341234"
  },
  "items":[
    {
      "item":{
        "name": "Item",
        "description": "Description",
        "price": {
          "unitID": 100000
        }
      },
      "quantity": 1
    }
  ],
  "createdAt": 1598959121861,
  "dueAt": 1601464723500,
  "unitID": "unitID"
}

Les seul champs soumis a une validation sont les champs relatifs au montant et unite de paiement, amount et unitID. Le champ items peut etre omis entierement.

POST /prosper-bill/api/invoice/{Nom de l'organization} HTTP/1.1
Cookie: refresh_token=<Token de rafraichissement>; access_token=<Token d'acces>
Content-Type: application/json

{
  "reference": "1",
  "amount": 100000,
  "customer": {
    "name": "Client",
    "address": "Addresse",
    "email": "client@email.com",
    "phoneNumber": "12341234"
  },
  "items":[
    {
      "item":{
        "name": "Item",
        "description": "Description",
        "price": {
          "unitID": 100000
        }
      },
      "quantity": 1
    }
  ],
  "createdAt": 1598959121861,
  "dueAt": 1601464723500,
  "unitID": "unitID"
}

Suite à une création réussie le serveur répond avec la facture créée en y ajoutant deux nouveaux champs status et id. Le champ id permet d'identifier la facture. Le champ status indique l'etat de la facture et admet trois valeurs:

  • UNPAID qui indique que la facture est impayee

  • PROCESSING qui indique qu'un paiement de la facture est en traitement

  • PAID qui indique que la facture a ete payee

{
  "id": 2,
  "status": "UNPAID",
  "reference": "1",
  "amount": 100000,
  "customer": {
    "name": "Client",
    "address": "Addresse",
    "email": "client@email.com",
    "phoneNumber": "12341234"
  },
  "items":[
    {
      "item":{
        "name": "Item",
        "description": "Description",
        "price": {
          "unitID": 100000
        }
      },
      "quantity": 1
    }
  ],
  "createdAt": 1598959121861,
  "dueAt": 1601464723500,
  "unitID": "unitID"
}

Last updated