@teamleader/focus-api-specification 1.99.0 → 1.101.0

package/dist/api.focus.teamleader.eu.yaml

@@ -3,7 +3,7 @@ info:
   title: Teamleader API
   description: This is the documentation of the Teamleader Focus API. If you have any feedback, or are you missing functionality to support your use case? Let us know via [api@teamleader.eu](mailto:api@teamleader.eu).
   contact: {}
-  version: 1.99.0
+  version: 1.101.0
 servers:
   - url: https://api.focus.teamleader.eu
     variables: {}
@@ -7588,6 +7588,8 @@ paths:
       requestBody:
         content:
           application/json:
+            schema:
+              $ref: '#/components/schemas/expenses.listrequest'
             example:
               filter:
                 term: search terms
@@ -7602,80 +7604,29 @@ paths:
                 bookkeeping_statuses:
                   - sent
                   - not_sent
+                payment_statuses:
+                  - paid
+                  - unpaid
+                department_ids:
+                  - 018fcef1-4f96-7349-9f57-1c7857023c42
+                supplier:
+                  type: company
+                  id: f29abf48-337d-44b4-aad4-585f5277a456
                 document_date:
                   operator: is_empty
                   value: YYYY-MM-DD
                   start: YYYY-MM-DD
                   end: YYYY-MM-DD
+                paid_at:
+                  operator: between
+                  start: YYYY-MM-DD
+                  end: YYYY-MM-DD
               page:
                 size: 20
                 number: 1
-            schema:
-              type: object
-              properties:
-                filter:
-                  type: object
-                  properties:
-                    term:
-                      type: string
-                      description: Filters by document number and supplier name, case-insensitive
-                    source_types:
-                      type: array
-                      description: Filters by one or more source types
-                      items:
-                        type: string
-                        enum:
-                          - incomingInvoice
-                          - incomingCreditNote
-                          - receipt
-                    review_statuses:
-                      type: array
-                      description: Filters by one or more review statuses
-                      items:
-                        type: string
-                        enum:
-                          - pending
-                          - approved
-                          - refused
-                    bookkeeping_statuses:
-                      type: array
-                      description: Filters by one or more bookkeeping statuses
-                      items:
-                        type: string
-                        enum:
-                          - sent
-                          - not_sent
-                    document_date:
-                      type: object
-                      properties:
-                        operator:
-                          type: string
-                          enum:
-                            - is_empty
-                            - between
-                            - equals
-                            - before
-                            - after
-                        value:
-                          type: string
-                          description: Required if operator is `equals`, `before`, or `after`
-                        start:
-                          type: string
-                          description: Required if operator is `between`
-                        end:
-                          type: string
-                          description: Required if operator is `between`
-                      required:
-                        - operator
-                page:
-                  type: object
-                  properties:
-                    size:
-                      type: number
-                      default: 20
-                    number:
-                      type: number
-                      default: 1
+              sort:
+                - field: document_date
+                  order: desc
       responses:
         '200':
           description: OK
@@ -7683,113 +7634,7 @@ paths:
           content:
             application/json:
               schema:
-                type: object
-                properties:
-                  data:
-                    type: array
-                    items:
-                      type: object
-                      properties:
-                        source:
-                          type: object
-                          properties:
-                            type:
-                              type: string
-                              enum:
-                                - incomingInvoice
-                                - incomingCreditNote
-                                - receipt
-                            id:
-                              type: string
-                        origin:
-                          type: object
-                          properties:
-                            type:
-                              type: string
-                              enum:
-                                - user
-                                - peppolIncomingDocument
-                            id:
-                              type: string
-                        title:
-                          type: string
-                        supplier:
-                          type: object
-                          properties:
-                            type:
-                              type: string
-                              enum:
-                                - company
-                                - contact
-                            id:
-                              type: string
-                          nullable: true
-                        document_number:
-                          type: string
-                          nullable: true
-                        document_date:
-                          type: string
-                          nullable: true
-                        due_date:
-                          type: string
-                          nullable: true
-                        currency:
-                          type: object
-                          properties:
-                            code:
-                              $ref: '#/components/schemas/CurrencyCode'
-                        total:
-                          type: object
-                          properties:
-                            tax_exclusive:
-                              type: object
-                              properties:
-                                amount:
-                                  type: number
-                              nullable: true
-                            tax_inclusive:
-                              type: object
-                              properties:
-                                amount:
-                                  type: number
-                              nullable: true
-                        company_entity:
-                          type: object
-                          properties:
-                            type:
-                              type: string
-                            id:
-                              type: string
-                          nullable: true
-                        file:
-                          type: object
-                          properties:
-                            type:
-                              type: string
-                            id:
-                              type: string
-                          nullable: true
-                        payment_reference:
-                          type: string
-                          nullable: true
-                        review_status:
-                          type: string
-                          enum:
-                            - pending
-                            - approved
-                            - refused
-                        bookkeeping_status:
-                          type: string
-                          enum:
-                            - not_sent
-                            - sent
-                        iban_number:
-                          type: string
-                          nullable: true
-                  meta:
-                    allOf:
-                      - $ref: '#/components/schemas/Meta'
-                      - description: Only included with request parameter `includes=pagination`
+                $ref: '#/components/schemas/expenses.listresponse'
               example:
                 data:
                   - source:
@@ -20133,10 +19978,12 @@ components:
               items:
                 type: string
             status:
-              type: string
-              enum:
-                - open
-                - pending_deletion
+              type: array
+              items:
+                type: string
+                enum:
+                  - open
+                  - pending_deletion
         page:
           $ref: '#/components/schemas/Page'
     dealPipelines.listresponse:
@@ -24394,6 +24241,242 @@ components:
                   - archived
                 example: active
           description: ''
+    expenses.listrequest:
+      type: object
+      properties:
+        filter:
+          type: object
+          properties:
+            term:
+              type: string
+              description: Filters by document number and supplier name, case-insensitive
+            source_types:
+              type: array
+              description: Filters by one or more source types
+              items:
+                type: string
+                enum:
+                  - incomingInvoice
+                  - incomingCreditNote
+                  - receipt
+            review_statuses:
+              type: array
+              description: Filters by one or more review statuses
+              items:
+                type: string
+                enum:
+                  - pending
+                  - approved
+                  - refused
+            bookkeeping_statuses:
+              type: array
+              description: Filters by one or more bookkeeping statuses
+              items:
+                type: string
+                enum:
+                  - sent
+                  - not_sent
+            payment_statuses:
+              type: array
+              description: Filters by one or more payment statuses
+              items:
+                type: string
+                enum:
+                  - paid
+                  - unpaid
+            department_ids:
+              type: array
+              description: Filters by one or more department IDs
+              items:
+                type: string
+            supplier:
+              type: object
+              description: Filters by a specific supplier
+              properties:
+                type:
+                  type: string
+                  enum:
+                    - company
+                    - contact
+                id:
+                  type: string
+              required:
+                - type
+                - id
+            document_date:
+              type: object
+              properties:
+                operator:
+                  type: string
+                  enum:
+                    - is_empty
+                    - between
+                    - equals
+                    - before
+                    - after
+                value:
+                  type: string
+                  description: Required if operator is `equals`, `before`, or `after`
+                start:
+                  type: string
+                  description: Required if operator is `between`
+                end:
+                  type: string
+                  description: Required if operator is `between`
+              required:
+                - operator
+            paid_at:
+              type: object
+              description: Filters by payment date
+              properties:
+                operator:
+                  type: string
+                  enum:
+                    - is_empty
+                    - between
+                    - equals
+                    - before
+                    - after
+                value:
+                  type: string
+                  description: Required if operator is `equals`, `before`, or `after`
+                start:
+                  type: string
+                  description: Required if operator is `between`
+                end:
+                  type: string
+                  description: Required if operator is `between`
+              required:
+                - operator
+        page:
+          type: object
+          properties:
+            size:
+              type: number
+              default: 20
+            number:
+              type: number
+              default: 1
+        sort:
+          type: array
+          items:
+            allOf:
+              - $ref: '#/components/schemas/Sort'
+              - type: object
+                properties:
+                  field:
+                    enum:
+                      - document_date
+                      - due_date
+                      - supplier_name
+    expenses.listresponse:
+      type: object
+      properties:
+        data:
+          type: array
+          items:
+            type: object
+            properties:
+              source:
+                type: object
+                properties:
+                  type:
+                    type: string
+                    enum:
+                      - incomingInvoice
+                      - incomingCreditNote
+                      - receipt
+                  id:
+                    type: string
+              origin:
+                type: object
+                properties:
+                  type:
+                    type: string
+                    enum:
+                      - user
+                      - peppolIncomingDocument
+                  id:
+                    type: string
+              title:
+                type: string
+              supplier:
+                type: object
+                properties:
+                  type:
+                    type: string
+                    enum:
+                      - company
+                      - contact
+                  id:
+                    type: string
+                nullable: true
+              document_number:
+                type: string
+                nullable: true
+              document_date:
+                type: string
+                nullable: true
+              due_date:
+                type: string
+                nullable: true
+              currency:
+                type: object
+                properties:
+                  code:
+                    $ref: '#/components/schemas/CurrencyCode'
+              total:
+                type: object
+                properties:
+                  tax_exclusive:
+                    type: object
+                    properties:
+                      amount:
+                        type: number
+                    nullable: true
+                  tax_inclusive:
+                    type: object
+                    properties:
+                      amount:
+                        type: number
+                    nullable: true
+              company_entity:
+                type: object
+                properties:
+                  type:
+                    type: string
+                  id:
+                    type: string
+                nullable: true
+              file:
+                type: object
+                properties:
+                  type:
+                    type: string
+                  id:
+                    type: string
+                nullable: true
+              payment_reference:
+                type: string
+                nullable: true
+              review_status:
+                type: string
+                enum:
+                  - pending
+                  - approved
+                  - refused
+              bookkeeping_status:
+                type: string
+                enum:
+                  - not_sent
+                  - sent
+              iban_number:
+                type: string
+                nullable: true
+        meta:
+          allOf:
+            - $ref: '#/components/schemas/Meta'
+            - description: Only included with request parameter `includes=pagination`
     productCategories.listrequest:
       title: productCategories.listrequest
       type: object

package/dist/changelog/20260202000000.md

@@ -0,0 +1,11 @@
+---
+category: addition
+---
+
+We added new filters to the `expenses.list` endpoint:
+- `department_ids`: Filter expenses by one or more department IDs
+- `supplier`: Filter expenses by a specific supplier (company or contact)
+- `paid_at`: Filter expenses by payment date using date range operators
+- `payment_statuses`: Filter expenses by payment status (paid or unpaid)
+
+We also added the `sort` parameter to allow sorting by `document_date`, `due_date`, or `supplier_name`.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@teamleader/focus-api-specification",
   "description": "Teamleader Focus API Specification",
-  "version": "1.99.0",
+  "version": "1.101.0",
   "author": "Teamleader <development@teamleader.eu> (https://www.teamleader.eu)",
   "bugs": {
     "url": "https://github.com/teamleadercrm/focus-api-specification/issues"