Query parameters

• limit integer

  Nombre maximum de factures à retourner

  Default value is 20.

• skip integer

  Nombre de factures à ignorer (pagination)

  Default value is 0.

• sort string

  Champ de tri et direction (ex. "date:-1" pour tri décroissant par date)

• state string

  Filtre par état de la facture

  Values are draft, waiting, paid, notpaid, late, or inactive.

• type string

  Filtre par type de facture

  Values are invoice, invoice_credit, external, external_credit, proforma, or advance.

• client string

  Filtre par ID du client

• minDate string(date-time)

  Date minimum (ISO 8601)

• maxDate string(date-time)

  Date maximum (ISO 8601)

• number string

  Numéro de facture (recherche exacte)

• search string

  Recherche textuelle dans les factures

Responses

• 200 application/json

  Liste des factures

  Hide response attributes Show response attributes object

  • invoices array[object]
    Hide invoices attributes Show invoices attributes object

    • _id string

      Unique identifier for the invoice

    • VATRates array[object]

      List of VAT rates applied to the invoice

      Hide VATRates attributes Show VATRates attributes object

      • amount number

        Amount of VAT

      • rate string

        VAT rate

      • total number

        Total amount with this VAT rate

    • acomptes array[object]

      List of advance payments

      Hide acomptes attributes Show acomptes attributes object

      • _id string
      • amount number

        Amount of the advance payment

      • amount_ht number

        Amount without tax

      • credit boolean

        Default value is false.

      • date string(date-time)
    • base_currency string

      The currency with which the company works for this invoice

      Default value is EUR.

    • client string

      Reference to the client

    • client_name string

      Name of the client

    • client_address string

      Address of the client

    • client_city string

      City of the client

    • client_zip_code string

      Zip code of the client

    • client_country string

      Country of the client

      Default value is France.

    • client_email string

      Email of the client

    • client_phone string

      Phone number of the client

    • company string

      Reference to the company

    • company_name string

      Name of the company

    • date string(date-time)

      Date of the invoice

    • payment_expiry_date string(date-time)

      Expiry date for payment

    • invoice_lines array[object]

      List of invoice lines

      Hide invoice_lines attributes Show invoice_lines attributes object

      • _id string

        Unique identifier for the line

      • description string

        Description of the line

      • price_ht number

        Price without tax

        Default value is 0.

      • quantity number

        Quantity

        Default value is 1.

      • reference string

        Reference of the product

      • title string

        Title of the line

      • total_ht number

        Total amount without tax

        Default value is 0.

      • total_ttc number

        Total amount with tax

        Default value is 0.

      • tva_rate number

        VAT rate

      • type string

        Type of the line

        Values are product, header, subtotal, or globalDiscount. Default value is product.

      • unit string

        Unit of measurement

    • number string

      Invoice number

    • state string

      State of the invoice

      Values are draft, waiting, paid, notpaid, late, or inactive. Default value is draft.

    • title string

      Short description or label of the invoice

    • total_ht number

      Total amount without tax

    • total_ttc number

      Total amount with tax

    • total_tva number

      Total tax amount

    • type string

      Type of the invoice

      Values are invoice, credit, sold, advance, external, or external_credit. Default value is invoice.

    • payments array[object]

      List of payments

      Hide payments attributes Show payments attributes object

      • _id string

        Unique identifier for the payment

      • mode string

        Reference to the payment method

      • method_name string

        Name of the payment method

      • amount number

        Amount of the payment

      • date string(date-time)

        Date of the payment

      • check_number string

        Check number if applicable

  • total integer

    Nombre total de factures

  • skip integer
  • limit integer