public

Lister les factures

GET

/v1/invoices

Lister les factures

curl --request GET \
  --url '/v1/invoices?matterId=%3Cstring%3E&status=draft&paymentStatus=paid&scope=cabinet&natureId=%3Cstring%3E&poleId=%3Cstring%3E&billingTagId=%3Cstring%3E&managerUserId=3c90c3cc-0d44-4b50-8888-8dd25736052a&collaboratorUserId=3c90c3cc-0d44-4b50-8888-8dd25736052a&contributorUserId=3c90c3cc-0d44-4b50-8888-8dd25736052a&billingContactId=%3Cstring%3E&year=123&dateFrom=%3Cstring%3E&dateTo=%3Cstring%3E&paidFrom=%3Cstring%3E&paidTo=%3Cstring%3E&unpaidOnly=true&search=%3Cstring%3E&sort=number&dir=desc&page=1&pageSize=20' \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "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
      }
    }
  ],
  "page": 123,
  "pageSize": 123,
  "total": 123
}

Autorisations

Authorizationstringheaderobligatoire

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

Paramètres de requête

matterIdstringquery

Motif: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

statusenum<string>[]query

paymentStatusenum<string>[]query

scopeenum<string>querydefault:cabinet

Options disponibles: mine, cabinet

natureIdstring[]query

poleIdstring[]query

billingTagIdstring[]query

managerUserIdstring[]query

collaboratorUserIdstring[]query

contributorUserIdstring[]query

billingContactIdstring[]query

yearinteger[]query

dateFromstringquery

dateTostringquery

paidFromstringquery

paidTostringquery

unpaidOnlybooleanquery

searchstringquery

Maximum string length: 120

sortenum<string>query

Options disponibles: number, matter, contact, status, payment, reminder, date, ht, ttc, remaining, creator

direnum<string>querydefault:desc

Options disponibles: asc, desc

pageintegerquerydefault:1

Plage requise: 1 <= x

pageSizeintegerquerydefault:20

Plage requise: 1 <= x <= 100

Réponse

itemsobject[]obligatoire

Afficher child attributes

pageintegerobligatoire

Plage requise: 0 < x

pageSizeintegerobligatoire

Plage requise: 0 < x

totalintegerobligatoire

Plage requise: 0 <= x

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