@teamleader/focus-api-specification 1.103.0 → 1.105.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.103.0
+  version: 1.105.0
 servers:
   - url: https://api.focus.teamleader.eu
     variables: {}
@@ -7667,6 +7667,9 @@ paths:
                     review_status: pending
                     bookkeeping_status: not_sent
                     iban_number: FR7630006000011234567890189
+                    payment_status: paid
+                    paid_amount: 100
+                    paid_at: '2025-12-12'
                 meta:
                   page:
                     size: 10
@@ -7972,6 +7975,42 @@ paths:
                   payment_reference: REF-3578296
                   review_status: pending
                   iban_number: BE68539007547034
+  /incomingCreditNotes.listPayments:
+    post:
+      summary: incomingCreditNotes.listPayments
+      operationId: incomingCreditNotes.listPayments
+      description: List payments for an incoming credit note.
+      tags:
+        - incoming_credit_notes
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/incomingCreditNotes.listPaymentsrequest'
+            example:
+              id: 018d5965-19fb-701a-af11-e80451931551
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/incomingCreditNotes.listPaymentsresponse'
+              example:
+                data:
+                  - id: 018d5965-19fb-701a-af11-e80451931551
+                    payment:
+                      amount: 123.3
+                      currency: EUR
+                    paid_at: '2016-03-03T16:44:33+00:00'
+                    payment_method:
+                      type: paymentMethod
+                      id: bb9589ec-6e08-0d5f-9b23-7be9b9c3ea2d
+                    remark: This is a remark
+                meta:
+                  total:
+                    amount: 123.3
   /incomingCreditNotes.markAsPendingReview:
     post:
       summary: incomingCreditNotes.markAsPendingReview
@@ -8022,6 +8061,57 @@ paths:
           description: No Content
           headers: {}
           content: {}
+  /incomingCreditNotes.registerPayment:
+    post:
+      summary: incomingCreditNotes.registerPayment
+      operationId: incomingCreditNotes.registerPayment
+      description: Register a payment for an incoming credit note.
+      tags:
+        - incoming_credit_notes
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/incomingCreditNotes.registerPaymentrequest'
+            example:
+              id: 018d5965-19fb-701a-af11-e80451931551
+              payment:
+                amount: 123.3
+                currency: EUR
+              paid_at: '2016-03-03T16:44:33+00:00'
+              payment_method_id: bb9589ec-6e08-0d5f-9b23-7be9b9c3ea2d
+              remark: This is a remark
+      responses:
+        '201':
+          description: Created
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/incomingCreditNotes.registerPaymentresponse'
+              example:
+                data:
+                  id: 88268bc5-86bc-43cb-8c9f-fdcf125e1ad0
+                  type: financialTransaction
+  /incomingCreditNotes.removePayment:
+    post:
+      summary: incomingCreditNotes.removePayment
+      operationId: incomingCreditNotes.removePayment
+      description: Remove a payment from an incoming credit note.
+      tags:
+        - incoming_credit_notes
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/incomingCreditNotes.removePaymentrequest'
+            example:
+              id: 018d5965-19fb-701a-af11-e80451931551
+              payment_id: 018d5965-19fb-701a-af11-e80451931551
+      responses:
+        '204':
+          description: No Content
   /incomingCreditNotes.sendToBookkeeping:
     post:
       summary: incomingCreditNotes.sendToBookkeeping
@@ -8141,6 +8231,33 @@ paths:
           description: No Content
           headers: {}
           content: {}
+  /incomingCreditNotes.updatePayment:
+    post:
+      summary: incomingCreditNotes.updatePayment
+      operationId: incomingCreditNotes.updatePayment
+      description: Update a payment for an incoming credit note.
+      tags:
+        - incoming_credit_notes
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/incomingCreditNotes.updatePaymentrequest'
+            example:
+              id: 018d5965-19fb-701a-af11-e80451931551
+              payment_id: aa7e7d42-a951-4cde-85b8-ae447a2f1ac4
+              payment:
+                amount: 123.3
+                currency: EUR
+              paid_at: '2016-03-03T16:44:33+00:00'
+              payment_method_id: bb9589ec-6e08-0d5f-9b23-7be9b9c3ea2d
+              remark: This is an updated remark
+      responses:
+        '204':
+          description: No Content
+          content:
+            application/json: {}
   /incomingInvoices.add:
     post:
       summary: incomingInvoices.add
@@ -8441,6 +8558,42 @@ paths:
                   payment_reference: REF-3578296
                   review_status: pending
                   iban_number: BE68539007547034
+  /incomingInvoices.listPayments:
+    post:
+      summary: incomingInvoices.listPayments
+      operationId: incomingInvoices.listPayments
+      description: List payments for an incoming invoice.
+      tags:
+        - incoming_invoices
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/incomingInvoices.listPaymentsrequest'
+            example:
+              id: 018d5965-19fb-701a-af11-e80451931551
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/incomingInvoices.listPaymentsresponse'
+              example:
+                data:
+                  - id: 018d5965-19fb-701a-af11-e80451931551
+                    payment:
+                      amount: 123.3
+                      currency: EUR
+                    paid_at: '2016-03-03T16:44:33+00:00'
+                    payment_method:
+                      type: paymentMethod
+                      id: bb9589ec-6e08-0d5f-9b23-7be9b9c3ea2d
+                    remark: This is a remark
+                meta:
+                  total:
+                    amount: 123.3
   /incomingInvoices.markAsPendingReview:
     post:
       summary: incomingInvoices.markAsPendingReview
@@ -8491,6 +8644,59 @@ paths:
           description: No Content
           headers: {}
           content: {}
+  /incomingInvoices.registerPayment:
+    post:
+      summary: incomingInvoices.registerPayment
+      operationId: incomingInvoices.registerPayment
+      description: Register a payment for an incoming invoice.
+      tags:
+        - incoming_invoices
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/incomingInvoices.registerPaymentrequest'
+            example:
+              id: 018d5965-19fb-701a-af11-e80451931551
+              payment:
+                amount: 123.3
+                currency: EUR
+              paid_at: '2016-03-03T16:44:33+00:00'
+              payment_method_id: bb9589ec-6e08-0d5f-9b23-7be9b9c3ea2d
+              remark: This is a remark
+      responses:
+        '201':
+          description: Created
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/incomingInvoices.registerPaymentresponse'
+              example:
+                data:
+                  type: financialTransaction
+                  id: ee94b4c0-5786-0517-9d26-8dd1e6406f20
+  /incomingInvoices.removePayment:
+    post:
+      summary: incomingInvoices.removePayment
+      operationId: incomingInvoices.removePayment
+      description: Remove a payment from an incoming invoice.
+      tags:
+        - incoming_invoices
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/incomingInvoices.removePaymentrequest'
+            example:
+              id: 018d5965-19fb-701a-af11-e80451931551
+              payment_id: 018d5965-19fb-701a-af11-e80451931551
+      responses:
+        '204':
+          description: No Content
+          content:
+            application/json: {}
   /incomingInvoices.sendToBookkeeping:
     post:
       summary: incomingInvoices.sendToBookkeeping
@@ -8610,6 +8816,33 @@ paths:
           description: No Content
           headers: {}
           content: {}
+  /incomingInvoices.updatePayment:
+    post:
+      summary: incomingInvoices.updatePayment
+      operationId: incomingInvoices.updatePayment
+      description: Update a payment for an incoming invoice.
+      tags:
+        - incoming_invoices
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/incomingInvoices.updatePaymentrequest'
+            example:
+              id: 018d5965-19fb-701a-af11-e80451931551
+              payment_id: aa7e7d42-a951-4cde-85b8-ae447a2f1ac4
+              payment:
+                amount: 123.3
+                currency: EUR
+              paid_at: '2016-03-03T16:44:33+00:00'
+              payment_method_id: bb9589ec-6e08-0d5f-9b23-7be9b9c3ea2d
+              remark: This is a remark
+      responses:
+        '204':
+          description: No Content
+          content:
+            application/json: {}
   /receipts.add:
     post:
       summary: receipts.add
@@ -8865,6 +9098,42 @@ paths:
                     type: file
                     id: 5027619a-5e0a-01ce-a533-f80dfcc3f142
                   review_status: pending
+  /receipts.listPayments:
+    post:
+      summary: receipts.listPayments
+      operationId: receipts.listPayments
+      description: List payments for a(n incoming) receipt.
+      tags:
+        - receipts
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/receipts.listPaymentsrequest'
+            example:
+              id: 018d5965-19fb-701a-af11-e80451931551
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/receipts.listPaymentsresponse'
+              example:
+                data:
+                  - id: 018d5965-19fb-701a-af11-e80451931551
+                    payment:
+                      amount: 123.3
+                      currency: EUR
+                    paid_at: '2016-03-03T16:44:33+00:00'
+                    payment_method:
+                      type: paymentMethod
+                      id: bb9589ec-6e08-0d5f-9b23-7be9b9c3ea2d
+                    remark: This is a remark
+                meta:
+                  total:
+                    amount: 123.3
   /receipts.markAsPendingReview:
     post:
       summary: receipts.markAsPendingReview
@@ -8915,6 +9184,59 @@ paths:
           description: No Content
           headers: {}
           content: {}
+  /receipts.registerPayment:
+    post:
+      summary: receipts.registerPayment
+      operationId: receipts.registerPayment
+      description: Register a payment for a(n incoming) receipt.
+      tags:
+        - receipts
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/receipts.registerPaymentrequest'
+            example:
+              id: 018d5965-19fb-701a-af11-e80451931551
+              payment:
+                amount: 123.3
+                currency: EUR
+              paid_at: '2016-03-03T16:44:33+00:00'
+              payment_method_id: bb9589ec-6e08-0d5f-9b23-7be9b9c3ea2d
+              remark: This is a remark
+      responses:
+        '201':
+          description: Created
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/receipts.registerPaymentresponse'
+              example:
+                data:
+                  id: 6deb188e-3468-4886-b6a1-2306e7fc18fb
+                  type: financialTransaction
+  /receipts.removePayment:
+    post:
+      summary: receipts.removePayment
+      operationId: receipts.removePayment
+      description: Remove a payment from a receipt.
+      tags:
+        - receipts
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/receipts.removePaymentrequest'
+            example:
+              id: 018d5965-19fb-701a-af11-e80451931551
+              payment_id: 018d5965-19fb-701a-af11-e80451931551
+      responses:
+        '204':
+          description: No Content
+          content:
+            application/json: {}
   /receipts.sendToBookkeeping:
     post:
       summary: receipts.sendToBookkeeping
@@ -9012,6 +9334,33 @@ paths:
           description: No Content
           headers: {}
           content: {}
+  /receipts.updatePayment:
+    post:
+      summary: receipts.updatePayment
+      operationId: receipts.updatePayment
+      description: Update a payment for a(n incoming) receipt.
+      tags:
+        - receipts
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/receipts.updatePaymentrequest'
+            example:
+              id: 018d5965-19fb-701a-af11-e80451931551
+              payment_id: aa7e7d42-a951-4cde-85b8-ae447a2f1ac4
+              payment:
+                amount: 123.3
+                currency: EUR
+              paid_at: '2016-03-03T16:44:33+00:00'
+              payment_method_id: bb9589ec-6e08-0d5f-9b23-7be9b9c3ea2d
+              remark: This is an updated remark
+      responses:
+        '204':
+          description: No Content
+          content:
+            application/json: {}
   /productCategories.list:
     post:
       tags:
@@ -24483,10 +24832,347 @@ components:
               iban_number:
                 type: string
                 nullable: true
+              payment_status:
+                type: string
+                enum:
+                  - unknown
+                  - paid
+                  - partially_paid
+                  - not_paid
+              paid_amount:
+                type: number
+                nullable: true
+              paid_at:
+                type: string
+                nullable: true
         meta:
           allOf:
             - $ref: '#/components/schemas/Meta'
             - description: Only included with request parameter `includes=pagination`
+    incomingCreditNotes.listPaymentsrequest:
+      title: incomingCreditNotes.listPaymentsrequest
+      type: object
+      properties:
+        id:
+          type: string
+      required:
+        - id
+    incomingCreditNotes.listPaymentsresponse:
+      title: receipts.listPaymentsresponse
+      type: object
+      properties:
+        data:
+          type: array
+          items:
+            type: object
+            properties:
+              id:
+                type: string
+              payment:
+                $ref: '#/components/schemas/Money'
+              paid_at:
+                type: string
+                format: date-time
+              payment_method:
+                type: object
+                nullable: true
+                properties:
+                  type:
+                    type: string
+                  id:
+                    type: string
+              remark:
+                type: string
+                nullable: true
+        meta:
+          type: object
+          properties:
+            total:
+              type: object
+              properties:
+                amount:
+                  type: number
+    incomingCreditNotes.registerPaymentrequest:
+      title: receipts.incomingCreditNotes
+      type: object
+      properties:
+        id:
+          type: string
+        payment:
+          $ref: '#/components/schemas/Money'
+        paid_at:
+          type: string
+          format: date-time
+        payment_method_id:
+          type: string
+          nullable: true
+        remark:
+          type: string
+          nullable: true
+      required:
+        - id
+        - payment
+        - paid_at
+    incomingCreditNotes.registerPaymentresponse:
+      title: receipts.registerPaymentresponse
+      type: object
+      properties:
+        data:
+          type: object
+          properties:
+            type:
+              type: string
+            id:
+              type: string
+    incomingCreditNotes.removePaymentrequest:
+      title: receipts.removePaymentrequest
+      type: object
+      properties:
+        id:
+          type: string
+        payment_id:
+          type: string
+      required:
+        - id
+        - payment_id
+    incomingCreditNotes.updatePaymentrequest:
+      title: incomingCreditNotes.updatePaymentrequest
+      type: object
+      properties:
+        id:
+          type: string
+        payment_id:
+          type: string
+        payment:
+          $ref: '#/components/schemas/Money'
+        paid_at:
+          type: string
+          format: date-time
+        payment_method_id:
+          type: string
+          nullable: true
+        remark:
+          type: string
+          nullable: true
+      required:
+        - id
+        - payment_id
+    incomingInvoices.listPaymentsrequest:
+      title: incomingInvoices.listPaymentsrequest
+      type: object
+      properties:
+        id:
+          type: string
+      required:
+        - id
+    incomingInvoices.listPaymentsresponse:
+      title: receipts.listPaymentsresponse
+      type: object
+      properties:
+        data:
+          type: array
+          items:
+            type: object
+            properties:
+              id:
+                type: string
+              payment:
+                $ref: '#/components/schemas/Money'
+              paid_at:
+                type: string
+                format: date-time
+              payment_method:
+                type: object
+                nullable: true
+                properties:
+                  type:
+                    type: string
+                  id:
+                    type: string
+              remark:
+                type: string
+                nullable: true
+        meta:
+          type: object
+          properties:
+            total:
+              type: object
+              properties:
+                amount:
+                  type: number
+    incomingInvoices.registerPaymentrequest:
+      title: incomingInvoices.registerPaymentrequest
+      type: object
+      properties:
+        id:
+          type: string
+        payment:
+          $ref: '#/components/schemas/Money'
+        paid_at:
+          type: string
+          format: date-time
+        payment_method_id:
+          type: string
+          nullable: true
+        remark:
+          type: string
+          nullable: true
+      required:
+        - id
+        - payment
+        - paid_at
+    incomingInvoices.registerPaymentresponse:
+      title: receipts.registerPaymentresponse
+      type: object
+      properties:
+        data:
+          type: object
+          properties:
+            type:
+              type: string
+            id:
+              type: string
+    incomingInvoices.removePaymentrequest:
+      title: incomingInvoices.removePaymentrequest
+      type: object
+      properties:
+        id:
+          type: string
+        payment_id:
+          type: string
+      required:
+        - id
+        - payment_id
+    incomingInvoices.updatePaymentrequest:
+      title: incomingInvoices.updatePaymentrequest
+      type: object
+      properties:
+        id:
+          type: string
+        payment_id:
+          type: string
+        payment:
+          $ref: '#/components/schemas/Money'
+        paid_at:
+          type: string
+          format: date-time
+        payment_method_id:
+          type: string
+          nullable: true
+        remark:
+          type: string
+          nullable: true
+      required:
+        - id
+        - payment_id
+    receipts.listPaymentsrequest:
+      title: receipts.listPaymentsrequest
+      type: object
+      properties:
+        id:
+          type: string
+      required:
+        - id
+    receipts.listPaymentsresponse:
+      title: receipts.listPaymentsresponse
+      type: object
+      properties:
+        data:
+          type: array
+          items:
+            type: object
+            properties:
+              id:
+                type: string
+              payment:
+                $ref: '#/components/schemas/Money'
+              paid_at:
+                type: string
+                format: date-time
+              payment_method:
+                type: object
+                nullable: true
+                properties:
+                  type:
+                    type: string
+                  id:
+                    type: string
+              remark:
+                type: string
+                nullable: true
+        meta:
+          type: object
+          properties:
+            total:
+              type: object
+              properties:
+                amount:
+                  type: number
+    receipts.registerPaymentrequest:
+      title: receipts.registerPaymentrequest
+      type: object
+      properties:
+        id:
+          type: string
+        payment:
+          $ref: '#/components/schemas/Money'
+        paid_at:
+          type: string
+          format: date-time
+        payment_method_id:
+          type: string
+          nullable: true
+        remark:
+          type: string
+          nullable: true
+      required:
+        - id
+        - payment
+        - paid_at
+    receipts.registerPaymentresponse:
+      title: receipts.registerPaymentresponse
+      type: object
+      properties:
+        data:
+          type: object
+          properties:
+            type:
+              type: string
+            id:
+              type: string
+    receipts.removePaymentrequest:
+      title: receipts.removePaymentrequest
+      type: object
+      properties:
+        id:
+          type: string
+        payment_id:
+          type: string
+      required:
+        - id
+        - payment_id
+    receipts.updatePaymentrequest:
+      title: receipts.updatePaymentrequest
+      type: object
+      properties:
+        id:
+          type: string
+        payment_id:
+          type: string
+        payment:
+          $ref: '#/components/schemas/Money'
+        paid_at:
+          type: string
+          format: date-time
+        payment_method_id:
+          type: string
+          nullable: true
+        remark:
+          type: string
+          nullable: true
+      required:
+        - id
+        - payment_id
     productCategories.listrequest:
       title: productCategories.listrequest
       type: object