public

Le cockpit des relances : à venir, envoyées, impayés sans relance

GET

/v1/reminders

curl --request GET \
  --url '/v1/reminders?scope=cabinet' \
  --header 'Authorization: Bearer <token>'

{
  "sent": [
    {
      "billingContactId": "<string>",
      "billingContactName": "<string>",
      "channel": "email",
      "claimState": "claimable",
      "currency": "AED",
      "dueDate": "<string>",
      "error": "<string>",
      "id": "<string>",
      "invoiceId": "<string>",
      "invoiceNumber": "<string>",
      "invoiceStatus": "draft",
      "label": "<string>",
      "levelRank": 123,
      "matterId": "<string>",
      "matterName": "<string>",
      "matterReference": "<string>",
      "origin": "generated",
      "paymentStatus": "paid",
      "recipientEmail": "<string>",
      "remainingAmount": 123,
      "remainingNet": 123,
      "scheduledFor": "<string>",
      "sentAt": "2023-11-07T05:31:56Z",
      "status": "pending"
    }
  ],
  "unpaidWithoutReminder": [
    {
      "billingContactId": "<string>",
      "billingContactName": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdByName": "<string>",
      "creditNoteError": "<string>",
      "creditNoteNumber": "<string>",
      "creditNotes": [
        {
          "amountTtc": 123,
          "creditedAt": "2023-11-07T05:31:56Z",
          "number": "<string>"
        }
      ],
      "currency": "AED",
      "dueDate": "<string>",
      "einvoicingInvoiceNumber": "<string>",
      "id": "<string>",
      "issueError": "<string>",
      "issuedAt": "2023-11-07T05:31:56Z",
      "lineCount": 123,
      "matterId": "<string>",
      "matterName": "<string>",
      "matterReference": "<string>",
      "notes": {
        "count": 123,
        "lastCreatedAt": "2023-11-07T05:31:56Z"
      },
      "paymentState": "paid",
      "paymentStatus": "paid",
      "paymentSyncedAt": "2023-11-07T05:31:56Z",
      "providerInvoiceNumber": "<string>",
      "recurringPlanId": "<string>",
      "remainingAmount": 123,
      "remainingNet": 123,
      "sentReminderLevel": 123,
      "status": "draft",
      "totals": {
        "ht": 123,
        "ttc": 123,
        "vat": 123
      }
    }
  ],
  "upcoming": [
    {
      "billingContactId": "<string>",
      "billingContactName": "<string>",
      "channel": "email",

Autorisations

Authorizationstringheaderobligatoire

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de requête

scopeenum<string>querydefault:cabinet

Options disponibles: mine, cabinet

Réponse

sentobject[]obligatoire

Afficher child attributes

unpaidWithoutReminderobject[]obligatoire

Afficher child attributes

upcomingobject[]obligatoire

Afficher child attributes

Besoin d'aide supplémentaire ? Demander à l'équipe